SecurityAgent / Client / get_integration

get_integration¶

SecurityAgent.Client.get_integration(**kwargs)¶

Retrieves information about an integration.

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',
    'installationId': 'string',
    'provider': 'GITHUB',
    'providerType': 'SOURCE_CODE'|'DOCUMENTATION',
    'displayName': 'string',
    'kmsKeyId': 'string'
}

Response Structure

(dict) –
- integrationId (string) –
  
  The unique identifier of the integration.
- installationId (string) –
  
  The installation identifier from the integration provider.
- provider (string) –
  
  The integration provider.
- providerType (string) –
  
  The type of the integration provider.
- displayName (string) –
  
  The display name of the integration.
- kmsKeyId (string) –
  
  The identifier of the AWS KMS key used to encrypt data associated with the integration.

Exceptions

SecurityAgent.Client.exceptions.ResourceNotFoundException
SecurityAgent.Client.exceptions.ValidationException
SecurityAgent.Client.exceptions.InternalServerException
SecurityAgent.Client.exceptions.ThrottlingException
SecurityAgent.Client.exceptions.AccessDeniedException