Continuum / Client / get_integration

get_integration

Continuum.Client.get_integration(**kwargs)

Retrieves information about an integration.

See also: AWS API Documentation

Request Syntax

response = client.get_integration(
    integrationId='string'
)
Parameters:

integrationId (string) –

[REQUIRED]

The unique identifier of the integration to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'integrationId': 'string',
    'integrationArn': 'string',
    'name': 'string',
    'integrationType': 'GITHUB'|'GITLAB'|'S3',
    'providerDetails': {
        'github': {
            'organizationName': 'string'
        },
        'gitlab': {
            'instanceUrl': 'string',
            'targetType': 'GROUP'|'PROJECT',
            'targetPath': 'string',
            'tokenRotation': 'AUTOMATIC'|'NONE',
            'expiresAt': datetime(2015, 1, 1)
        },
        's3': {
            'bucket': 'string',
            'roleArn': 'string'
        }
    },
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    Contains metadata for the requested integration.

    • integrationId (string) –

      The unique identifier of the integration.

    • integrationArn (string) –

      The ARN of the integration.

    • name (string) –

      The name of the integration.

    • integrationType (string) –

      The immutable provider type for the integration.

    • providerDetails (dict) –

      Provider-specific details for the integration.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: github, gitlab, s3. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • github (dict) –

        Details for a GitHub.com integration.

        • organizationName (string) –

          The name of the GitHub organization associated with the integration.

      • gitlab (dict) –

        Details for a GitLab integration.

        • instanceUrl (string) –

          The HTTPS base URL of the GitLab instance.

        • targetType (string) –

          Whether the integration targets a group or a single project.

        • targetPath (string) –

          The group or project path the integration targets.

        • tokenRotation (string) –

          How the integration’s access token is rotated. AUTOMATIC only when the pasted token had the self-rotate scope and rotation was opted in at installation time.

        • expiresAt (datetime) –

          The expiry of the stored access token, for non-rotating tokens only. A rotated token’s original expiry is stale, so this is omitted when tokenRotation is AUTOMATIC.

      • s3 (dict) –

        Public details for a customer-managed S3 integration.

        • bucket (string) –

          Customer-managed S3 bucket name.

        • roleArn (string) –

          IAM role assumed by Continuum to read a customer-managed S3 integration.

    • createdAt (datetime) –

      The timestamp when the integration was created.

    • updatedAt (datetime) –

      The timestamp when the integration was last updated.

Exceptions