SecurityHub / Client / list_connectors_v2

list_connectors_v2¶

SecurityHub.Client.list_connectors_v2(**kwargs)¶

Grants permission to retrieve a list of connectorsV2 and their metadata for the calling account. This API is in preview release and subject to change.

Request Syntax

response = client.list_connectors_v2(
    NextToken='string',
    MaxResults=123,
    ProviderName='JIRA_CLOUD'|'SERVICENOW',
    ConnectorStatus='CONNECTED'|'FAILED_TO_CONNECT'|'PENDING_CONFIGURATION'|'PENDING_AUTHORIZATION'
)

Parameters:

NextToken (string) – The pagination token per the Amazon Web Services Pagination standard
MaxResults (integer) – The maximum number of results to be returned.
ProviderName (string) – The name of the third-party provider.
ConnectorStatus (string) – The status for the connectorV2.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Connectors': [
        {
            'ConnectorArn': 'string',
            'ConnectorId': 'string',
            'Name': 'string',
            'Description': 'string',
            'ProviderSummary': {
                'ProviderName': 'JIRA_CLOUD'|'SERVICENOW',
                'ConnectorStatus': 'CONNECTED'|'FAILED_TO_CONNECT'|'PENDING_CONFIGURATION'|'PENDING_AUTHORIZATION'
            },
            'CreatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  The pagination token to use to request the next page of results. Otherwise, this parameter is null.
- Connectors (list) –
  
  An array of connectorV2 summaries.
  - (dict) –
    
    A condensed overview of the connectorV2..
    - ConnectorArn (string) –
      
      The Amazon Resource Name (ARN) of the connectorV2.
    - ConnectorId (string) –
      
      The UUID of the connectorV2 to identify connectorV2 resource.
    - Name (string) –
      
      The Name field contains the user-defined name assigned to the integration connector. This helps identify and manage multiple connectors within Security Hub.
    - Description (string) –
      
      The description of the connectorV2.
    - ProviderSummary (dict) –
      
      The connectorV2 third party provider configuration summary.
      - ProviderName (string) –
        
        The name of the provider.
      - ConnectorStatus (string) –
        
        The status for the connectorV2.
    - CreatedAt (datetime) –
      
      ISO 8601 UTC timestamp for the time create the connectorV2.

Exceptions

SecurityHub.Client.exceptions.AccessDeniedException
SecurityHub.Client.exceptions.InternalServerException
SecurityHub.Client.exceptions.ValidationException
SecurityHub.Client.exceptions.ThrottlingException
SecurityHub.Client.exceptions.ConflictException
SecurityHub.Client.exceptions.ResourceNotFoundException