GetAddonInstance - Amazon SES Mail Manager API

GetAddonInstance

Gets detailed information about an Add On instance.

Request Syntax

{ "AddonInstanceId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AddonInstanceId

The Add On instance ID to retrieve information for.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 67.

Pattern: ^ai-[a-zA-Z0-9]{1,64}$

Required: Yes

Response Syntax

{ "AddonInstanceArn": "string", "AddonName": "string", "AddonSubscriptionId": "string", "CreatedTimestamp": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AddonInstanceArn

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

Type: String

AddonName

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

Type: String

AddonSubscriptionId

The subscription ID associated to the instance.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 67.

Pattern: ^as-[a-zA-Z0-9]{1,64}$

CreatedTimestamp

The timestamp of when the Add On instance was created.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

Occurs when a requested resource is not found.

HTTP Status Code: 400

ValidationException

The request validation has failed. For details, see the accompanying error message.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: