SecurityAgent / Client / list_integrations

list_integrations¶

SecurityAgent.Client.list_integrations(**kwargs)¶

Lists the integrations in your account, optionally filtered by provider or provider type.

Request Syntax

response = client.list_integrations(
    filter={
        'provider': 'GITHUB',
        'providerType': 'SOURCE_CODE'|'DOCUMENTATION'
    },
    nextToken='string',
    maxResults=123
)

Parameters:

filter (dict) –
A filter to apply to the list of integrations.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: provider, providerType.
- provider (string) –
  
  Filter integrations by provider.
- providerType (string) –
  
  Filter integrations by provider type.
nextToken (string) – A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.
maxResults (integer) – The maximum number of results to return in a single call.

Return type:

dict

Returns:

Response Syntax

{
    'integrationSummaries': [
        {
            'integrationId': 'string',
            'installationId': 'string',
            'provider': 'GITHUB',
            'providerType': 'SOURCE_CODE'|'DOCUMENTATION',
            'displayName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- integrationSummaries (list) –
  
  The list of integration summaries.
  - (dict) –
    
    Contains summary information about an integration.
    - 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.
- nextToken (string) –
  
  A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

Exceptions

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