ManagedintegrationsforIoTDeviceManagement / Client / list_account_associations

list_account_associations

ManagedintegrationsforIoTDeviceManagement.Client.list_account_associations(**kwargs)

Lists all account associations, with optional filtering by connector destination ID.

See also: AWS API Documentation

Request Syntax

response = client.list_account_associations(
    ConnectorDestinationId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • ConnectorDestinationId (string) – The identifier of the connector destination to filter account associations by.

  • MaxResults (integer) – The maximum number of account associations to return in a single response.

  • NextToken (string) – A token used for pagination of results.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'AccountAssociationId': 'string',
            'AssociationState': 'ASSOCIATION_IN_PROGRESS'|'ASSOCIATION_FAILED'|'ASSOCIATION_SUCCEEDED'|'ASSOCIATION_DELETING'|'REFRESH_TOKEN_EXPIRED',
            'ErrorMessage': 'string',
            'ConnectorDestinationId': 'string',
            'Name': 'string',
            'Description': 'string',
            'Arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      The list of account associations that match the specified criteria.

      • (dict) –

        Structure containing information about an account association, including its identifier, state, and related metadata.

        • AccountAssociationId (string) –

          The unique identifier of the account association.

        • AssociationState (string) –

          The current state of the account association, indicating its status in the association lifecycle.

        • ErrorMessage (string) –

          The error message explaining any issues with the account association, if applicable.

        • ConnectorDestinationId (string) –

          The identifier of the connector destination associated with this account association.

        • Name (string) –

          The name of the account association.

        • Description (string) –

          A description of the account association.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the account association.

    • NextToken (string) –

      A token used for pagination of results when there are more account associations than can be returned in a single response.

Exceptions