SecurityAgent / Client / create_integration

create_integration

SecurityAgent.Client.create_integration(**kwargs)

Creates the Integration of the Security Agent App with an external Provider

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]

    Provider to integrate with

  • input (dict) –

    [REQUIRED]

    Provider-specific input parameters

    Note

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

    • github (dict) –

      GitHub integration input

      • code (string) – [REQUIRED]

        Authorization code from OAuth flow

      • state (string) – [REQUIRED]

        CSRF state token for OAuth security

      • organizationName (string) –

        Name of the GitHub organization

  • integrationDisplayName (string) –

    [REQUIRED]

    Display name for the integration

  • kmsKeyId (string) – KMS key ID for encrypting integration details

  • tags (dict) –

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

      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