SecurityAgent / Client / create_integration

create_integration

SecurityAgent.Client.create_integration(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_integration(
    provider='GITHUB',
    input={
        'github': {
            'code': 'string',
            'state': 'string',
            'organizationName': 'string'
        }
    },
    integrationDisplayName='string',
    kmsKeyId='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • provider (string) –

    [REQUIRED]

    The integration provider. Currently, only GITHUB is supported.

  • input (dict) –

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

    • github (dict) –

      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.

  • integrationDisplayName (string) –

    [REQUIRED]

    The display name for the integration.

  • kmsKeyId (string) – The identifier of the AWS KMS key to use for encrypting data associated with the integration.

  • tags (dict) –

    The tags to associate with the integration.

    • (string) –

      Key for a resource tag.

      • (string) –

        Value for a resource tag.

Return type:

dict

Returns:

Response Syntax

{
    'integrationId': 'string'
}

Response Structure

  • (dict) –

    • integrationId (string) –

      The unique identifier of the created integration.

Exceptions

  • SecurityAgent.Client.exceptions.ResourceNotFoundException

  • SecurityAgent.Client.exceptions.InternalServerException

  • SecurityAgent.Client.exceptions.ValidationException

  • SecurityAgent.Client.exceptions.ConflictException

  • SecurityAgent.Client.exceptions.ThrottlingException

  • SecurityAgent.Client.exceptions.AccessDeniedException