AWS CLI Command Reference

[ aws . cloudwatchomni ]

create-integrationÂķ

DescriptionÂķ

Creates an integration with a third-party provider. Returns the integration identifier and its initial status; when the provider requires interactive consent, an authorization URL is returned for the user to complete setup.

See also: AWS API Documentation

SynopsisÂķ

  create-integration
--integration-type <value>
--name <value>
[--credential <value>]
[--integration-attributes <value>]
[--role-arn <value>]
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

OptionsÂķ

--integration-type (string) [required]

The type of third-party provider to integrate with.

Possible values:

  • AWS_CONFIG_SLREC
  • SLACK
  • EXTERNAL_AGENT
  • AWS_INTEGRATION

--name (string) [required]

The name for the new integration; unique within the account.

Constraints:

  • min: 1
  • max: 256

--credential (tagged union structure)

The credential used to authenticate with the third-party provider.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: oauthCodeCredential, oauthClientCredential, apiKeyCredential.

oauthCodeCredential -> (structure)

Credentials for an OAuth 2.0 authorization-code grant.

authCode -> (string) [required]

The OAuth 2.0 authorization code returned by the external system’s authorization endpoint.

Constraints:

  • min: 1
  • max: 4096

oauthClientCredential -> (structure)

Credentials for an OAuth 2.0 client-credentials grant.

clientId -> (string) [required]

The OAuth 2.0 client identifier registered with the external system.

clientSecret -> (string) [required]

The OAuth 2.0 client secret that pairs with the client identifier.

providerId -> (string)

The identifier of the OAuth provider that issued the client credentials.

apiKeyCredential -> (structure)

An API key credential.

apiKeyValue -> (string) [required]

The API key value used to authenticate with the external system.

Constraints:

  • min: 1

Shorthand Syntax:

oauthCodeCredential={authCode=string},oauthClientCredential={clientId=string,clientSecret=string,providerId=string},apiKeyCredential={apiKeyValue=string}

JSON Syntax:

{
  "oauthCodeCredential": {
    "authCode": "string"
  },
  "oauthClientCredential": {
    "clientId": "string",
    "clientSecret": "string",
    "providerId": "string"
  },
  "apiKeyCredential": {
    "apiKeyValue": "string"
  }
}

--integration-attributes (map)

Provider-specific attributes to associate with the integration.

Constraints:

  • min: 0
  • max: 50

key -> (string)

Constraints:

  • min: 0
  • max: 128

value -> (string)

Constraints:

  • min: 0
  • max: 4096

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--role-arn (string)

The Amazon Resource Name of the IAM role assumed to access the integration.

--tags (map)

Tags to apply to the integration at creation time (Tagris tag-on-create).

Constraints:

  • min: 0
  • max: 50

key -> (string)

Tag key. Must be non-empty; AWS-standard maximum length. Constraining the key (rather than a bare String) rejects empty-key payloads at the edge with a 400 ValidationException instead of faulting downstream as a 500.

Constraints:

  • min: 1
  • max: 128

value -> (string)

Tag value. AWS-standard maximum length; may be empty.

Constraints:

  • min: 0
  • max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

Idempotency token for safe retries. Retrying with the same token returns the original integration instead of creating a duplicate.

Constraints:

  • min: 1
  • max: 64
  • pattern: [!-~]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global OptionsÂķ

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

OutputÂķ

integration -> (structure)

The details of the created integration. This is the same object returned by GetIntegration and UpdateIntegration.

integrationId -> (string) [required]

The unique identifier of the integration.

integrationArn -> (string)

The Amazon Resource Name (ARN) of the integration.

integrationType -> (string) [required]

The type of external system that an integration connects to, such as a source of configuration data, a messaging destination, or a model provider.

Possible values:

  • AWS_CONFIG_SLREC
  • SLACK
  • EXTERNAL_AGENT
  • AWS_INTEGRATION

name -> (string) [required]

The customer-provided name of the integration.

status -> (string) [required]

The current lifecycle state of an integration.

Possible values:

  • ACTIVE
  • DELETED
  • PENDING
  • PENDING_OAUTH
  • ERROR
  • FAILED

authType -> (string)

The authentication method that an integration uses to connect to its external system.

Possible values:

  • NONE
  • OAUTH2
  • API_KEY

credentialArn -> (string)

The Amazon Resource Name (ARN) of the secret that stores the integration’s credentials.

roleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to access the external system.

integrationAttributes -> (map)

Provider-specific key/value attributes that configure the integration.

key -> (string)

Constraints:

  • min: 0
  • max: 128

value -> (string)

Constraints:

  • min: 0
  • max: 4096

authorizationUrl -> (string)

The URL the customer visits to authorize the integration. Present while an OAuth authorization is pending.

errorMessage -> (string)

A human-readable description of why the integration is in an ERROR or FAILED state. Present only when the integration has failed.

createdAt -> (timestamp)

The time at which the integration was created.

updatedAt -> (timestamp)

The time at which the integration was last updated.

scope -> (string)

Whether this integration is account-scoped (ACCOUNT, customer-created) or organization-scoped (ORGANIZATION, created by an org-enablement rule). Absent on legacy records is treated as ACCOUNT.

Possible values:

  • ACCOUNT
  • ORGANIZATION
© Copyright 2026, Amazon Web Services. Created using Sphinx.