MailManager / Client / list_addon_instances

list_addon_instances#

MailManager.Client.list_addon_instances(**kwargs)#

Lists all Add On instances in your account.

See also: AWS API Documentation

Request Syntax

response = client.list_addon_instances(
    NextToken='string',
    PageSize=123
)
Parameters:

  • NextToken (string) – If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • PageSize (integer) – The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

Return type:

dict

Returns:

Response Syntax

{
    'AddonInstances': [
        {
            'AddonInstanceArn': 'string',
            'AddonInstanceId': 'string',
            'AddonName': 'string',
            'AddonSubscriptionId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AddonInstances (list) –

      The list of ingress endpoints.

      • (dict) –

        An Add On instance represents a specific configuration of an Add On.

        • AddonInstanceArn (string) –

          The Amazon Resource Name (ARN) of the Add On instance.

        • AddonInstanceId (string) –

          The unique ID of the Add On instance.

        • AddonName (string) –

          The name of the Add On for the instance.

        • AddonSubscriptionId (string) –

          The subscription ID for the instance.

        • CreatedTimestamp (datetime) –

          The timestamp of when the Add On instance was created.

    • NextToken (string) –

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Exceptions

  • MailManager.Client.exceptions.ValidationException