AppIntegrationsService / Client / list_event_integration_associations

list_event_integration_associations#

AppIntegrationsService.Client.list_event_integration_associations(**kwargs)#

Returns a paginated list of event integration associations in the account.

See also: AWS API Documentation

Request Syntax

response = client.list_event_integration_associations(
    EventIntegrationName='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • EventIntegrationName (string) –

    [REQUIRED]

    The name of the event integration.

  • NextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • MaxResults (integer) – The maximum number of results to return per page.

Return type:

dict

Returns:

Response Syntax

{
    'EventIntegrationAssociations': [
        {
            'EventIntegrationAssociationArn': 'string',
            'EventIntegrationAssociationId': 'string',
            'EventIntegrationName': 'string',
            'ClientId': 'string',
            'EventBridgeRuleName': 'string',
            'ClientAssociationMetadata': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • EventIntegrationAssociations (list) –

      The event integration associations.

      • (dict) –

        The event integration association.

        • EventIntegrationAssociationArn (string) –

          The Amazon Resource Name (ARN) for the event integration association.

        • EventIntegrationAssociationId (string) –

          The identifier for the event integration association.

        • EventIntegrationName (string) –

          The name of the event integration.

        • ClientId (string) –

          The identifier for the client that is associated with the event integration.

        • EventBridgeRuleName (string) –

          The name of the EventBridge rule.

        • ClientAssociationMetadata (dict) –

          The metadata associated with the client.

          • (string) –

            • (string) –

    • NextToken (string) –

      If there are additional results, this is the token for the next set of results.

Exceptions

  • AppIntegrationsService.Client.exceptions.InternalServiceError

  • AppIntegrationsService.Client.exceptions.ThrottlingException

  • AppIntegrationsService.Client.exceptions.ResourceNotFoundException

  • AppIntegrationsService.Client.exceptions.InvalidRequestException

  • AppIntegrationsService.Client.exceptions.AccessDeniedException