SecurityAgent / Client / list_integrations

list_integrations¶

SecurityAgent.Client.list_integrations(**kwargs)¶

Retrieves the Integrations associated with the user’s account

Request Syntax

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

Parameters:

filter (dict) –
Filter criteria for integrations

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: provider, providerType.
- provider (string) –
  
  Filter by provider
- providerType (string) –
  
  Filter by provider type
nextToken (string) – Token for pagination
maxResults (integer) – Maximum number of results to return

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) –
  
  List of integration summaries
  - (dict) –
    
    Summary information about an integration
    - integrationId (string) –
      
      Unique identifier of the integration
    - installationId (string) –
      
      Installation identifier from the provider
    - provider (string) –
      
      Provider type
    - providerType (string) –
      
      Type of provider integration
    - displayName (string) –
      
      Display name for the integration
- nextToken (string) –
  
  Token for pagination to retrieve the next set of results

Exceptions

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