MailManager / Client / get_addon_instance

get_addon_instance#

MailManager.Client.get_addon_instance(**kwargs)#

Gets detailed information about an Add On instance.

See also: AWS API Documentation

Request Syntax

response = client.get_addon_instance(
    AddonInstanceId='string'
)
Parameters:

AddonInstanceId (string) –

[REQUIRED]

The Add On instance ID to retrieve information for.

Return type:

dict

Returns:

Response Syntax

{
    'AddonInstanceArn': 'string',
    'AddonName': 'string',
    'AddonSubscriptionId': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • AddonInstanceArn (string) –

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

    • AddonName (string) –

      The name of the Add On provider associated to the subscription of the instance.

    • AddonSubscriptionId (string) –

      The subscription ID associated to the instance.

    • CreatedTimestamp (datetime) –

      The timestamp of when the Add On instance was created.

Exceptions

  • MailManager.Client.exceptions.ValidationException

  • MailManager.Client.exceptions.ResourceNotFoundException