AWS CLI Command Reference

[ aws . continuum ]

create-integration

Description

Creates a new integration with an external source provider. Repeating an identical request with the same clientToken returns the original integrationId, integrationArn, and createdAt. Token records are retained for eight hours after success or terminal failure, including after the integration is deleted; replaying a deleted integration’s token does not recreate it. An identical request with a retained terminal failure returns the recorded error.

Reusing a token with different parameters returns ValidationException. A fresh token starts a new create attempt; if the name is already owned by another integration, ConflictException includes that integration’s identifier. An attempt still in progress may return ThrottlingException with retryAfterSeconds set to 1; retry with the same token and identical parameters.

GitHub authorization codes are single use. Retry an unresolved attempt with its original token and unchanged parameters first. If the service reports a terminal failure, an expired attempt, or a successful token exchange whose integration could not be saved, restart GitHub authorization with a fresh token and authorization code. The service does not checkpoint provider results for recovery by another request.

See also: AWS API Documentation

Synopsis

  create-integration
[--client-token <value>]
--name <value>
--provider-configuration <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

--client-token (string)

An optional token identifying one create attempt within the caller’s account, Region, and operation. SDKs generate a token when omitted. If a request reaches the service without a token, the service generates one for that request. Each request without a token starts a new attempt. To replay an attempt, supply the same token and identical input. Authorized users and roles in the same account can retry an attempt this way. Token records are retained for eight hours after success or terminal failure, including after deletion of a successfully created integration. Different input with the same token returns ValidationException.

Constraints:

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

--name (string) [required]

The name for the integration.

Constraints:

  • min: 1
  • max: 255

--provider-configuration (tagged union structure) [required]

The provider-specific configuration required to create the integration. Only one member may be specified.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: github, gitlab, s3.

github -> (structure)

Configuration for a GitHub.com integration.

authorization -> (structure) [required]

OAuth authorization used to establish the integration. Required on create; not returned on read operations.

authorizationCode -> (string) [required]

The OAuth authorization code returned by GitHub after the user authorizes the application.

Constraints:

  • min: 1
  • max: 512

state -> (string) [required]

The state returned by GitHub in the OAuth callback. It must be the state that StartIntegrationAuthorization returned to the same AWS account, and the authorization request must have sent that call’s codeChallenge. The state can be redeemed once. A stage that enforces authorization sessions rejects a missing, expired, already used, or other-account state with ValidationException; restart the authorization with StartIntegrationAuthorization.

Constraints:

  • min: 1
  • max: 1024

redirectUrl -> (string)

The redirect URL used to obtain the authorization code. Must match one of the redirect URLs registered on the GitHub App. If omitted, the App’s default redirect URL is used. Not stored or returned after creation.

Constraints:

  • min: 9
  • max: 2083
  • pattern: https://.*

organizationName -> (string)

The name of the GitHub organization to associate with the integration. If not specified, the integration is associated with the authenticated user’s personal account.

Constraints:

  • min: 1
  • max: 39
  • pattern: [a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?

gitlab -> (structure)

Configuration for a GitLab integration.

instanceUrl -> (string) [required]

The HTTPS base URL of the GitLab instance (gitlab.com or self-managed).

Constraints:

  • min: 9
  • max: 2083
  • pattern: https://\S+

targetType -> (string) [required]

Whether the integration targets a group or a single project.

Possible values:

  • GROUP
  • PROJECT

targetPath -> (string) [required]

The group or project path the integration targets.

Constraints:

  • min: 1
  • max: 1024
  • pattern: [A-Za-z0-9][A-Za-z0-9._\-]*(/[A-Za-z0-9][A-Za-z0-9._\-]*)*

accessToken -> (string) [required]

The GitLab access token (personal, group or project). Write-only; not stored or returned after creation. If the token carries the self-rotate scope, rotation is opted in and Continuum manages the token thereafter.

Constraints:

  • min: 1
  • max: 512

s3 -> (structure)

Configuration for a customer-managed S3 integration.

bucket -> (string) [required]

Customer-managed source bucket name.

Constraints:

  • min: 3
  • max: 63
  • pattern: [a-z0-9][a-z0-9.\-]{1,61}[a-z0-9]

roleArn -> (string) [required]

Role Continuum will assume to read from the source bucket.

Constraints:

  • min: 1
  • max: 1011
  • pattern: arn:[a-z0-9-]+:iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@/-]+

externalId -> (string) [required]

Caller-provided external ID required by the role trust policy.

Constraints:

  • min: 2
  • max: 1224
  • pattern: [\w+=,.@:\/-]+

Shorthand Syntax:

github={authorization={authorizationCode=string,state=string,redirectUrl=string},organizationName=string},gitlab={instanceUrl=string,targetType=string,targetPath=string,accessToken=string},s3={bucket=string,roleArn=string,externalId=string}

JSON Syntax:

{
  "github": {
    "authorization": {
      "authorizationCode": "string",
      "state": "string",
      "redirectUrl": "string"
    },
    "organizationName": "string"
  },
  "gitlab": {
    "instanceUrl": "string",
    "targetType": "GROUP"|"PROJECT",
    "targetPath": "string",
    "accessToken": "string"
  },
  "s3": {
    "bucket": "string",
    "roleArn": "string",
    "externalId": "string"
  }
}

--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

integrationId -> (string)

The unique identifier of the created integration.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]+

integrationArn -> (string)

The ARN of the created integration.

Constraints:

  • min: 1
  • max: 1011
  • pattern: arn:[a-z0-9-]+:continuum:[a-z0-9-]+:[0-9]{12}:integrations/[a-z0-9]+

createdAt -> (timestamp)

The timestamp when the integration was created.
© Copyright 2026, Amazon Web Services. Created using Sphinx.