# Actions The following actions are supported: + [CreateAddonInstance](API_CreateAddonInstance.md) + [CreateAddonSubscription](API_CreateAddonSubscription.md) + [CreateAddressList](API_CreateAddressList.md) + [CreateAddressListImportJob](API_CreateAddressListImportJob.md) + [CreateArchive](API_CreateArchive.md) + [CreateIngressPoint](API_CreateIngressPoint.md) + [CreateRelay](API_CreateRelay.md) + [CreateRuleSet](API_CreateRuleSet.md) + [CreateTrafficPolicy](API_CreateTrafficPolicy.md) + [DeleteAddonInstance](API_DeleteAddonInstance.md) + [DeleteAddonSubscription](API_DeleteAddonSubscription.md) + [DeleteAddressList](API_DeleteAddressList.md) + [DeleteArchive](API_DeleteArchive.md) + [DeleteIngressPoint](API_DeleteIngressPoint.md) + [DeleteRelay](API_DeleteRelay.md) + [DeleteRuleSet](API_DeleteRuleSet.md) + [DeleteTrafficPolicy](API_DeleteTrafficPolicy.md) + [DeregisterMemberFromAddressList](API_DeregisterMemberFromAddressList.md) + [GetAddonInstance](API_GetAddonInstance.md) + [GetAddonSubscription](API_GetAddonSubscription.md) + [GetAddressList](API_GetAddressList.md) + [GetAddressListImportJob](API_GetAddressListImportJob.md) + [GetArchive](API_GetArchive.md) + [GetArchiveExport](API_GetArchiveExport.md) + [GetArchiveMessage](API_GetArchiveMessage.md) + [GetArchiveMessageContent](API_GetArchiveMessageContent.md) + [GetArchiveSearch](API_GetArchiveSearch.md) + [GetArchiveSearchResults](API_GetArchiveSearchResults.md) + [GetIngressPoint](API_GetIngressPoint.md) + [GetMemberOfAddressList](API_GetMemberOfAddressList.md) + [GetRelay](API_GetRelay.md) + [GetRuleSet](API_GetRuleSet.md) + [GetTrafficPolicy](API_GetTrafficPolicy.md) + [ListAddonInstances](API_ListAddonInstances.md) + [ListAddonSubscriptions](API_ListAddonSubscriptions.md) + [ListAddressListImportJobs](API_ListAddressListImportJobs.md) + [ListAddressLists](API_ListAddressLists.md) + [ListArchiveExports](API_ListArchiveExports.md) + [ListArchives](API_ListArchives.md) + [ListArchiveSearches](API_ListArchiveSearches.md) + [ListIngressPoints](API_ListIngressPoints.md) + [ListMembersOfAddressList](API_ListMembersOfAddressList.md) + [ListRelays](API_ListRelays.md) + [ListRuleSets](API_ListRuleSets.md) + [ListTagsForResource](API_ListTagsForResource.md) + [ListTrafficPolicies](API_ListTrafficPolicies.md) + [RegisterMemberToAddressList](API_RegisterMemberToAddressList.md) + [StartAddressListImportJob](API_StartAddressListImportJob.md) + [StartArchiveExport](API_StartArchiveExport.md) + [StartArchiveSearch](API_StartArchiveSearch.md) + [StopAddressListImportJob](API_StopAddressListImportJob.md) + [StopArchiveExport](API_StopArchiveExport.md) + [StopArchiveSearch](API_StopArchiveSearch.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateArchive](API_UpdateArchive.md) + [UpdateIngressPoint](API_UpdateIngressPoint.md) + [UpdateRelay](API_UpdateRelay.md) + [UpdateRuleSet](API_UpdateRuleSet.md) + [UpdateTrafficPolicy](API_UpdateTrafficPolicy.md) # CreateAddonInstance Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy. ## Request Syntax ``` { "AddonSubscriptionId": "string", "ClientToken": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AddonSubscriptionId](#API_CreateAddonInstance_RequestSyntax) ** The unique ID of a previously created subscription that an Add On instance is created for. You can only have one instance per subscription. Type: String Length Constraints: Minimum length of 4. Maximum length of 67. Pattern: `as-[a-zA-Z0-9]{1,64}` Required: Yes ** [ClientToken](#API_CreateAddonInstance_RequestSyntax) ** A unique token that Amazon SES uses to recognize subsequent retries of the same request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ** [Tags](#API_CreateAddonInstance_RequestSyntax) ** The tags used to organize, track, or control access for the resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "AddonInstanceId": "string" } ``` ## 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. ** [AddonInstanceId](#API_CreateAddonInstance_ResponseSyntax) ** The unique ID of the Add On instance created by this API. Type: String Length Constraints: Minimum length of 4. Maximum length of 67. Pattern: `ai-[a-zA-Z0-9]{1,64}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Occurs when an operation exceeds a predefined service quota or limit. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/CreateAddonInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/CreateAddonInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/CreateAddonInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/CreateAddonInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/CreateAddonInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/CreateAddonInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/CreateAddonInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/CreateAddonInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/CreateAddonInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/CreateAddonInstance) # CreateAddonSubscription Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies. ## Request Syntax ``` { "AddonName": "string", "ClientToken": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AddonName](#API_CreateAddonSubscription_RequestSyntax) ** The name of the Add On to subscribe to. You can only have one subscription for each Add On name. Type: String Required: Yes ** [ClientToken](#API_CreateAddonSubscription_RequestSyntax) ** A unique token that Amazon SES uses to recognize subsequent retries of the same request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ** [Tags](#API_CreateAddonSubscription_RequestSyntax) ** The tags used to organize, track, or control access for the resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "AddonSubscriptionId": "string" } ``` ## 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. ** [AddonSubscriptionId](#API_CreateAddonSubscription_ResponseSyntax) ** The unique ID of the Add On subscription created by this API. Type: String Length Constraints: Minimum length of 4. Maximum length of 67. Pattern: `as-[a-zA-Z0-9]{1,64}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Occurs when an operation exceeds a predefined service quota or limit. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/CreateAddonSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/CreateAddonSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/CreateAddonSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/CreateAddonSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/CreateAddonSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/CreateAddonSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/CreateAddonSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/CreateAddonSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/CreateAddonSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/CreateAddonSubscription) # CreateAddressList Creates a new address list. ## Request Syntax ``` { "AddressListName": "string", "ClientToken": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AddressListName](#API_CreateAddressList_RequestSyntax) ** A user-friendly name for the address list. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [ClientToken](#API_CreateAddressList_RequestSyntax) ** A unique token that Amazon SES uses to recognize subsequent retries of the same request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ** [Tags](#API_CreateAddressList_RequestSyntax) ** The tags used to organize, track, or control access for the resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "AddressListId": "string" } ``` ## 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. ** [AddressListId](#API_CreateAddressList_ResponseSyntax) ** The identifier of the created address list. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Occurs when an operation exceeds a predefined service quota or limit. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/CreateAddressList) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/CreateAddressList) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/CreateAddressList) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/CreateAddressList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/CreateAddressList) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/CreateAddressList) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/CreateAddressList) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/CreateAddressList) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/CreateAddressList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/CreateAddressList) # CreateAddressListImportJob Creates an import job for an address list. ## Request Syntax ``` { "AddressListId": "string", "ClientToken": "string", "ImportDataFormat": { "ImportDataType": "string" }, "Name": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AddressListId](#API_CreateAddressListImportJob_RequestSyntax) ** The unique identifier of the address list for importing addresses to. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` Required: Yes ** [ClientToken](#API_CreateAddressListImportJob_RequestSyntax) ** A unique token that Amazon SES uses to recognize subsequent retries of the same request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ** [ImportDataFormat](#API_CreateAddressListImportJob_RequestSyntax) ** The format of the input for an import job. Type: [ImportDataFormat](API_ImportDataFormat.md) object Required: Yes ** [Name](#API_CreateAddressListImportJob_RequestSyntax) ** A user-friendly name for the import job. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ## Response Syntax ``` { "JobId": "string", "PreSignedUrl": "string" } ``` ## 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. ** [JobId](#API_CreateAddressListImportJob_ResponseSyntax) ** The identifier of the created import job. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` ** [PreSignedUrl](#API_CreateAddressListImportJob_ResponseSyntax) ** The pre-signed URL target for uploading the input file. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/CreateAddressListImportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/CreateAddressListImportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/CreateAddressListImportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/CreateAddressListImportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/CreateAddressListImportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/CreateAddressListImportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/CreateAddressListImportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/CreateAddressListImportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/CreateAddressListImportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/CreateAddressListImportJob) # CreateArchive Creates a new email archive resource for storing and retaining emails. ## Request Syntax ``` { "ArchiveName": "string", "ClientToken": "string", "KmsKeyArn": "string", "Retention": { ... }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArchiveName](#API_CreateArchive_RequestSyntax) ** A unique name for the new archive. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]` Required: Yes ** [ClientToken](#API_CreateArchive_RequestSyntax) ** A unique token Amazon SES uses to recognize retries of this request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ** [KmsKeyArn](#API_CreateArchive_RequestSyntax) ** The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive. Type: String Pattern: `arn:aws(|-cn|-us-gov|-eusc):kms:[a-z0-9-]{1,20}:[0-9]{12}:(key|alias)/.+` Required: No ** [Retention](#API_CreateArchive_RequestSyntax) ** The period for retaining emails in the archive before automatic deletion. Type: [ArchiveRetention](API_ArchiveRetention.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ** [Tags](#API_CreateArchive_RequestSyntax) ** The tags used to organize, track, or control access for the resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "ArchiveId": "string" } ``` ## 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. ** [ArchiveId](#API_CreateArchive_ResponseSyntax) ** The unique identifier for the newly created archive. Type: String Length Constraints: Minimum length of 1. Maximum length of 66. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Occurs when an operation exceeds a predefined service quota or limit. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/CreateArchive) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/CreateArchive) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/CreateArchive) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/CreateArchive) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/CreateArchive) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/CreateArchive) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/CreateArchive) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/CreateArchive) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/CreateArchive) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/CreateArchive) # CreateIngressPoint Provision a new ingress endpoint resource. ## Request Syntax ``` { "ClientToken": "string", "IngressPointConfiguration": { ... }, "IngressPointName": "string", "NetworkConfiguration": { ... }, "RuleSetId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TlsPolicy": "string", "TrafficPolicyId": "string", "Type": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientToken](#API_CreateIngressPoint_RequestSyntax) ** A unique token that Amazon SES uses to recognize subsequent retries of the same request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ** [IngressPointConfiguration](#API_CreateIngressPoint_RequestSyntax) ** If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN. Type: [IngressPointConfiguration](API_IngressPointConfiguration.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ** [IngressPointName](#API_CreateIngressPoint_RequestSyntax) ** A user friendly name for an ingress endpoint resource. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: `[A-Za-z0-9_\-]+` Required: Yes ** [NetworkConfiguration](#API_CreateIngressPoint_RequestSyntax) ** Specifies the network configuration for the ingress point. This allows you to create an IPv4-only, Dual-Stack, or PrivateLink type of ingress point. If not specified, the default network type is IPv4-only. Type: [NetworkConfiguration](API_NetworkConfiguration.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ** [RuleSetId](#API_CreateIngressPoint_RequestSyntax) ** The identifier of an existing rule set that you attach to an ingress endpoint resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes ** [Tags](#API_CreateIngressPoint_RequestSyntax) ** The tags used to organize, track, or control access for the resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [TlsPolicy](#API_CreateIngressPoint_RequestSyntax) ** The Transport Layer Security (TLS) policy for the ingress point. The FIPS value is only valid in US and Canada regions. Type: String Valid Values: `REQUIRED | OPTIONAL | FIPS` Required: No ** [TrafficPolicyId](#API_CreateIngressPoint_RequestSyntax) ** The identifier of an existing traffic policy that you attach to an ingress endpoint resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes ** [Type](#API_CreateIngressPoint_RequestSyntax) ** The type of the ingress endpoint to create. Type: String Valid Values: `OPEN | AUTH | MTLS` Required: Yes ## Response Syntax ``` { "IngressPointId": "string" } ``` ## 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. ** [IngressPointId](#API_CreateIngressPoint_ResponseSyntax) ** The unique identifier for a previously created ingress endpoint. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Occurs when an operation exceeds a predefined service quota or limit. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/CreateIngressPoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/CreateIngressPoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/CreateIngressPoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/CreateIngressPoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/CreateIngressPoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/CreateIngressPoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/CreateIngressPoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/CreateIngressPoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/CreateIngressPoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/CreateIngressPoint) # CreateRelay Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations. ## Request Syntax ``` { "Authentication": { ... }, "ClientToken": "string", "RelayName": "string", "ServerName": "string", "ServerPort": number, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Authentication](#API_CreateRelay_RequestSyntax) ** Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored. Type: [RelayAuthentication](API_RelayAuthentication.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [ClientToken](#API_CreateRelay_RequestSyntax) ** A unique token that Amazon SES uses to recognize subsequent retries of the same request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ** [RelayName](#API_CreateRelay_RequestSyntax) ** The unique name of the relay resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9-_]+` Required: Yes ** [ServerName](#API_CreateRelay_RequestSyntax) ** The destination relay server address. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9-\.]+` Required: Yes ** [ServerPort](#API_CreateRelay_RequestSyntax) ** The destination relay server port. Type: Integer Valid Range: Minimum value of 1. Maximum value of 65535. Required: Yes ** [Tags](#API_CreateRelay_RequestSyntax) ** The tags used to organize, track, or control access for the resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "RelayId": "string" } ``` ## 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. ** [RelayId](#API_CreateRelay_ResponseSyntax) ** A unique identifier of the created relay resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9-]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Occurs when an operation exceeds a predefined service quota or limit. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/CreateRelay) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/CreateRelay) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/CreateRelay) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/CreateRelay) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/CreateRelay) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/CreateRelay) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/CreateRelay) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/CreateRelay) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/CreateRelay) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/CreateRelay) # CreateRuleSet Provision a new rule set. ## Request Syntax ``` { "ClientToken": "string", "Rules": [ { "Actions": [ { ... } ], "Conditions": [ { ... } ], "Name": "string", "Unless": [ { ... } ] } ], "RuleSetName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientToken](#API_CreateRuleSet_RequestSyntax) ** A unique token that Amazon SES uses to recognize subsequent retries of the same request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ** [Rules](#API_CreateRuleSet_RequestSyntax) ** Conditional rules that are evaluated for determining actions on email. Type: Array of [Rule](API_Rule.md) objects Array Members: Minimum number of 0 items. Maximum number of 40 items. Required: Yes ** [RuleSetName](#API_CreateRuleSet_RequestSyntax) ** A user-friendly name for the rule set. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [Tags](#API_CreateRuleSet_RequestSyntax) ** The tags used to organize, track, or control access for the resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "RuleSetId": "string" } ``` ## 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. ** [RuleSetId](#API_CreateRuleSet_ResponseSyntax) ** The identifier of the created rule set. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Occurs when an operation exceeds a predefined service quota or limit. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/CreateRuleSet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/CreateRuleSet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/CreateRuleSet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/CreateRuleSet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/CreateRuleSet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/CreateRuleSet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/CreateRuleSet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/CreateRuleSet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/CreateRuleSet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/CreateRuleSet) # CreateTrafficPolicy Provision a new traffic policy resource. ## Request Syntax ``` { "ClientToken": "string", "DefaultAction": "string", "MaxMessageSizeBytes": number, "PolicyStatements": [ { "Action": "string", "Conditions": [ { ... } ] } ], "Tags": [ { "Key": "string", "Value": "string" } ], "TrafficPolicyName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientToken](#API_CreateTrafficPolicy_RequestSyntax) ** A unique token that Amazon SES uses to recognize subsequent retries of the same request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ** [DefaultAction](#API_CreateTrafficPolicy_RequestSyntax) ** Default action instructs the traﬃc policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements Type: String Valid Values: `ALLOW | DENY` Required: Yes ** [MaxMessageSizeBytes](#API_CreateTrafficPolicy_RequestSyntax) ** The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked. Type: Integer Valid Range: Minimum value of 1. Required: No ** [PolicyStatements](#API_CreateTrafficPolicy_RequestSyntax) ** Conditional statements for filtering email traffic. Type: Array of [PolicyStatement](API_PolicyStatement.md) objects Required: Yes ** [Tags](#API_CreateTrafficPolicy_RequestSyntax) ** The tags used to organize, track, or control access for the resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [TrafficPolicyName](#API_CreateTrafficPolicy_RequestSyntax) ** A user-friendly name for the traffic policy resource. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: `[A-Za-z0-9_\-]+` Required: Yes ## Response Syntax ``` { "TrafficPolicyId": "string" } ``` ## 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. ** [TrafficPolicyId](#API_CreateTrafficPolicy_ResponseSyntax) ** The identifier of the traffic policy resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Occurs when an operation exceeds a predefined service quota or limit. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/CreateTrafficPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/CreateTrafficPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/CreateTrafficPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/CreateTrafficPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/CreateTrafficPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/CreateTrafficPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/CreateTrafficPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/CreateTrafficPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/CreateTrafficPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/CreateTrafficPolicy) # DeleteAddonInstance Deletes an Add On instance. ## Request Syntax ``` { "AddonInstanceId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AddonInstanceId](#API_DeleteAddonInstance_RequestSyntax) ** The Add On instance ID to delete. Type: String Length Constraints: Minimum length of 4. Maximum length of 67. Pattern: `ai-[a-zA-Z0-9]{1,64}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/DeleteAddonInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/DeleteAddonInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/DeleteAddonInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/DeleteAddonInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/DeleteAddonInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/DeleteAddonInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/DeleteAddonInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/DeleteAddonInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/DeleteAddonInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/DeleteAddonInstance) # DeleteAddonSubscription Deletes an Add On subscription. ## Request Syntax ``` { "AddonSubscriptionId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AddonSubscriptionId](#API_DeleteAddonSubscription_RequestSyntax) ** The Add On subscription ID to delete. Type: String Length Constraints: Minimum length of 4. Maximum length of 67. Pattern: `as-[a-zA-Z0-9]{1,64}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/DeleteAddonSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/DeleteAddonSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/DeleteAddonSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/DeleteAddonSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/DeleteAddonSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/DeleteAddonSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/DeleteAddonSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/DeleteAddonSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/DeleteAddonSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/DeleteAddonSubscription) # DeleteAddressList Deletes an address list. ## Request Syntax ``` { "AddressListId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AddressListId](#API_DeleteAddressList_RequestSyntax) ** The identifier of an existing address list resource to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/DeleteAddressList) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/DeleteAddressList) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/DeleteAddressList) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/DeleteAddressList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/DeleteAddressList) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/DeleteAddressList) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/DeleteAddressList) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/DeleteAddressList) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/DeleteAddressList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/DeleteAddressList) # DeleteArchive Initiates deletion of an email archive. This changes the archive state to pending deletion. In this state, no new emails can be added, and existing archived emails become inaccessible (search, export, download). The archive and all of its contents will be permanently deleted 30 days after entering the pending deletion state, regardless of the configured retention period. ## Request Syntax ``` { "ArchiveId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArchiveId](#API_DeleteArchive_RequestSyntax) ** The identifier of the archive to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 66. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/DeleteArchive) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/DeleteArchive) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/DeleteArchive) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/DeleteArchive) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/DeleteArchive) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/DeleteArchive) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/DeleteArchive) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/DeleteArchive) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/DeleteArchive) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/DeleteArchive) # DeleteIngressPoint Delete an ingress endpoint resource. ## Request Syntax ``` { "IngressPointId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [IngressPointId](#API_DeleteIngressPoint_RequestSyntax) ** The identifier of the ingress endpoint resource that you want to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/DeleteIngressPoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/DeleteIngressPoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/DeleteIngressPoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/DeleteIngressPoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/DeleteIngressPoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/DeleteIngressPoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/DeleteIngressPoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/DeleteIngressPoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/DeleteIngressPoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/DeleteIngressPoint) # DeleteRelay Deletes an existing relay resource. ## Request Syntax ``` { "RelayId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [RelayId](#API_DeleteRelay_RequestSyntax) ** The unique relay identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9-]+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/DeleteRelay) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/DeleteRelay) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/DeleteRelay) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/DeleteRelay) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/DeleteRelay) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/DeleteRelay) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/DeleteRelay) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/DeleteRelay) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/DeleteRelay) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/DeleteRelay) # DeleteRuleSet Delete a rule set. ## Request Syntax ``` { "RuleSetId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [RuleSetId](#API_DeleteRuleSet_RequestSyntax) ** The identifier of an existing rule set resource to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/DeleteRuleSet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/DeleteRuleSet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/DeleteRuleSet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/DeleteRuleSet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/DeleteRuleSet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/DeleteRuleSet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/DeleteRuleSet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/DeleteRuleSet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/DeleteRuleSet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/DeleteRuleSet) # DeleteTrafficPolicy Delete a traffic policy resource. ## Request Syntax ``` { "TrafficPolicyId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrafficPolicyId](#API_DeleteTrafficPolicy_RequestSyntax) ** The identifier of the traffic policy that you want to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/DeleteTrafficPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/DeleteTrafficPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/DeleteTrafficPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/DeleteTrafficPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/DeleteTrafficPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/DeleteTrafficPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/DeleteTrafficPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/DeleteTrafficPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/DeleteTrafficPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/DeleteTrafficPolicy) # DeregisterMemberFromAddressList Removes a member from an address list. ## Request Syntax ``` { "Address": "string", "AddressListId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Address](#API_DeregisterMemberFromAddressList_RequestSyntax) ** The address to be removed from the address list. Type: String Length Constraints: Minimum length of 3. Maximum length of 320. Required: Yes ** [AddressListId](#API_DeregisterMemberFromAddressList_RequestSyntax) ** The unique identifier of the address list to remove the address from. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/DeregisterMemberFromAddressList) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/DeregisterMemberFromAddressList) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/DeregisterMemberFromAddressList) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/DeregisterMemberFromAddressList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/DeregisterMemberFromAddressList) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/DeregisterMemberFromAddressList) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/DeregisterMemberFromAddressList) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/DeregisterMemberFromAddressList) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/DeregisterMemberFromAddressList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/DeregisterMemberFromAddressList) # 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](CommonParameters.md). The request accepts the following data in JSON format. ** [AddonInstanceId](#API_GetAddonInstance_RequestSyntax) ** 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](#API_GetAddonInstance_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Add On instance. Type: String ** [AddonName](#API_GetAddonInstance_ResponseSyntax) ** The name of the Add On provider associated to the subscription of the instance. Type: String ** [AddonSubscriptionId](#API_GetAddonInstance_ResponseSyntax) ** 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](#API_GetAddonInstance_ResponseSyntax) ** 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 Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetAddonInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetAddonInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetAddonInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetAddonInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetAddonInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetAddonInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetAddonInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetAddonInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetAddonInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetAddonInstance) # GetAddonSubscription Gets detailed information about an Add On subscription. ## Request Syntax ``` { "AddonSubscriptionId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AddonSubscriptionId](#API_GetAddonSubscription_RequestSyntax) ** The Add On subscription ID to retrieve information for. Type: String Length Constraints: Minimum length of 4. Maximum length of 67. Pattern: `as-[a-zA-Z0-9]{1,64}` Required: Yes ## Response Syntax ``` { "AddonName": "string", "AddonSubscriptionArn": "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. ** [AddonName](#API_GetAddonSubscription_ResponseSyntax) ** The name of the Add On for the subscription. Type: String ** [AddonSubscriptionArn](#API_GetAddonSubscription_ResponseSyntax) ** Amazon Resource Name (ARN) for the subscription. Type: String ** [CreatedTimestamp](#API_GetAddonSubscription_ResponseSyntax) ** The timestamp of when the Add On subscription was created. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetAddonSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetAddonSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetAddonSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetAddonSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetAddonSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetAddonSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetAddonSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetAddonSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetAddonSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetAddonSubscription) # GetAddressList Fetch attributes of an address list. ## Request Syntax ``` { "AddressListId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AddressListId](#API_GetAddressList_RequestSyntax) ** The identifier of an existing address list resource to be retrieved. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` Required: Yes ## Response Syntax ``` { "AddressListArn": "string", "AddressListId": "string", "AddressListName": "string", "CreatedTimestamp": number, "LastUpdatedTimestamp": 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. ** [AddressListArn](#API_GetAddressList_ResponseSyntax) ** The Amazon Resource Name (ARN) of the address list resource. Type: String ** [AddressListId](#API_GetAddressList_ResponseSyntax) ** The identifier of the address list resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` ** [AddressListName](#API_GetAddressList_ResponseSyntax) ** A user-friendly name for the address list resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9_.-]+` ** [CreatedTimestamp](#API_GetAddressList_ResponseSyntax) ** The date of when then address list was created. Type: Timestamp ** [LastUpdatedTimestamp](#API_GetAddressList_ResponseSyntax) ** The date of when the address list was last updated. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetAddressList) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetAddressList) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetAddressList) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetAddressList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetAddressList) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetAddressList) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetAddressList) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetAddressList) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetAddressList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetAddressList) # GetAddressListImportJob Fetch attributes of an import job. ## Request Syntax ``` { "JobId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobId](#API_GetAddressListImportJob_RequestSyntax) ** The identifier of the import job that needs to be retrieved. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` Required: Yes ## Response Syntax ``` { "AddressListId": "string", "CompletedTimestamp": number, "CreatedTimestamp": number, "Error": "string", "FailedItemsCount": number, "ImportDataFormat": { "ImportDataType": "string" }, "ImportedItemsCount": number, "JobId": "string", "Name": "string", "PreSignedUrl": "string", "StartTimestamp": number, "Status": "string" } ``` ## 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. ** [AddressListId](#API_GetAddressListImportJob_ResponseSyntax) ** The unique identifier of the address list the import job was created for. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` ** [CompletedTimestamp](#API_GetAddressListImportJob_ResponseSyntax) ** The timestamp of when the import job was completed. Type: Timestamp ** [CreatedTimestamp](#API_GetAddressListImportJob_ResponseSyntax) ** The timestamp of when the import job was created. Type: Timestamp ** [Error](#API_GetAddressListImportJob_ResponseSyntax) ** The reason for failure of an import job. Type: String ** [FailedItemsCount](#API_GetAddressListImportJob_ResponseSyntax) ** The number of input addresses that failed to be imported into the address list. Type: Integer ** [ImportDataFormat](#API_GetAddressListImportJob_ResponseSyntax) ** The format of the input for an import job. Type: [ImportDataFormat](API_ImportDataFormat.md) object ** [ImportedItemsCount](#API_GetAddressListImportJob_ResponseSyntax) ** The number of input addresses successfully imported into the address list. Type: Integer ** [JobId](#API_GetAddressListImportJob_ResponseSyntax) ** The identifier of the import job. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` ** [Name](#API_GetAddressListImportJob_ResponseSyntax) ** A user-friendly name for the import job. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9_.-]+` ** [PreSignedUrl](#API_GetAddressListImportJob_ResponseSyntax) ** The pre-signed URL target for uploading the input file. Type: String ** [StartTimestamp](#API_GetAddressListImportJob_ResponseSyntax) ** The timestamp of when the import job was started. Type: Timestamp ** [Status](#API_GetAddressListImportJob_ResponseSyntax) ** The status of the import job. Type: String Valid Values: `CREATED | PROCESSING | COMPLETED | FAILED | STOPPED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetAddressListImportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetAddressListImportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetAddressListImportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetAddressListImportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetAddressListImportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetAddressListImportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetAddressListImportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetAddressListImportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetAddressListImportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetAddressListImportJob) # GetArchive Retrieves the full details and current state of a specified email archive. ## Request Syntax ``` { "ArchiveId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArchiveId](#API_GetArchive_RequestSyntax) ** The identifier of the archive to retrieve. Type: String Length Constraints: Minimum length of 1. Maximum length of 66. Required: Yes ## Response Syntax ``` { "ArchiveArn": "string", "ArchiveId": "string", "ArchiveName": "string", "ArchiveState": "string", "CreatedTimestamp": number, "KmsKeyArn": "string", "LastUpdatedTimestamp": number, "Retention": { ... } } ``` ## 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. ** [ArchiveArn](#API_GetArchive_ResponseSyntax) ** The Amazon Resource Name (ARN) of the archive. Type: String ** [ArchiveId](#API_GetArchive_ResponseSyntax) ** The unique identifier of the archive. Type: String Length Constraints: Minimum length of 1. Maximum length of 66. ** [ArchiveName](#API_GetArchive_ResponseSyntax) ** The unique name assigned to the archive. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]` ** [ArchiveState](#API_GetArchive_ResponseSyntax) ** The current state of the archive: + `ACTIVE` – The archive is ready and available for use. + `PENDING_DELETION` – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state. Type: String Valid Values: `ACTIVE | PENDING_DELETION` ** [CreatedTimestamp](#API_GetArchive_ResponseSyntax) ** The timestamp of when the archive was created. Type: Timestamp ** [KmsKeyArn](#API_GetArchive_ResponseSyntax) ** The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive. Type: String Pattern: `arn:aws(|-cn|-us-gov|-eusc):kms:[a-z0-9-]{1,20}:[0-9]{12}:(key|alias)/.+` ** [LastUpdatedTimestamp](#API_GetArchive_ResponseSyntax) ** The timestamp of when the archive was modified. Type: Timestamp ** [Retention](#API_GetArchive_ResponseSyntax) ** The retention period for emails in this archive. Type: [ArchiveRetention](API_ArchiveRetention.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetArchive) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetArchive) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetArchive) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetArchive) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetArchive) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetArchive) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetArchive) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetArchive) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetArchive) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetArchive) # GetArchiveExport Retrieves the details and current status of a specific email archive export job. ## Request Syntax ``` { "ExportId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ExportId](#API_GetArchiveExport_RequestSyntax) ** The identifier of the export job to get details for. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes ## Response Syntax ``` { "ArchiveId": "string", "ExportDestinationConfiguration": { ... }, "Filters": { "Include": [ { ... } ], "Unless": [ { ... } ] }, "FromTimestamp": number, "MaxResults": number, "Status": { "CompletionTimestamp": number, "ErrorMessage": "string", "State": "string", "SubmissionTimestamp": number }, "ToTimestamp": 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. ** [ArchiveId](#API_GetArchiveExport_ResponseSyntax) ** The identifier of the archive the email export was performed from. Type: String Length Constraints: Minimum length of 3. Maximum length of 66. Pattern: `a-[\w]{1,64}` ** [ExportDestinationConfiguration](#API_GetArchiveExport_ResponseSyntax) ** Where the exported emails are being delivered. Type: [ExportDestinationConfiguration](API_ExportDestinationConfiguration.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [Filters](#API_GetArchiveExport_ResponseSyntax) ** The criteria used to filter emails included in the export. Type: [ArchiveFilters](API_ArchiveFilters.md) object ** [FromTimestamp](#API_GetArchiveExport_ResponseSyntax) ** The start of the timestamp range the exported emails cover. Type: Timestamp ** [MaxResults](#API_GetArchiveExport_ResponseSyntax) ** The maximum number of email items included in the export. Type: Integer ** [Status](#API_GetArchiveExport_ResponseSyntax) ** The current status of the export job. Type: [ExportStatus](API_ExportStatus.md) object ** [ToTimestamp](#API_GetArchiveExport_ResponseSyntax) ** The end of the date range the exported emails cover. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetArchiveExport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetArchiveExport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetArchiveExport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetArchiveExport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetArchiveExport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetArchiveExport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetArchiveExport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetArchiveExport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetArchiveExport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetArchiveExport) # GetArchiveMessage Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive. ## Request Syntax ``` { "ArchivedMessageId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArchivedMessageId](#API_GetArchiveMessage_RequestSyntax) ** The unique identifier of the archived email message. Type: String Required: Yes ## Response Syntax ``` { "Envelope": { "From": "string", "Helo": "string", "To": [ "string" ] }, "MessageDownloadLink": "string", "Metadata": { "ConfigurationSet": "string", "IngressPointId": "string", "RuleSetId": "string", "SenderHostname": "string", "SenderIpAddress": "string", "SendingMethod": "string", "SendingPool": "string", "SourceArn": "string", "SourceIdentity": "string", "Timestamp": number, "TlsCipherSuite": "string", "TlsProtocol": "string", "TrafficPolicyId": "string" } } ``` ## 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. ** [Envelope](#API_GetArchiveMessage_ResponseSyntax) ** The SMTP envelope information of the email. Type: [Envelope](API_Envelope.md) object ** [MessageDownloadLink](#API_GetArchiveMessage_ResponseSyntax) ** A pre-signed URL to temporarily download the full message content. Type: String ** [Metadata](#API_GetArchiveMessage_ResponseSyntax) ** The metadata about the email. Type: [Metadata](API_Metadata.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetArchiveMessage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetArchiveMessage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetArchiveMessage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetArchiveMessage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetArchiveMessage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetArchiveMessage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetArchiveMessage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetArchiveMessage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetArchiveMessage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetArchiveMessage) # GetArchiveMessageContent Returns the textual content of a specific email message stored in the archive. Attachments are not included. ## Request Syntax ``` { "ArchivedMessageId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArchivedMessageId](#API_GetArchiveMessageContent_RequestSyntax) ** The unique identifier of the archived email message. Type: String Required: Yes ## Response Syntax ``` { "Body": { "Html": "string", "MessageMalformed": boolean, "Text": "string" } } ``` ## 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. ** [Body](#API_GetArchiveMessageContent_ResponseSyntax) ** The textual body content of the email message. Type: [MessageBody](API_MessageBody.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetArchiveMessageContent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetArchiveMessageContent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetArchiveMessageContent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetArchiveMessageContent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetArchiveMessageContent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetArchiveMessageContent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetArchiveMessageContent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetArchiveMessageContent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetArchiveMessageContent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetArchiveMessageContent) # GetArchiveSearch Retrieves the details and current status of a specific email archive search job. ## Request Syntax ``` { "SearchId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [SearchId](#API_GetArchiveSearch_RequestSyntax) ** The identifier of the search job to get details for. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes ## Response Syntax ``` { "ArchiveId": "string", "Filters": { "Include": [ { ... } ], "Unless": [ { ... } ] }, "FromTimestamp": number, "MaxResults": number, "Status": { "CompletionTimestamp": number, "ErrorMessage": "string", "State": "string", "SubmissionTimestamp": number }, "ToTimestamp": 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. ** [ArchiveId](#API_GetArchiveSearch_ResponseSyntax) ** The identifier of the archive the email search was performed in. Type: String Length Constraints: Minimum length of 3. Maximum length of 66. Pattern: `a-[\w]{1,64}` ** [Filters](#API_GetArchiveSearch_ResponseSyntax) ** The criteria used to filter emails included in the search. Type: [ArchiveFilters](API_ArchiveFilters.md) object ** [FromTimestamp](#API_GetArchiveSearch_ResponseSyntax) ** The start timestamp of the range the searched emails cover. Type: Timestamp ** [MaxResults](#API_GetArchiveSearch_ResponseSyntax) ** The maximum number of search results to return. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1000. ** [Status](#API_GetArchiveSearch_ResponseSyntax) ** The current status of the search job. Type: [SearchStatus](API_SearchStatus.md) object ** [ToTimestamp](#API_GetArchiveSearch_ResponseSyntax) ** The end timestamp of the range the searched emails cover. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetArchiveSearch) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetArchiveSearch) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetArchiveSearch) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetArchiveSearch) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetArchiveSearch) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetArchiveSearch) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetArchiveSearch) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetArchiveSearch) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetArchiveSearch) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetArchiveSearch) # GetArchiveSearchResults Returns the results of a completed email archive search job. ## Request Syntax ``` { "SearchId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [SearchId](#API_GetArchiveSearchResults_RequestSyntax) ** The identifier of the completed search job. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes ## Response Syntax ``` { "Rows": [ { "ArchivedMessageId": "string", "Cc": "string", "Date": "string", "Envelope": { "From": "string", "Helo": "string", "To": [ "string" ] }, "From": "string", "HasAttachments": boolean, "IngressPointId": "string", "InReplyTo": "string", "MessageId": "string", "ReceivedHeaders": [ "string" ], "ReceivedTimestamp": number, "SenderHostname": "string", "SenderIpAddress": "string", "SourceArn": "string", "Subject": "string", "To": "string", "XMailer": "string", "XOriginalMailer": "string", "XPriority": "string" } ] } ``` ## 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. ** [Rows](#API_GetArchiveSearchResults_ResponseSyntax) ** The list of email result objects matching the search criteria. Type: Array of [Row](API_Row.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetArchiveSearchResults) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetArchiveSearchResults) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetArchiveSearchResults) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetArchiveSearchResults) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetArchiveSearchResults) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetArchiveSearchResults) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetArchiveSearchResults) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetArchiveSearchResults) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetArchiveSearchResults) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetArchiveSearchResults) # GetIngressPoint Fetch ingress endpoint resource attributes. ## Request Syntax ``` { "IncludeTrustStoreContents": "string", "IngressPointId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [IncludeTrustStoreContents](#API_GetIngressPoint_RequestSyntax) ** Whether to include the trust store contents in the response. Use INCLUDE to retrieve trust store certificate and CRL contents. Type: String Valid Values: `EXCLUDE | INCLUDE` Required: No ** [IngressPointId](#API_GetIngressPoint_RequestSyntax) ** The identifier of an ingress endpoint. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes ## Response Syntax ``` { "ARecord": "string", "CreatedTimestamp": number, "IngressPointArn": "string", "IngressPointAuthConfiguration": { "IngressPointPasswordConfiguration": { "PreviousSmtpPasswordExpiryTimestamp": number, "PreviousSmtpPasswordVersion": "string", "SmtpPasswordVersion": "string" }, "SecretArn": "string", "TlsAuthConfiguration": { "TrustStore": { "CAContent": "string", "CrlContent": "string", "KmsKeyArn": "string" } } }, "IngressPointId": "string", "IngressPointName": "string", "LastUpdatedTimestamp": number, "NetworkConfiguration": { ... }, "RuleSetId": "string", "Status": "string", "TlsPolicy": "string", "TrafficPolicyId": "string", "Type": "string" } ``` ## 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. ** [ARecord](#API_GetIngressPoint_ResponseSyntax) ** The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager. Type: String ** [CreatedTimestamp](#API_GetIngressPoint_ResponseSyntax) ** The timestamp of when the ingress endpoint was created. Type: Timestamp ** [IngressPointArn](#API_GetIngressPoint_ResponseSyntax) ** The Amazon Resource Name (ARN) of the ingress endpoint resource. Type: String ** [IngressPointAuthConfiguration](#API_GetIngressPoint_ResponseSyntax) ** The authentication configuration of the ingress endpoint resource. Type: [IngressPointAuthConfiguration](API_IngressPointAuthConfiguration.md) object ** [IngressPointId](#API_GetIngressPoint_ResponseSyntax) ** The identifier of an ingress endpoint resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. ** [IngressPointName](#API_GetIngressPoint_ResponseSyntax) ** A user friendly name for the ingress endpoint. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: `[A-Za-z0-9_\-]+` ** [LastUpdatedTimestamp](#API_GetIngressPoint_ResponseSyntax) ** The timestamp of when the ingress endpoint was last updated. Type: Timestamp ** [NetworkConfiguration](#API_GetIngressPoint_ResponseSyntax) ** The network configuration for the ingress point. Type: [NetworkConfiguration](API_NetworkConfiguration.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [RuleSetId](#API_GetIngressPoint_ResponseSyntax) ** The identifier of a rule set resource associated with the ingress endpoint. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. ** [Status](#API_GetIngressPoint_ResponseSyntax) ** The status of the ingress endpoint resource. Type: String Valid Values: `PROVISIONING | DEPROVISIONING | UPDATING | ACTIVE | CLOSED | FAILED | ASSOCIATED_VPC_ENDPOINT_DOES_NOT_EXIST` ** [TlsPolicy](#API_GetIngressPoint_ResponseSyntax) ** The selected Transport Layer Security (TLS) policy of the ingress point. Type: String Valid Values: `REQUIRED | OPTIONAL | FIPS` ** [TrafficPolicyId](#API_GetIngressPoint_ResponseSyntax) ** The identifier of the traffic policy resource associated with the ingress endpoint. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. ** [Type](#API_GetIngressPoint_ResponseSyntax) ** The type of ingress endpoint. Type: String Valid Values: `OPEN | AUTH | MTLS` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetIngressPoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetIngressPoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetIngressPoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetIngressPoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetIngressPoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetIngressPoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetIngressPoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetIngressPoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetIngressPoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetIngressPoint) # GetMemberOfAddressList Fetch attributes of a member in an address list. ## Request Syntax ``` { "Address": "string", "AddressListId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Address](#API_GetMemberOfAddressList_RequestSyntax) ** The address to be retrieved from the address list. Type: String Length Constraints: Minimum length of 3. Maximum length of 320. Required: Yes ** [AddressListId](#API_GetMemberOfAddressList_RequestSyntax) ** The unique identifier of the address list to retrieve the address from. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` Required: Yes ## Response Syntax ``` { "Address": "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. ** [Address](#API_GetMemberOfAddressList_ResponseSyntax) ** The address retrieved from the address list. Type: String Length Constraints: Minimum length of 3. Maximum length of 320. ** [CreatedTimestamp](#API_GetMemberOfAddressList_ResponseSyntax) ** The timestamp of when the address was created. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetMemberOfAddressList) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetMemberOfAddressList) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetMemberOfAddressList) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetMemberOfAddressList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetMemberOfAddressList) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetMemberOfAddressList) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetMemberOfAddressList) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetMemberOfAddressList) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetMemberOfAddressList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetMemberOfAddressList) # GetRelay Fetch the relay resource and it's attributes. ## Request Syntax ``` { "RelayId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [RelayId](#API_GetRelay_RequestSyntax) ** A unique relay identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9-]+` Required: Yes ## Response Syntax ``` { "Authentication": { ... }, "CreatedTimestamp": number, "LastModifiedTimestamp": number, "RelayArn": "string", "RelayId": "string", "RelayName": "string", "ServerName": "string", "ServerPort": 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. ** [Authentication](#API_GetRelay_ResponseSyntax) ** The authentication attribute—contains the secret ARN where the customer relay server credentials are stored. Type: [RelayAuthentication](API_RelayAuthentication.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [CreatedTimestamp](#API_GetRelay_ResponseSyntax) ** The timestamp of when the relay was created. Type: Timestamp ** [LastModifiedTimestamp](#API_GetRelay_ResponseSyntax) ** The timestamp of when relay was last updated. Type: Timestamp ** [RelayArn](#API_GetRelay_ResponseSyntax) ** The Amazon Resource Name (ARN) of the relay. Type: String ** [RelayId](#API_GetRelay_ResponseSyntax) ** The unique relay identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9-]+` ** [RelayName](#API_GetRelay_ResponseSyntax) ** The unique name of the relay. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9-_]+` ** [ServerName](#API_GetRelay_ResponseSyntax) ** The destination relay server address. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9-\.]+` ** [ServerPort](#API_GetRelay_ResponseSyntax) ** The destination relay server port. Type: Integer Valid Range: Minimum value of 1. Maximum value of 65535. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetRelay) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetRelay) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetRelay) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetRelay) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetRelay) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetRelay) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetRelay) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetRelay) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetRelay) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetRelay) # GetRuleSet Fetch attributes of a rule set. ## Request Syntax ``` { "RuleSetId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [RuleSetId](#API_GetRuleSet_RequestSyntax) ** The identifier of an existing rule set to be retrieved. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes ## Response Syntax ``` { "CreatedDate": number, "LastModificationDate": number, "Rules": [ { "Actions": [ { ... } ], "Conditions": [ { ... } ], "Name": "string", "Unless": [ { ... } ] } ], "RuleSetArn": "string", "RuleSetId": "string", "RuleSetName": "string" } ``` ## 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. ** [CreatedDate](#API_GetRuleSet_ResponseSyntax) ** The date of when then rule set was created. Type: Timestamp ** [LastModificationDate](#API_GetRuleSet_ResponseSyntax) ** The date of when the rule set was last modified. Type: Timestamp ** [Rules](#API_GetRuleSet_ResponseSyntax) ** The rules contained in the rule set. Type: Array of [Rule](API_Rule.md) objects Array Members: Minimum number of 0 items. Maximum number of 40 items. ** [RuleSetArn](#API_GetRuleSet_ResponseSyntax) ** The Amazon Resource Name (ARN) of the rule set resource. Type: String ** [RuleSetId](#API_GetRuleSet_ResponseSyntax) ** The identifier of the rule set resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. ** [RuleSetName](#API_GetRuleSet_ResponseSyntax) ** A user-friendly name for the rule set resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9_.-]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetRuleSet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetRuleSet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetRuleSet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetRuleSet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetRuleSet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetRuleSet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetRuleSet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetRuleSet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetRuleSet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetRuleSet) # GetTrafficPolicy Fetch attributes of a traffic policy resource. ## Request Syntax ``` { "TrafficPolicyId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrafficPolicyId](#API_GetTrafficPolicy_RequestSyntax) ** The identifier of the traffic policy resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes ## Response Syntax ``` { "CreatedTimestamp": number, "DefaultAction": "string", "LastUpdatedTimestamp": number, "MaxMessageSizeBytes": number, "PolicyStatements": [ { "Action": "string", "Conditions": [ { ... } ] } ], "TrafficPolicyArn": "string", "TrafficPolicyId": "string", "TrafficPolicyName": "string" } ``` ## 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. ** [CreatedTimestamp](#API_GetTrafficPolicy_ResponseSyntax) ** The timestamp of when the traffic policy was created. Type: Timestamp ** [DefaultAction](#API_GetTrafficPolicy_ResponseSyntax) ** The default action of the traffic policy. Type: String Valid Values: `ALLOW | DENY` ** [LastUpdatedTimestamp](#API_GetTrafficPolicy_ResponseSyntax) ** The timestamp of when the traffic policy was last updated. Type: Timestamp ** [MaxMessageSizeBytes](#API_GetTrafficPolicy_ResponseSyntax) ** The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked. Type: Integer Valid Range: Minimum value of 1. ** [PolicyStatements](#API_GetTrafficPolicy_ResponseSyntax) ** The list of conditions which are in the traffic policy resource. Type: Array of [PolicyStatement](API_PolicyStatement.md) objects ** [TrafficPolicyArn](#API_GetTrafficPolicy_ResponseSyntax) ** The Amazon Resource Name (ARN) of the traffic policy resource. Type: String ** [TrafficPolicyId](#API_GetTrafficPolicy_ResponseSyntax) ** The identifier of the traffic policy resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. ** [TrafficPolicyName](#API_GetTrafficPolicy_ResponseSyntax) ** A user-friendly name for the traffic policy resource. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: `[A-Za-z0-9_\-]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/GetTrafficPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/GetTrafficPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/GetTrafficPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/GetTrafficPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/GetTrafficPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/GetTrafficPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/GetTrafficPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/GetTrafficPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/GetTrafficPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/GetTrafficPolicy) # ListAddonInstances Lists all Add On instances in your account. ## Request Syntax ``` { "NextToken": "string", "PageSize": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NextToken](#API_ListAddonInstances_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PageSize](#API_ListAddonInstances_RequestSyntax) ** The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ## Response Syntax ``` { "AddonInstances": [ { "AddonInstanceArn": "string", "AddonInstanceId": "string", "AddonName": "string", "AddonSubscriptionId": "string", "CreatedTimestamp": number } ], "NextToken": "string" } ``` ## 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. ** [AddonInstances](#API_ListAddonInstances_ResponseSyntax) ** The list of ingress endpoints. Type: Array of [AddonInstance](API_AddonInstance.md) objects ** [NextToken](#API_ListAddonInstances_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/ListAddonInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/ListAddonInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/ListAddonInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/ListAddonInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/ListAddonInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/ListAddonInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/ListAddonInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/ListAddonInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/ListAddonInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/ListAddonInstances) # ListAddonSubscriptions Lists all Add On subscriptions in your account. ## Request Syntax ``` { "NextToken": "string", "PageSize": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NextToken](#API_ListAddonSubscriptions_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PageSize](#API_ListAddonSubscriptions_RequestSyntax) ** The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ## Response Syntax ``` { "AddonSubscriptions": [ { "AddonName": "string", "AddonSubscriptionArn": "string", "AddonSubscriptionId": "string", "CreatedTimestamp": number } ], "NextToken": "string" } ``` ## 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. ** [AddonSubscriptions](#API_ListAddonSubscriptions_ResponseSyntax) ** The list of ingress endpoints. Type: Array of [AddonSubscription](API_AddonSubscription.md) objects ** [NextToken](#API_ListAddonSubscriptions_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/ListAddonSubscriptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/ListAddonSubscriptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/ListAddonSubscriptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/ListAddonSubscriptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/ListAddonSubscriptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/ListAddonSubscriptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/ListAddonSubscriptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/ListAddonSubscriptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/ListAddonSubscriptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/ListAddonSubscriptions) # ListAddressListImportJobs Lists jobs for an address list. ## Request Syntax ``` { "AddressListId": "string", "NextToken": "string", "PageSize": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AddressListId](#API_ListAddressListImportJobs_RequestSyntax) ** The unique identifier of the address list for listing import jobs. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` Required: Yes ** [NextToken](#API_ListAddressListImportJobs_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PageSize](#API_ListAddressListImportJobs_RequestSyntax) ** The maximum number of import jobs that are returned per call. You can use NextToken to retrieve the next page of jobs. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ## Response Syntax ``` { "ImportJobs": [ { "AddressListId": "string", "CompletedTimestamp": number, "CreatedTimestamp": number, "Error": "string", "FailedItemsCount": number, "ImportDataFormat": { "ImportDataType": "string" }, "ImportedItemsCount": number, "JobId": "string", "Name": "string", "PreSignedUrl": "string", "StartTimestamp": number, "Status": "string" } ], "NextToken": "string" } ``` ## 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. ** [ImportJobs](#API_ListAddressListImportJobs_ResponseSyntax) ** The list of import jobs. Type: Array of [ImportJob](API_ImportJob.md) objects ** [NextToken](#API_ListAddressListImportJobs_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/ListAddressListImportJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/ListAddressListImportJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/ListAddressListImportJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/ListAddressListImportJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/ListAddressListImportJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/ListAddressListImportJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/ListAddressListImportJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/ListAddressListImportJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/ListAddressListImportJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/ListAddressListImportJobs) # ListAddressLists Lists address lists for this account. ## Request Syntax ``` { "NextToken": "string", "PageSize": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NextToken](#API_ListAddressLists_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PageSize](#API_ListAddressLists_RequestSyntax) ** The maximum number of address list resources that are returned per call. You can use NextToken to retrieve the next page of address lists. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ## Response Syntax ``` { "AddressLists": [ { "AddressListArn": "string", "AddressListId": "string", "AddressListName": "string", "CreatedTimestamp": number, "LastUpdatedTimestamp": number } ], "NextToken": "string" } ``` ## 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. ** [AddressLists](#API_ListAddressLists_ResponseSyntax) ** The list of address lists. Type: Array of [AddressList](API_AddressList.md) objects ** [NextToken](#API_ListAddressLists_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/ListAddressLists) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/ListAddressLists) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/ListAddressLists) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/ListAddressLists) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/ListAddressLists) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/ListAddressLists) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/ListAddressLists) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/ListAddressLists) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/ListAddressLists) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/ListAddressLists) # ListArchiveExports Returns a list of email archive export jobs. ## Request Syntax ``` { "ArchiveId": "string", "NextToken": "string", "PageSize": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArchiveId](#API_ListArchiveExports_RequestSyntax) ** The identifier of the archive. Type: String Length Constraints: Minimum length of 3. Maximum length of 66. Pattern: `a-[\w]{1,64}` Required: Yes ** [NextToken](#API_ListArchiveExports_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PageSize](#API_ListArchiveExports_RequestSyntax) ** The maximum number of archive export jobs that are returned per call. You can use NextToken to obtain further pages of archives. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ## Response Syntax ``` { "Exports": [ { "ExportId": "string", "Status": { "CompletionTimestamp": number, "ErrorMessage": "string", "State": "string", "SubmissionTimestamp": number } } ], "NextToken": "string" } ``` ## 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. ** [Exports](#API_ListArchiveExports_ResponseSyntax) ** The list of export job identifiers and statuses. Type: Array of [ExportSummary](API_ExportSummary.md) objects ** [NextToken](#API_ListArchiveExports_ResponseSyntax) ** If present, use to retrieve the next page of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/ListArchiveExports) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/ListArchiveExports) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/ListArchiveExports) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/ListArchiveExports) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/ListArchiveExports) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/ListArchiveExports) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/ListArchiveExports) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/ListArchiveExports) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/ListArchiveExports) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/ListArchiveExports) # ListArchives Returns a list of all email archives in your account. ## Request Syntax ``` { "NextToken": "string", "PageSize": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NextToken](#API_ListArchives_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PageSize](#API_ListArchives_RequestSyntax) ** The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ## Response Syntax ``` { "Archives": [ { "ArchiveId": "string", "ArchiveName": "string", "ArchiveState": "string", "LastUpdatedTimestamp": number } ], "NextToken": "string" } ``` ## 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. ** [Archives](#API_ListArchives_ResponseSyntax) ** The list of archive details. Type: Array of [Archive](API_Archive.md) objects ** [NextToken](#API_ListArchives_ResponseSyntax) ** If present, use to retrieve the next page of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/ListArchives) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/ListArchives) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/ListArchives) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/ListArchives) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/ListArchives) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/ListArchives) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/ListArchives) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/ListArchives) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/ListArchives) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/ListArchives) # ListArchiveSearches Returns a list of email archive search jobs. ## Request Syntax ``` { "ArchiveId": "string", "NextToken": "string", "PageSize": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArchiveId](#API_ListArchiveSearches_RequestSyntax) ** The identifier of the archive. Type: String Length Constraints: Minimum length of 3. Maximum length of 66. Pattern: `a-[\w]{1,64}` Required: Yes ** [NextToken](#API_ListArchiveSearches_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PageSize](#API_ListArchiveSearches_RequestSyntax) ** The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ## Response Syntax ``` { "NextToken": "string", "Searches": [ { "SearchId": "string", "Status": { "CompletionTimestamp": number, "ErrorMessage": "string", "State": "string", "SubmissionTimestamp": 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. ** [NextToken](#API_ListArchiveSearches_ResponseSyntax) ** If present, use to retrieve the next page of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ** [Searches](#API_ListArchiveSearches_ResponseSyntax) ** The list of search job identifiers and statuses. Type: Array of [SearchSummary](API_SearchSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/ListArchiveSearches) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/ListArchiveSearches) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/ListArchiveSearches) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/ListArchiveSearches) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/ListArchiveSearches) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/ListArchiveSearches) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/ListArchiveSearches) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/ListArchiveSearches) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/ListArchiveSearches) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/ListArchiveSearches) # ListIngressPoints List all ingress endpoint resources. ## Request Syntax ``` { "NextToken": "string", "PageSize": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NextToken](#API_ListIngressPoints_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PageSize](#API_ListIngressPoints_RequestSyntax) ** The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ## Response Syntax ``` { "IngressPoints": [ { "ARecord": "string", "IngressPointId": "string", "IngressPointName": "string", "Status": "string", "Type": "string" } ], "NextToken": "string" } ``` ## 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. ** [IngressPoints](#API_ListIngressPoints_ResponseSyntax) ** The list of ingress endpoints. Type: Array of [IngressPoint](API_IngressPoint.md) objects ** [NextToken](#API_ListIngressPoints_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/ListIngressPoints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/ListIngressPoints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/ListIngressPoints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/ListIngressPoints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/ListIngressPoints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/ListIngressPoints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/ListIngressPoints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/ListIngressPoints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/ListIngressPoints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/ListIngressPoints) # ListMembersOfAddressList Lists members of an address list. ## Request Syntax ``` { "AddressListId": "string", "Filter": { "AddressPrefix": "string" }, "NextToken": "string", "PageSize": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AddressListId](#API_ListMembersOfAddressList_RequestSyntax) ** The unique identifier of the address list to list the addresses from. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` Required: Yes ** [Filter](#API_ListMembersOfAddressList_RequestSyntax) ** Filter to be used to limit the results. Type: [AddressFilter](API_AddressFilter.md) object Required: No ** [NextToken](#API_ListMembersOfAddressList_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PageSize](#API_ListMembersOfAddressList_RequestSyntax) ** The maximum number of address list members that are returned per call. You can use NextToken to retrieve the next page of members. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No ## Response Syntax ``` { "Addresses": [ { "Address": "string", "CreatedTimestamp": number } ], "NextToken": "string" } ``` ## 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. ** [Addresses](#API_ListMembersOfAddressList_ResponseSyntax) ** The list of addresses. Type: Array of [SavedAddress](API_SavedAddress.md) objects ** [NextToken](#API_ListMembersOfAddressList_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/ListMembersOfAddressList) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/ListMembersOfAddressList) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/ListMembersOfAddressList) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/ListMembersOfAddressList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/ListMembersOfAddressList) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/ListMembersOfAddressList) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/ListMembersOfAddressList) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/ListMembersOfAddressList) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/ListMembersOfAddressList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/ListMembersOfAddressList) # ListRelays Lists all the existing relay resources. ## Request Syntax ``` { "NextToken": "string", "PageSize": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NextToken](#API_ListRelays_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PageSize](#API_ListRelays_RequestSyntax) ** The number of relays to be returned in one request. Type: Integer Required: No ## Response Syntax ``` { "NextToken": "string", "Relays": [ { "LastModifiedTimestamp": number, "RelayId": "string", "RelayName": "string" } ] } ``` ## 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. ** [NextToken](#API_ListRelays_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ** [Relays](#API_ListRelays_ResponseSyntax) ** The list of returned relays. Type: Array of [Relay](API_Relay.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/ListRelays) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/ListRelays) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/ListRelays) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/ListRelays) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/ListRelays) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/ListRelays) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/ListRelays) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/ListRelays) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/ListRelays) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/ListRelays) # ListRuleSets List rule sets for this account. ## Request Syntax ``` { "NextToken": "string", "PageSize": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NextToken](#API_ListRuleSets_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PageSize](#API_ListRuleSets_RequestSyntax) ** The maximum number of rule set resources that are returned per call. You can use NextToken to obtain further rule sets. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ## Response Syntax ``` { "NextToken": "string", "RuleSets": [ { "LastModificationDate": number, "RuleSetId": "string", "RuleSetName": "string" } ] } ``` ## 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. ** [NextToken](#API_ListRuleSets_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ** [RuleSets](#API_ListRuleSets_ResponseSyntax) ** The list of rule sets. Type: Array of [RuleSet](API_RuleSet.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/ListRuleSets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/ListRuleSets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/ListRuleSets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/ListRuleSets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/ListRuleSets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/ListRuleSets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/ListRuleSets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/ListRuleSets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/ListRuleSets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/ListRuleSets) # ListTagsForResource Retrieves the list of tags (keys and values) assigned to the resource. ## Request Syntax ``` { "ResourceArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource to retrieve tags from. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(|-cn|-us-gov|-eusc):ses:[a-z0-9-]{1,20}:[0-9]{12}:(mailmanager-|addon-).+` Required: Yes ## Response Syntax ``` { "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 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. ** [Tags](#API_ListTagsForResource_ResponseSyntax) ** The tags used to organize, track, or control access for the resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/ListTagsForResource) # ListTrafficPolicies List traffic policy resources. ## Request Syntax ``` { "NextToken": "string", "PageSize": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NextToken](#API_ListTrafficPolicies_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PageSize](#API_ListTrafficPolicies_RequestSyntax) ** The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ## Response Syntax ``` { "NextToken": "string", "TrafficPolicies": [ { "DefaultAction": "string", "TrafficPolicyId": "string", "TrafficPolicyName": "string" } ] } ``` ## 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. ** [NextToken](#API_ListTrafficPolicies_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ** [TrafficPolicies](#API_ListTrafficPolicies_ResponseSyntax) ** The list of traffic policies. Type: Array of [TrafficPolicy](API_TrafficPolicy.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/ListTrafficPolicies) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/ListTrafficPolicies) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/ListTrafficPolicies) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/ListTrafficPolicies) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/ListTrafficPolicies) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/ListTrafficPolicies) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/ListTrafficPolicies) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/ListTrafficPolicies) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/ListTrafficPolicies) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/ListTrafficPolicies) # RegisterMemberToAddressList Adds a member to an address list. ## Request Syntax ``` { "Address": "string", "AddressListId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Address](#API_RegisterMemberToAddressList_RequestSyntax) ** The address to be added to the address list. Type: String Length Constraints: Minimum length of 3. Maximum length of 320. Required: Yes ** [AddressListId](#API_RegisterMemberToAddressList_RequestSyntax) ** The unique identifier of the address list where the address should be added. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Occurs when an operation exceeds a predefined service quota or limit. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/RegisterMemberToAddressList) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/RegisterMemberToAddressList) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/RegisterMemberToAddressList) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/RegisterMemberToAddressList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/RegisterMemberToAddressList) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/RegisterMemberToAddressList) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/RegisterMemberToAddressList) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/RegisterMemberToAddressList) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/RegisterMemberToAddressList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/RegisterMemberToAddressList) # StartAddressListImportJob Starts an import job for an address list. ## Request Syntax ``` { "JobId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobId](#API_StartAddressListImportJob_RequestSyntax) ** The identifier of the import job that needs to be started. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Occurs when an operation exceeds a predefined service quota or limit. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/StartAddressListImportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/StartAddressListImportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/StartAddressListImportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/StartAddressListImportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/StartAddressListImportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/StartAddressListImportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/StartAddressListImportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/StartAddressListImportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/StartAddressListImportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/StartAddressListImportJob) # StartArchiveExport Initiates an export of emails from the specified archive. ## Request Syntax ``` { "ArchiveId": "string", "ExportDestinationConfiguration": { ... }, "Filters": { "Include": [ { ... } ], "Unless": [ { ... } ] }, "FromTimestamp": number, "IncludeMetadata": boolean, "MaxResults": number, "ToTimestamp": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArchiveId](#API_StartArchiveExport_RequestSyntax) ** The identifier of the archive to export emails from. Type: String Length Constraints: Minimum length of 3. Maximum length of 66. Pattern: `a-[\w]{1,64}` Required: Yes ** [ExportDestinationConfiguration](#API_StartArchiveExport_RequestSyntax) ** Details on where to deliver the exported email data. Type: [ExportDestinationConfiguration](API_ExportDestinationConfiguration.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [Filters](#API_StartArchiveExport_RequestSyntax) ** Criteria to filter which emails are included in the export. Type: [ArchiveFilters](API_ArchiveFilters.md) object Required: No ** [FromTimestamp](#API_StartArchiveExport_RequestSyntax) ** The start of the timestamp range to include emails from. Type: Timestamp Required: Yes ** [IncludeMetadata](#API_StartArchiveExport_RequestSyntax) ** Whether to include message metadata as JSON files in the export. Type: Boolean Required: No ** [MaxResults](#API_StartArchiveExport_RequestSyntax) ** The maximum number of email items to include in the export. Type: Integer Required: No ** [ToTimestamp](#API_StartArchiveExport_RequestSyntax) ** The end of the timestamp range to include emails from. Type: Timestamp Required: Yes ## Response Syntax ``` { "ExportId": "string" } ``` ## 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. ** [ExportId](#API_StartArchiveExport_ResponseSyntax) ** The unique identifier for the initiated export job. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Occurs when an operation exceeds a predefined service quota or limit. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/StartArchiveExport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/StartArchiveExport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/StartArchiveExport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/StartArchiveExport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/StartArchiveExport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/StartArchiveExport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/StartArchiveExport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/StartArchiveExport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/StartArchiveExport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/StartArchiveExport) # StartArchiveSearch Initiates a search across emails in the specified archive. ## Request Syntax ``` { "ArchiveId": "string", "Filters": { "Include": [ { ... } ], "Unless": [ { ... } ] }, "FromTimestamp": number, "MaxResults": number, "ToTimestamp": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArchiveId](#API_StartArchiveSearch_RequestSyntax) ** The identifier of the archive to search emails in. Type: String Length Constraints: Minimum length of 3. Maximum length of 66. Pattern: `a-[\w]{1,64}` Required: Yes ** [Filters](#API_StartArchiveSearch_RequestSyntax) ** Criteria to filter which emails are included in the search results. Type: [ArchiveFilters](API_ArchiveFilters.md) object Required: No ** [FromTimestamp](#API_StartArchiveSearch_RequestSyntax) ** The start timestamp of the range to search emails from. Type: Timestamp Required: Yes ** [MaxResults](#API_StartArchiveSearch_RequestSyntax) ** The maximum number of search results to return. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1000. Required: Yes ** [ToTimestamp](#API_StartArchiveSearch_RequestSyntax) ** The end timestamp of the range to search emails from. Type: Timestamp Required: Yes ## Response Syntax ``` { "SearchId": "string" } ``` ## 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. ** [SearchId](#API_StartArchiveSearch_ResponseSyntax) ** The unique identifier for the initiated search job. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Occurs when an operation exceeds a predefined service quota or limit. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/StartArchiveSearch) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/StartArchiveSearch) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/StartArchiveSearch) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/StartArchiveSearch) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/StartArchiveSearch) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/StartArchiveSearch) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/StartArchiveSearch) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/StartArchiveSearch) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/StartArchiveSearch) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/StartArchiveSearch) # StopAddressListImportJob Stops an ongoing import job for an address list. ## Request Syntax ``` { "JobId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobId](#API_StopAddressListImportJob_RequestSyntax) ** The identifier of the import job that needs to be stopped. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9-]+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/StopAddressListImportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/StopAddressListImportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/StopAddressListImportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/StopAddressListImportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/StopAddressListImportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/StopAddressListImportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/StopAddressListImportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/StopAddressListImportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/StopAddressListImportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/StopAddressListImportJob) # StopArchiveExport Stops an in-progress export of emails from an archive. ## Request Syntax ``` { "ExportId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ExportId](#API_StopArchiveExport_RequestSyntax) ** The identifier of the export job to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/StopArchiveExport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/StopArchiveExport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/StopArchiveExport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/StopArchiveExport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/StopArchiveExport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/StopArchiveExport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/StopArchiveExport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/StopArchiveExport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/StopArchiveExport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/StopArchiveExport) # StopArchiveSearch Stops an in-progress archive search job. ## Request Syntax ``` { "SearchId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [SearchId](#API_StopArchiveSearch_RequestSyntax) ** The identifier of the search job to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/StopArchiveSearch) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/StopArchiveSearch) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/StopArchiveSearch) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/StopArchiveSearch) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/StopArchiveSearch) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/StopArchiveSearch) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/StopArchiveSearch) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/StopArchiveSearch) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/StopArchiveSearch) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/StopArchiveSearch) # TagResource Adds one or more tags (keys and values) to a specified resource. ## Request Syntax ``` { "ResourceArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ResourceArn](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource that you want to tag. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(|-cn|-us-gov|-eusc):ses:[a-z0-9-]{1,20}:[0-9]{12}:(mailmanager-|addon-).+` Required: Yes ** [Tags](#API_TagResource_RequestSyntax) ** The tags used to organize, track, or control access for the resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Occurs when an operation exceeds a predefined service quota or limit. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/TagResource) # UntagResource Remove one or more tags (keys and values) from a specified resource. ## Request Syntax ``` { "ResourceArn": "string", "TagKeys": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ResourceArn](#API_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource that you want to untag. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(|-cn|-us-gov|-eusc):ses:[a-z0-9-]{1,20}:[0-9]{12}:(mailmanager-|addon-).+` Required: Yes ** [TagKeys](#API_UntagResource_RequestSyntax) ** The keys of the key-value pairs for the tag or tags you want to remove from the specified resource. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9/_\+=\.:@\-]+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/UntagResource) # UpdateArchive Updates the attributes of an existing email archive. ## Request Syntax ``` { "ArchiveId": "string", "ArchiveName": "string", "Retention": { ... } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArchiveId](#API_UpdateArchive_RequestSyntax) ** The identifier of the archive to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 66. Required: Yes ** [ArchiveName](#API_UpdateArchive_RequestSyntax) ** A new, unique name for the archive. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]` Required: No ** [Retention](#API_UpdateArchive_RequestSyntax) ** A new retention period for emails in the archive. Type: [ArchiveRetention](API_ArchiveRetention.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Occurs when a user is denied access to a specific resource or action. HTTP Status Code: 400 ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** ResourceNotFoundException ** Occurs when a requested resource is not found. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Occurs when an operation exceeds a predefined service quota or limit. HTTP Status Code: 400 ** ThrottlingException ** Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/UpdateArchive) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/UpdateArchive) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/UpdateArchive) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/UpdateArchive) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/UpdateArchive) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/UpdateArchive) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/UpdateArchive) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/UpdateArchive) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/UpdateArchive) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/UpdateArchive) # UpdateIngressPoint Update attributes of a provisioned ingress endpoint resource. ## Request Syntax ``` { "IngressPointConfiguration": { ... }, "IngressPointId": "string", "IngressPointName": "string", "RuleSetId": "string", "StatusToUpdate": "string", "TlsPolicy": "string", "TrafficPolicyId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [IngressPointConfiguration](#API_UpdateIngressPoint_RequestSyntax) ** If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN. Type: [IngressPointConfiguration](API_IngressPointConfiguration.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ** [IngressPointId](#API_UpdateIngressPoint_RequestSyntax) ** The identifier for the ingress endpoint you want to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes ** [IngressPointName](#API_UpdateIngressPoint_RequestSyntax) ** A user friendly name for the ingress endpoint resource. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: `[A-Za-z0-9_\-]+` Required: No ** [RuleSetId](#API_UpdateIngressPoint_RequestSyntax) ** The identifier of an existing rule set that you attach to an ingress endpoint resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: No ** [StatusToUpdate](#API_UpdateIngressPoint_RequestSyntax) ** The update status of an ingress endpoint. Type: String Valid Values: `ACTIVE | CLOSED` Required: No ** [TlsPolicy](#API_UpdateIngressPoint_RequestSyntax) ** The Transport Layer Security (TLS) policy for the ingress point. Valid values are REQUIRED, OPTIONAL. Only ingress endpoints using REQUIRED or OPTIONAL as TlsPolicy can be updated. Type: String Valid Values: `REQUIRED | OPTIONAL | FIPS` Required: No ** [TrafficPolicyId](#API_UpdateIngressPoint_RequestSyntax) ** The identifier of an existing traffic policy that you attach to an ingress endpoint resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/UpdateIngressPoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/UpdateIngressPoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/UpdateIngressPoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/UpdateIngressPoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/UpdateIngressPoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/UpdateIngressPoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/UpdateIngressPoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/UpdateIngressPoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/UpdateIngressPoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/UpdateIngressPoint) # UpdateRelay Updates the attributes of an existing relay resource. ## Request Syntax ``` { "Authentication": { ... }, "RelayId": "string", "RelayName": "string", "ServerName": "string", "ServerPort": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Authentication](#API_UpdateRelay_RequestSyntax) ** Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored. Type: [RelayAuthentication](API_RelayAuthentication.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ** [RelayId](#API_UpdateRelay_RequestSyntax) ** The unique relay identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9-]+` Required: Yes ** [RelayName](#API_UpdateRelay_RequestSyntax) ** The name of the relay resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9-_]+` Required: No ** [ServerName](#API_UpdateRelay_RequestSyntax) ** The destination relay server address. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9-\.]+` Required: No ** [ServerPort](#API_UpdateRelay_RequestSyntax) ** The destination relay server port. Type: Integer Valid Range: Minimum value of 1. Maximum value of 65535. Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/UpdateRelay) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/UpdateRelay) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/UpdateRelay) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/UpdateRelay) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/UpdateRelay) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/UpdateRelay) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/UpdateRelay) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/UpdateRelay) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/UpdateRelay) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/UpdateRelay) # UpdateRuleSet Update attributes of an already provisioned rule set. ## Request Syntax ``` { "Rules": [ { "Actions": [ { ... } ], "Conditions": [ { ... } ], "Name": "string", "Unless": [ { ... } ] } ], "RuleSetId": "string", "RuleSetName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Rules](#API_UpdateRuleSet_RequestSyntax) ** A new set of rules to replace the current rules of the rule set—these rules will override all the rules of the rule set. Type: Array of [Rule](API_Rule.md) objects Array Members: Minimum number of 0 items. Maximum number of 40 items. Required: No ** [RuleSetId](#API_UpdateRuleSet_RequestSyntax) ** The identifier of a rule set you want to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes ** [RuleSetName](#API_UpdateRuleSet_RequestSyntax) ** A user-friendly name for the rule set resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/UpdateRuleSet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/UpdateRuleSet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/UpdateRuleSet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/UpdateRuleSet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/UpdateRuleSet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/UpdateRuleSet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/UpdateRuleSet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/UpdateRuleSet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/UpdateRuleSet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/UpdateRuleSet) # UpdateTrafficPolicy Update attributes of an already provisioned traffic policy resource. ## Request Syntax ``` { "DefaultAction": "string", "MaxMessageSizeBytes": number, "PolicyStatements": [ { "Action": "string", "Conditions": [ { ... } ] } ], "TrafficPolicyId": "string", "TrafficPolicyName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DefaultAction](#API_UpdateTrafficPolicy_RequestSyntax) ** Default action instructs the traﬃc policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements Type: String Valid Values: `ALLOW | DENY` Required: No ** [MaxMessageSizeBytes](#API_UpdateTrafficPolicy_RequestSyntax) ** The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked. Type: Integer Valid Range: Minimum value of 1. Required: No ** [PolicyStatements](#API_UpdateTrafficPolicy_RequestSyntax) ** The list of conditions to be updated for filtering email traffic. Type: Array of [PolicyStatement](API_PolicyStatement.md) objects Required: No ** [TrafficPolicyId](#API_UpdateTrafficPolicy_RequestSyntax) ** The identifier of the traffic policy that you want to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes ** [TrafficPolicyName](#API_UpdateTrafficPolicy_RequestSyntax) ** A user-friendly name for the traffic policy resource. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: `[A-Za-z0-9_\-]+` Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** The request configuration has conflicts. For details, see the accompanying error message. HTTP Status Code: 400 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mailmanager-2023-10-17/UpdateTrafficPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mailmanager-2023-10-17/UpdateTrafficPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mailmanager-2023-10-17/UpdateTrafficPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mailmanager-2023-10-17/UpdateTrafficPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mailmanager-2023-10-17/UpdateTrafficPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mailmanager-2023-10-17/UpdateTrafficPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mailmanager-2023-10-17/UpdateTrafficPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mailmanager-2023-10-17/UpdateTrafficPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mailmanager-2023-10-17/UpdateTrafficPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mailmanager-2023-10-17/UpdateTrafficPolicy)