AWS CLI Command Reference

[ aws . securityagent ]

create-integration

Description

Creates a new integration with a third-party provider, such as GitHub, for code review and remediation.

See also: AWS API Documentation

Synopsis

  create-integration
--provider <value>
--input <value>
--integration-display-name <value>
[--kms-key-id <value>]
[--tags <value>]
[--private-connection-name <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

--provider (string) [required]

The integration provider. Currently, only GITHUB is supported.

Possible values:

  • GITHUB
  • GITLAB
  • BITBUCKET
  • CONFLUENCE

--input (tagged union structure) [required]

The provider-specific input required to create the integration.

Note

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

github -> (structure)

The GitHub-specific input for creating an integration.

code -> (string) [required]

The OAuth authorization code received from GitHub.

state -> (string) [required]

The CSRF state token for validating the OAuth flow.

organizationName -> (string)

The name of the GitHub organization to integrate with.

targetUrl -> (string)

The HTTPS URL of a self-hosted GitHub Enterprise Server instance. Omit this value for GitHub.com.

installationId -> (string)

The installation identifier provided by GitHub Enterprise Server on the install callback. Required for GitHub Enterprise Server integrations and ignored for GitHub.com.

gitlab -> (structure)

The configuration for a GitLab integration.

accessToken -> (string) [required]

The GitLab access token used to authenticate. This can be a personal access token or a group access token.

targetUrl -> (string)

The HTTPS URL of a self-managed GitLab instance. Omit this value for GitLab SaaS (gitlab.com).

tokenType -> (string) [required]

The type of GitLab access token provided in accessToken.

Possible values:

  • PERSONAL
  • GROUP

groupId -> (string)

The identifier of the GitLab group. Required when tokenType is group and ignored for personal tokens.

bitbucket -> (structure)

The configuration for a Bitbucket integration.

installationId -> (string) [required]

The Atlassian installation identifier, available from the Atlassian administration console.

workspace -> (string) [required]

The Bitbucket workspace slug that identifies the workspace to integrate, for example acme-corp.

code -> (string) [required]

The OAuth 2.0 authorization code returned from the consent redirect.

state -> (string) [required]

The CSRF state token echoed back from the OAuth redirect.

confluence -> (structure)

The configuration for a Confluence integration.

installationId -> (string) [required]

The Atlassian installation identifier, available from the Atlassian administration console.

code -> (string) [required]

The OAuth 2.0 authorization code returned from the consent redirect.

state -> (string) [required]

The CSRF state token echoed back from the OAuth redirect.

siteUrl -> (string) [required]

The Confluence Cloud site URL, for example https://mysite.atlassian.net.

Shorthand Syntax:

github={code=string,state=string,organizationName=string,targetUrl=string,installationId=string},gitlab={accessToken=string,targetUrl=string,tokenType=string,groupId=string},bitbucket={installationId=string,workspace=string,code=string,state=string},confluence={installationId=string,code=string,state=string,siteUrl=string}

JSON Syntax:

{
  "github": {
    "code": "string",
    "state": "string",
    "organizationName": "string",
    "targetUrl": "string",
    "installationId": "string"
  },
  "gitlab": {
    "accessToken": "string",
    "targetUrl": "string",
    "tokenType": "PERSONAL"|"GROUP",
    "groupId": "string"
  },
  "bitbucket": {
    "installationId": "string",
    "workspace": "string",
    "code": "string",
    "state": "string"
  },
  "confluence": {
    "installationId": "string",
    "code": "string",
    "state": "string",
    "siteUrl": "string"
  }
}

--integration-display-name (string) [required]

The display name for the integration.

--kms-key-id (string)

The identifier of the AWS KMS key to use for encrypting data associated with the integration.

--tags (map)

The tags to associate with the integration.

key -> (string)

Key for a resource tag.

value -> (string)

Value for a resource tag.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--private-connection-name (string)

The name of an active private connection used to reach a self-hosted provider instance over private networking. Specify this when the instance is not publicly reachable.

--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.
© Copyright 2026, Amazon Web Services. Created using Sphinx.