The Amazon SES Mail Manager API contains operations and data types that comprise the Mail Manager feature of Amazon Simple Email Service (SES).
Mail Manager is a set of Amazon SES email gateway features designed to help you strengthen your organization's email infrastructure, simplify email workflow management, and streamline email compliance control. To learn more, see the Mail Manager chapter in the Amazon SES Developer Guide.
", "operations": { "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.
", "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.
", "CreateAddressList": "Creates a new address list.
", "CreateAddressListImportJob": "Creates an import job for an address list.
", "CreateArchive": "Creates a new email archive resource for storing and retaining emails.
", "CreateIngressPoint": "Provision a new ingress endpoint resource.
", "CreateRelay": "Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.
", "CreateRuleSet": "Provision a new rule set.
", "CreateTrafficPolicy": "Provision a new traffic policy resource.
", "DeleteAddonInstance": "Deletes an Add On instance.
", "DeleteAddonSubscription": "Deletes an Add On subscription.
", "DeleteAddressList": "Deletes an address list.
", "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.
", "DeleteIngressPoint": "Delete an ingress endpoint resource.
", "DeleteRelay": "Deletes an existing relay resource.
", "DeleteRuleSet": "Delete a rule set.
", "DeleteTrafficPolicy": "Delete a traffic policy resource.
", "DeregisterMemberFromAddressList": "Removes a member from an address list.
", "GetAddonInstance": "Gets detailed information about an Add On instance.
", "GetAddonSubscription": "Gets detailed information about an Add On subscription.
", "GetAddressList": "Fetch attributes of an address list.
", "GetAddressListImportJob": "Fetch attributes of an import job.
", "GetArchive": "Retrieves the full details and current state of a specified email archive.
", "GetArchiveExport": "Retrieves the details and current status of a specific email archive export job.
", "GetArchiveMessage": "Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.
", "GetArchiveMessageContent": "Returns the textual content of a specific email message stored in the archive. Attachments are not included.
", "GetArchiveSearch": "Retrieves the details and current status of a specific email archive search job.
", "GetArchiveSearchResults": "Returns the results of a completed email archive search job.
", "GetIngressPoint": "Fetch ingress endpoint resource attributes.
", "GetMemberOfAddressList": "Fetch attributes of a member in an address list.
", "GetRelay": "Fetch the relay resource and it's attributes.
", "GetRuleSet": "Fetch attributes of a rule set.
", "GetTrafficPolicy": "Fetch attributes of a traffic policy resource.
", "ListAddonInstances": "Lists all Add On instances in your account.
", "ListAddonSubscriptions": "Lists all Add On subscriptions in your account.
", "ListAddressListImportJobs": "Lists jobs for an address list.
", "ListAddressLists": "Lists address lists for this account.
", "ListArchiveExports": "Returns a list of email archive export jobs.
", "ListArchiveSearches": "Returns a list of email archive search jobs.
", "ListArchives": "Returns a list of all email archives in your account.
", "ListIngressPoints": "List all ingress endpoint resources.
", "ListMembersOfAddressList": "Lists members of an address list.
", "ListRelays": "Lists all the existing relay resources.
", "ListRuleSets": "List rule sets for this account.
", "ListTagsForResource": "Retrieves the list of tags (keys and values) assigned to the resource.
", "ListTrafficPolicies": "List traffic policy resources.
", "RegisterMemberToAddressList": "Adds a member to an address list.
", "StartAddressListImportJob": "Starts an import job for an address list.
", "StartArchiveExport": "Initiates an export of emails from the specified archive.
", "StartArchiveSearch": "Initiates a search across emails in the specified archive.
", "StopAddressListImportJob": "Stops an ongoing import job for an address list.
", "StopArchiveExport": "Stops an in-progress export of emails from an archive.
", "StopArchiveSearch": "Stops an in-progress archive search job.
", "TagResource": "Adds one or more tags (keys and values) to a specified resource.
", "UntagResource": "Remove one or more tags (keys and values) from a specified resource.
", "UpdateArchive": "Updates the attributes of an existing email archive.
", "UpdateIngressPoint": "Update attributes of a provisioned ingress endpoint resource.
", "UpdateRelay": "Updates the attributes of an existing relay resource.
", "UpdateRuleSet": "Update attributes of an already provisioned rule set.
", "UpdateTrafficPolicy": "Update attributes of an already provisioned traffic policy resource.
" }, "shapes": { "AcceptAction": { "base": null, "refs": { "CreateTrafficPolicyRequest$DefaultAction": "Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements
", "GetTrafficPolicyResponse$DefaultAction": "The default action of the traffic policy.
", "PolicyStatement$Action": "The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.
", "TrafficPolicy$DefaultAction": "Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements
", "UpdateTrafficPolicyRequest$DefaultAction": "Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements
" } }, "AccessDeniedException": { "base": "Occurs when a user is denied access to a specific resource or action.
", "refs": {} }, "ActionFailurePolicy": { "base": null, "refs": { "ArchiveAction$ActionFailurePolicy": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified archive has been deleted.
", "DeliverToMailboxAction$ActionFailurePolicy": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the mailbox ARN is no longer valid.
", "DeliverToQBusinessAction$ActionFailurePolicy": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.
A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified relay has been deleted.
", "S3Action$ActionFailurePolicy": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.
", "SendAction$ActionFailurePolicy": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the sendRawEmail API.
", "SnsAction$ActionFailurePolicy": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call the sns:Publish API.
The action to add a header to a message. When executed, this action will add the given header to the message.
", "refs": { "RuleAction$AddHeader": "This action adds a header. This can be used to add arbitrary email headers.
" } }, "AddonInstance": { "base": "An Add On instance represents a specific configuration of an Add On.
", "refs": { "AddonInstances$member": null } }, "AddonInstanceArn": { "base": null, "refs": { "AddonInstance$AddonInstanceArn": "The Amazon Resource Name (ARN) of the Add On instance.
", "GetAddonInstanceResponse$AddonInstanceArn": "The Amazon Resource Name (ARN) of the Add On instance.
" } }, "AddonInstanceId": { "base": null, "refs": { "AddonInstance$AddonInstanceId": "The unique ID of the Add On instance.
", "CreateAddonInstanceResponse$AddonInstanceId": "The unique ID of the Add On instance created by this API.
", "DeleteAddonInstanceRequest$AddonInstanceId": "The Add On instance ID to delete.
", "GetAddonInstanceRequest$AddonInstanceId": "The Add On instance ID to retrieve information for.
" } }, "AddonInstances": { "base": null, "refs": { "ListAddonInstancesResponse$AddonInstances": "The list of ingress endpoints.
" } }, "AddonName": { "base": null, "refs": { "AddonInstance$AddonName": "The name of the Add On for the instance.
", "AddonSubscription$AddonName": "The name of the Add On.
", "CreateAddonSubscriptionRequest$AddonName": "The name of the Add On to subscribe to. You can only have one subscription for each Add On name.
", "GetAddonInstanceResponse$AddonName": "The name of the Add On provider associated to the subscription of the instance.
", "GetAddonSubscriptionResponse$AddonName": "The name of the Add On for the subscription.
" } }, "AddonSubscription": { "base": "A subscription for an Add On representing the acceptance of its terms of use and additional pricing.
", "refs": { "AddonSubscriptions$member": null } }, "AddonSubscriptionArn": { "base": null, "refs": { "AddonSubscription$AddonSubscriptionArn": "The Amazon Resource Name (ARN) of the Add On subscription.
", "GetAddonSubscriptionResponse$AddonSubscriptionArn": "Amazon Resource Name (ARN) for the subscription.
" } }, "AddonSubscriptionId": { "base": null, "refs": { "AddonInstance$AddonSubscriptionId": "The subscription ID for the instance.
", "AddonSubscription$AddonSubscriptionId": "The unique ID of the Add On subscription.
", "CreateAddonInstanceRequest$AddonSubscriptionId": "The unique ID of a previously created subscription that an Add On instance is created for. You can only have one instance per subscription.
", "CreateAddonSubscriptionResponse$AddonSubscriptionId": "The unique ID of the Add On subscription created by this API.
", "DeleteAddonSubscriptionRequest$AddonSubscriptionId": "The Add On subscription ID to delete.
", "GetAddonInstanceResponse$AddonSubscriptionId": "The subscription ID associated to the instance.
", "GetAddonSubscriptionRequest$AddonSubscriptionId": "The Add On subscription ID to retrieve information for.
" } }, "AddonSubscriptions": { "base": null, "refs": { "ListAddonSubscriptionsResponse$AddonSubscriptions": "The list of ingress endpoints.
" } }, "Address": { "base": null, "refs": { "DeregisterMemberFromAddressListRequest$Address": "The address to be removed from the address list.
", "GetMemberOfAddressListRequest$Address": "The address to be retrieved from the address list.
", "GetMemberOfAddressListResponse$Address": "The address retrieved from the address list.
", "RegisterMemberToAddressListRequest$Address": "The address to be added to the address list.
", "SavedAddress$Address": "The email or domain that constitutes the address.
" } }, "AddressFilter": { "base": "Filtering options for ListMembersOfAddressList operation.
", "refs": { "ListMembersOfAddressListRequest$Filter": "Filter to be used to limit the results.
" } }, "AddressList": { "base": "An address list contains a list of emails and domains that are used in MailManager Ingress endpoints and Rules for email management.
", "refs": { "AddressLists$member": null } }, "AddressListArn": { "base": null, "refs": { "AddressList$AddressListArn": "The Amazon Resource Name (ARN) of the address list.
", "GetAddressListResponse$AddressListArn": "The Amazon Resource Name (ARN) of the address list resource.
", "IngressAddressListArnList$member": null, "RuleAddressListArnList$member": null } }, "AddressListId": { "base": null, "refs": { "AddressList$AddressListId": "The identifier of the address list.
", "CreateAddressListImportJobRequest$AddressListId": "The unique identifier of the address list for importing addresses to.
", "CreateAddressListResponse$AddressListId": "The identifier of the created address list.
", "DeleteAddressListRequest$AddressListId": "The identifier of an existing address list resource to delete.
", "DeregisterMemberFromAddressListRequest$AddressListId": "The unique identifier of the address list to remove the address from.
", "GetAddressListImportJobResponse$AddressListId": "The unique identifier of the address list the import job was created for.
", "GetAddressListRequest$AddressListId": "The identifier of an existing address list resource to be retrieved.
", "GetAddressListResponse$AddressListId": "The identifier of the address list resource.
", "GetMemberOfAddressListRequest$AddressListId": "The unique identifier of the address list to retrieve the address from.
", "ImportJob$AddressListId": "The unique identifier of the address list the import job was created for.
", "ListAddressListImportJobsRequest$AddressListId": "The unique identifier of the address list for listing import jobs.
", "ListMembersOfAddressListRequest$AddressListId": "The unique identifier of the address list to list the addresses from.
", "RegisterMemberToAddressListRequest$AddressListId": "The unique identifier of the address list where the address should be added.
" } }, "AddressListName": { "base": null, "refs": { "AddressList$AddressListName": "The user-friendly name of the address list.
", "CreateAddressListRequest$AddressListName": "A user-friendly name for the address list.
", "GetAddressListResponse$AddressListName": "A user-friendly name for the address list resource.
" } }, "AddressLists": { "base": null, "refs": { "ListAddressListsResponse$AddressLists": "The list of address lists.
" } }, "AddressPageSize": { "base": null, "refs": { "ListMembersOfAddressListRequest$PageSize": "The maximum number of address list members that are returned per call. You can use NextToken to retrieve the next page of members.
" } }, "AddressPrefix": { "base": null, "refs": { "AddressFilter$AddressPrefix": "Filter to limit the results to addresses having the provided prefix.
" } }, "Analysis": { "base": "The result of an analysis can be used in conditions to trigger actions. Analyses can inspect the email content and report a certain aspect of the email.
", "refs": { "RuleBooleanToEvaluate$Analysis": "The Add On ARN and its returned value to evaluate in a boolean condition expression.
", "RuleStringToEvaluate$Analysis": "The Add On ARN and its returned value to evaluate in a string condition expression.
", "RuleVerdictToEvaluate$Analysis": "The Add On ARN and its returned value to evaluate in a verdict condition expression.
" } }, "AnalyzerArn": { "base": null, "refs": { "Analysis$Analyzer": "The Amazon Resource Name (ARN) of an Add On.
", "IngressAnalysis$Analyzer": "The Amazon Resource Name (ARN) of an Add On.
" } }, "Archive": { "base": "An archive resource for storing and retaining emails.
", "refs": { "ArchivesList$member": null } }, "ArchiveAction": { "base": "The action to archive the email by delivering the email to an Amazon SES archive.
", "refs": { "RuleAction$Archive": "This action archives the email. This can be used to deliver an email to an archive.
" } }, "ArchiveArn": { "base": null, "refs": { "GetArchiveResponse$ArchiveArn": "The Amazon Resource Name (ARN) of the archive.
" } }, "ArchiveBooleanEmailAttribute": { "base": null, "refs": { "ArchiveBooleanToEvaluate$Attribute": "The name of the email attribute to evaluate.
" } }, "ArchiveBooleanExpression": { "base": "A boolean expression to evaluate email attribute values.
", "refs": { "ArchiveFilterCondition$BooleanExpression": "A boolean expression to evaluate against email attributes.
" } }, "ArchiveBooleanOperator": { "base": null, "refs": { "ArchiveBooleanExpression$Operator": "The boolean operator to use for evaluation.
" } }, "ArchiveBooleanToEvaluate": { "base": "The attribute to evaluate in a boolean expression.
", "refs": { "ArchiveBooleanExpression$Evaluate": "The email attribute value to evaluate.
" } }, "ArchiveFilterCondition": { "base": "A filter condition used to include or exclude emails when exporting from or searching an archive.
", "refs": { "ArchiveFilterConditions$member": null } }, "ArchiveFilterConditions": { "base": null, "refs": { "ArchiveFilters$Include": "The filter conditions for emails to include.
", "ArchiveFilters$Unless": "The filter conditions for emails to exclude.
" } }, "ArchiveFilters": { "base": "A set of filter conditions to include and/or exclude emails.
", "refs": { "GetArchiveExportResponse$Filters": "The criteria used to filter emails included in the export.
", "GetArchiveSearchResponse$Filters": "The criteria used to filter emails included in the search.
", "StartArchiveExportRequest$Filters": "Criteria to filter which emails are included in the export.
", "StartArchiveSearchRequest$Filters": "Criteria to filter which emails are included in the search results.
" } }, "ArchiveId": { "base": null, "refs": { "GetArchiveExportResponse$ArchiveId": "The identifier of the archive the email export was performed from.
", "GetArchiveSearchResponse$ArchiveId": "The identifier of the archive the email search was performed in.
", "ListArchiveExportsRequest$ArchiveId": "The identifier of the archive.
", "ListArchiveSearchesRequest$ArchiveId": "The identifier of the archive.
", "StartArchiveExportRequest$ArchiveId": "The identifier of the archive to export emails from.
", "StartArchiveSearchRequest$ArchiveId": "The identifier of the archive to search emails in.
" } }, "ArchiveIdString": { "base": null, "refs": { "Archive$ArchiveId": "The unique identifier of the archive.
", "CreateArchiveResponse$ArchiveId": "The unique identifier for the newly created archive.
", "DeleteArchiveRequest$ArchiveId": "The identifier of the archive to delete.
", "GetArchiveRequest$ArchiveId": "The identifier of the archive to retrieve.
", "GetArchiveResponse$ArchiveId": "The unique identifier of the archive.
", "UpdateArchiveRequest$ArchiveId": "The identifier of the archive to update.
" } }, "ArchiveNameString": { "base": null, "refs": { "Archive$ArchiveName": "The unique name assigned to the archive.
", "CreateArchiveRequest$ArchiveName": "A unique name for the new archive.
", "GetArchiveResponse$ArchiveName": "The unique name assigned to the archive.
", "UpdateArchiveRequest$ArchiveName": "A new, unique name for the archive.
" } }, "ArchiveRetention": { "base": "The retention policy for an email archive that specifies how long emails are kept before being automatically deleted.
", "refs": { "CreateArchiveRequest$Retention": "The period for retaining emails in the archive before automatic deletion.
", "GetArchiveResponse$Retention": "The retention period for emails in this archive.
", "UpdateArchiveRequest$Retention": "A new retention period for emails in the archive.
" } }, "ArchiveState": { "base": null, "refs": { "Archive$ArchiveState": "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.
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.
The name of the email attribute to evaluate.
" } }, "ArchiveStringExpression": { "base": "A string expression to evaluate an email attribute value against one or more string values.
", "refs": { "ArchiveFilterCondition$StringExpression": "A string expression to evaluate against email attributes.
" } }, "ArchiveStringOperator": { "base": null, "refs": { "ArchiveStringExpression$Operator": "The operator to use when evaluating the string values.
" } }, "ArchiveStringToEvaluate": { "base": "Specifies the email attribute to evaluate in a string expression.
", "refs": { "ArchiveStringExpression$Evaluate": "The attribute of the email to evaluate.
" } }, "ArchivedMessageId": { "base": null, "refs": { "GetArchiveMessageContentRequest$ArchivedMessageId": "The unique identifier of the archived email message.
", "GetArchiveMessageRequest$ArchivedMessageId": "The unique identifier of the archived email message.
", "Row$ArchivedMessageId": "The unique identifier of the archived message.
" } }, "ArchivesList": { "base": null, "refs": { "ListArchivesResponse$Archives": "The list of archive details.
" } }, "Boolean": { "base": null, "refs": { "MessageBody$MessageMalformed": "A flag indicating if the email was malformed.
", "Row$HasAttachments": "A flag indicating if the email has attachments.
", "StartArchiveExportRequest$IncludeMetadata": "Whether to include message metadata as JSON files in the export.
" } }, "ConflictException": { "base": "The request configuration has conflicts. For details, see the accompanying error message.
", "refs": {} }, "CreateAddonInstanceRequest": { "base": null, "refs": {} }, "CreateAddonInstanceResponse": { "base": null, "refs": {} }, "CreateAddonSubscriptionRequest": { "base": null, "refs": {} }, "CreateAddonSubscriptionResponse": { "base": null, "refs": {} }, "CreateAddressListImportJobRequest": { "base": null, "refs": {} }, "CreateAddressListImportJobResponse": { "base": null, "refs": {} }, "CreateAddressListRequest": { "base": null, "refs": {} }, "CreateAddressListResponse": { "base": null, "refs": {} }, "CreateArchiveRequest": { "base": "The request to create a new email archive.
", "refs": {} }, "CreateArchiveResponse": { "base": "The response from creating a new email archive.
", "refs": {} }, "CreateIngressPointRequest": { "base": null, "refs": {} }, "CreateIngressPointResponse": { "base": null, "refs": {} }, "CreateRelayRequest": { "base": null, "refs": {} }, "CreateRelayResponse": { "base": null, "refs": {} }, "CreateRuleSetRequest": { "base": null, "refs": {} }, "CreateRuleSetResponse": { "base": null, "refs": {} }, "CreateTrafficPolicyRequest": { "base": null, "refs": {} }, "CreateTrafficPolicyResponse": { "base": null, "refs": {} }, "DeleteAddonInstanceRequest": { "base": null, "refs": {} }, "DeleteAddonInstanceResponse": { "base": null, "refs": {} }, "DeleteAddonSubscriptionRequest": { "base": null, "refs": {} }, "DeleteAddonSubscriptionResponse": { "base": null, "refs": {} }, "DeleteAddressListRequest": { "base": null, "refs": {} }, "DeleteAddressListResponse": { "base": null, "refs": {} }, "DeleteArchiveRequest": { "base": "The request to initiate deletion of an email archive.
", "refs": {} }, "DeleteArchiveResponse": { "base": "The response indicating if the archive deletion was successfully initiated.
On success, returns an HTTP 200 status code. On failure, returns an error message.
", "refs": {} }, "DeleteIngressPointRequest": { "base": null, "refs": {} }, "DeleteIngressPointResponse": { "base": null, "refs": {} }, "DeleteRelayRequest": { "base": null, "refs": {} }, "DeleteRelayResponse": { "base": null, "refs": {} }, "DeleteRuleSetRequest": { "base": null, "refs": {} }, "DeleteRuleSetResponse": { "base": null, "refs": {} }, "DeleteTrafficPolicyRequest": { "base": null, "refs": {} }, "DeleteTrafficPolicyResponse": { "base": null, "refs": {} }, "DeliverToMailboxAction": { "base": "This action to delivers an email to a mailbox.
", "refs": { "RuleAction$DeliverToMailbox": "This action delivers an email to a WorkMail mailbox.
" } }, "DeliverToQBusinessAction": { "base": "The action to deliver incoming emails to an Amazon Q Business application for indexing.
", "refs": { "RuleAction$DeliverToQBusiness": "This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base.
" } }, "DeregisterMemberFromAddressListRequest": { "base": null, "refs": {} }, "DeregisterMemberFromAddressListResponse": { "base": null, "refs": {} }, "Double": { "base": null, "refs": { "RuleNumberExpression$Value": "The value to evaluate in a numeric condition expression.
" } }, "DropAction": { "base": "This action causes processing to stop and the email to be dropped. If the action applies only to certain recipients, only those recipients are dropped, and processing continues for other recipients.
", "refs": { "RuleAction$Drop": "This action terminates the evaluation of rules in the rule set.
" } }, "EmailAddress": { "base": null, "refs": { "Recipients$member": null } }, "EmailReceivedHeadersList": { "base": null, "refs": { "Row$ReceivedHeaders": "The received headers from the email delivery path.
" } }, "Envelope": { "base": "The SMTP envelope information of the email.
", "refs": { "GetArchiveMessageResponse$Envelope": "The SMTP envelope information of the email.
", "Row$Envelope": "The SMTP envelope information of the email.
" } }, "ErrorMessage": { "base": null, "refs": { "AccessDeniedException$Message": null, "ConflictException$Message": null, "ExportStatus$ErrorMessage": "An error message if the export job failed.
", "GetAddressListImportJobResponse$Error": "The reason for failure of an import job.
", "ImportJob$Error": "The reason for failure of an import job.
", "ResourceNotFoundException$Message": null, "SearchStatus$ErrorMessage": "An error message if the search failed.
", "ServiceQuotaExceededException$Message": null, "ThrottlingException$Message": null, "ValidationException$Message": null } }, "ExportDestinationConfiguration": { "base": "The destination configuration for delivering exported email data.
", "refs": { "GetArchiveExportResponse$ExportDestinationConfiguration": "Where the exported emails are being delivered.
", "StartArchiveExportRequest$ExportDestinationConfiguration": "Details on where to deliver the exported email data.
" } }, "ExportId": { "base": null, "refs": { "ExportSummary$ExportId": "The unique identifier of the export job.
", "GetArchiveExportRequest$ExportId": "The identifier of the export job to get details for.
", "StartArchiveExportResponse$ExportId": "The unique identifier for the initiated export job.
", "StopArchiveExportRequest$ExportId": "The identifier of the export job to stop.
" } }, "ExportMaxResults": { "base": null, "refs": { "GetArchiveExportResponse$MaxResults": "The maximum number of email items included in the export.
", "StartArchiveExportRequest$MaxResults": "The maximum number of email items to include in the export.
" } }, "ExportState": { "base": null, "refs": { "ExportStatus$State": "The current state of the export job.
" } }, "ExportStatus": { "base": "The current status of an archive export job.
", "refs": { "ExportSummary$Status": "The current status of the export job.
", "GetArchiveExportResponse$Status": "The current status of the export job.
" } }, "ExportSummary": { "base": "Summary statuses of an archive export job.
", "refs": { "ExportSummaryList$member": null } }, "ExportSummaryList": { "base": null, "refs": { "ListArchiveExportsResponse$Exports": "The list of export job identifiers and statuses.
" } }, "GetAddonInstanceRequest": { "base": null, "refs": {} }, "GetAddonInstanceResponse": { "base": null, "refs": {} }, "GetAddonSubscriptionRequest": { "base": null, "refs": {} }, "GetAddonSubscriptionResponse": { "base": null, "refs": {} }, "GetAddressListImportJobRequest": { "base": null, "refs": {} }, "GetAddressListImportJobResponse": { "base": null, "refs": {} }, "GetAddressListRequest": { "base": null, "refs": {} }, "GetAddressListResponse": { "base": null, "refs": {} }, "GetArchiveExportRequest": { "base": "The request to retrieve details of a specific archive export job.
", "refs": {} }, "GetArchiveExportResponse": { "base": "The response containing details of the specified archive export job.
", "refs": {} }, "GetArchiveMessageContentRequest": { "base": "The request to get the textual content of a specific email message stored in an archive.
", "refs": {} }, "GetArchiveMessageContentResponse": { "base": "The response containing the textual content of the requested archived email message.
", "refs": {} }, "GetArchiveMessageRequest": { "base": "The request to get details of a specific email message stored in an archive.
", "refs": {} }, "GetArchiveMessageResponse": { "base": "The response containing details about the requested archived email message.
", "refs": {} }, "GetArchiveRequest": { "base": "The request to retrieve details of an email archive.
", "refs": {} }, "GetArchiveResponse": { "base": "The response containing details of the requested archive.
", "refs": {} }, "GetArchiveSearchRequest": { "base": "The request to retrieve details of a specific archive search job.
", "refs": {} }, "GetArchiveSearchResponse": { "base": "The response containing details of the specified archive search job.
", "refs": {} }, "GetArchiveSearchResultsRequest": { "base": "The request to retrieve results from a completed archive search job.
", "refs": {} }, "GetArchiveSearchResultsResponse": { "base": "The response containing search results from a completed archive search.
", "refs": {} }, "GetIngressPointRequest": { "base": null, "refs": {} }, "GetIngressPointResponse": { "base": null, "refs": {} }, "GetMemberOfAddressListRequest": { "base": null, "refs": {} }, "GetMemberOfAddressListResponse": { "base": null, "refs": {} }, "GetRelayRequest": { "base": null, "refs": {} }, "GetRelayResponse": { "base": null, "refs": {} }, "GetRuleSetRequest": { "base": null, "refs": {} }, "GetRuleSetResponse": { "base": null, "refs": {} }, "GetTrafficPolicyRequest": { "base": null, "refs": {} }, "GetTrafficPolicyResponse": { "base": null, "refs": {} }, "HeaderName": { "base": null, "refs": { "AddHeaderAction$HeaderName": "The name of the header to add to an email. The header must be prefixed with \"X-\". Headers are added regardless of whether the header name pre-existed in the email.
" } }, "HeaderValue": { "base": null, "refs": { "AddHeaderAction$HeaderValue": "The value of the header to add to the email.
" } }, "IamRoleArn": { "base": null, "refs": { "DeliverToMailboxAction$RoleArn": "The Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to the workmail:DeliverToMailbox API.
", "DeliverToQBusinessAction$RoleArn": "The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the qbusiness:BatchPutDocument API for the given application and index.
The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.
", "SendAction$RoleArn": "The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API.
", "SnsAction$RoleArn": "The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS. This role must have access to the sns:Publish API for the given topic.
The identifier of the relay resource to be used when relaying an email.
" } }, "IdempotencyToken": { "base": null, "refs": { "CreateAddonInstanceRequest$ClientToken": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "CreateAddonSubscriptionRequest$ClientToken": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "CreateAddressListImportJobRequest$ClientToken": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "CreateAddressListRequest$ClientToken": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "CreateArchiveRequest$ClientToken": "A unique token Amazon SES uses to recognize retries of this request.
", "CreateIngressPointRequest$ClientToken": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "CreateRelayRequest$ClientToken": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "CreateRuleSetRequest$ClientToken": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "CreateTrafficPolicyRequest$ClientToken": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
" } }, "ImportDataFormat": { "base": "The import data format contains the specifications of the input file that would be passed to the address list import job.
", "refs": { "CreateAddressListImportJobRequest$ImportDataFormat": "The format of the input for an import job.
", "GetAddressListImportJobResponse$ImportDataFormat": "The format of the input for an import job.
", "ImportJob$ImportDataFormat": "The format of the input for the import job.
" } }, "ImportDataType": { "base": null, "refs": { "ImportDataFormat$ImportDataType": "The type of file that would be passed as an input for the address list import job.
" } }, "ImportJob": { "base": "Details about an import job.
", "refs": { "ImportJobs$member": null } }, "ImportJobStatus": { "base": null, "refs": { "GetAddressListImportJobResponse$Status": "The status of the import job.
", "ImportJob$Status": "The status of the import job.
" } }, "ImportJobs": { "base": null, "refs": { "ListAddressListImportJobsResponse$ImportJobs": "The list of import jobs.
" } }, "IngressAddressListArnList": { "base": null, "refs": { "IngressIsInAddressList$AddressLists": "The address lists that will be used for evaluation.
" } }, "IngressAddressListEmailAttribute": { "base": null, "refs": { "IngressIsInAddressList$Attribute": "The email attribute that needs to be evaluated against the address list.
" } }, "IngressAnalysis": { "base": "The Add On ARN and its returned value that is evaluated in a policy statement's conditional expression to either deny or block the incoming email.
", "refs": { "IngressBooleanToEvaluate$Analysis": "The structure type for a boolean condition stating the Add On ARN and its returned value.
", "IngressStringToEvaluate$Analysis": "The structure type for a string condition stating the Add On ARN and its returned value.
" } }, "IngressBooleanExpression": { "base": "The structure for a boolean condition matching on the incoming mail.
", "refs": { "PolicyCondition$BooleanExpression": "This represents a boolean type condition matching on the incoming mail. It performs the boolean operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.
" } }, "IngressBooleanOperator": { "base": null, "refs": { "IngressBooleanExpression$Operator": "The matching operator for a boolean condition expression.
" } }, "IngressBooleanToEvaluate": { "base": "The union type representing the allowed types of operands for a boolean condition.
", "refs": { "IngressBooleanExpression$Evaluate": "The operand on which to perform a boolean condition operation.
" } }, "IngressIpOperator": { "base": null, "refs": { "IngressIpv4Expression$Operator": "The matching operator for an IP condition expression.
", "IngressIpv6Expression$Operator": "The matching operator for an IPv6 condition expression.
" } }, "IngressIpToEvaluate": { "base": "The structure for an IP based condition matching on the incoming mail.
", "refs": { "IngressIpv4Expression$Evaluate": "The left hand side argument of an IP condition expression.
" } }, "IngressIpv4Attribute": { "base": null, "refs": { "IngressIpToEvaluate$Attribute": "An enum type representing the allowed attribute types for an IP condition.
" } }, "IngressIpv4Expression": { "base": "The union type representing the allowed types for the left hand side of an IP condition.
", "refs": { "PolicyCondition$IpExpression": "This represents an IP based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.
" } }, "IngressIpv6Attribute": { "base": null, "refs": { "IngressIpv6ToEvaluate$Attribute": "An enum type representing the allowed attribute types for an IPv6 condition.
" } }, "IngressIpv6Expression": { "base": "The union type representing the allowed types for the left hand side of an IPv6 condition.
", "refs": { "PolicyCondition$Ipv6Expression": "This represents an IPv6 based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.
" } }, "IngressIpv6ToEvaluate": { "base": "The structure for an IPv6 based condition matching on the incoming mail.
", "refs": { "IngressIpv6Expression$Evaluate": "The left hand side argument of an IPv6 condition expression.
" } }, "IngressIsInAddressList": { "base": "The address lists and the address list attribute value that is evaluated in a policy statement's conditional expression to either deny or block the incoming email.
", "refs": { "IngressBooleanToEvaluate$IsInAddressList": "The structure type for a boolean condition that provides the address lists to evaluate incoming traffic on.
" } }, "IngressPoint": { "base": "The structure of an ingress endpoint resource.
", "refs": { "IngressPointsList$member": null } }, "IngressPointARecord": { "base": null, "refs": { "GetIngressPointResponse$ARecord": "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.
", "IngressPoint$ARecord": "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.
" } }, "IngressPointArn": { "base": null, "refs": { "GetIngressPointResponse$IngressPointArn": "The Amazon Resource Name (ARN) of the ingress endpoint resource.
" } }, "IngressPointAuthConfiguration": { "base": "The authentication configuration for the ingress endpoint resource.
", "refs": { "GetIngressPointResponse$IngressPointAuthConfiguration": "The authentication configuration of the ingress endpoint resource.
" } }, "IngressPointConfiguration": { "base": "The configuration of the ingress endpoint resource.
", "refs": { "CreateIngressPointRequest$IngressPointConfiguration": "If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
", "UpdateIngressPointRequest$IngressPointConfiguration": "If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
" } }, "IngressPointId": { "base": null, "refs": { "CreateIngressPointResponse$IngressPointId": "The unique identifier for a previously created ingress endpoint.
", "DeleteIngressPointRequest$IngressPointId": "The identifier of the ingress endpoint resource that you want to delete.
", "GetIngressPointRequest$IngressPointId": "The identifier of an ingress endpoint.
", "GetIngressPointResponse$IngressPointId": "The identifier of an ingress endpoint resource.
", "IngressPoint$IngressPointId": "The identifier of the ingress endpoint resource.
", "Metadata$IngressPointId": "The ID of the ingress endpoint through which the email was received.
", "Row$IngressPointId": "The ID of the ingress endpoint through which the email was received.
", "UpdateIngressPointRequest$IngressPointId": "The identifier for the ingress endpoint you want to update.
" } }, "IngressPointName": { "base": null, "refs": { "CreateIngressPointRequest$IngressPointName": "A user friendly name for an ingress endpoint resource.
", "GetIngressPointResponse$IngressPointName": "A user friendly name for the ingress endpoint.
", "IngressPoint$IngressPointName": "A user friendly name for the ingress endpoint resource.
", "UpdateIngressPointRequest$IngressPointName": "A user friendly name for the ingress endpoint resource.
" } }, "IngressPointPasswordConfiguration": { "base": "The password configuration of the ingress endpoint resource.
", "refs": { "IngressPointAuthConfiguration$IngressPointPasswordConfiguration": "The ingress endpoint password configuration for the ingress endpoint resource.
" } }, "IngressPointStatus": { "base": null, "refs": { "GetIngressPointResponse$Status": "The status of the ingress endpoint resource.
", "IngressPoint$Status": "The status of the ingress endpoint resource.
" } }, "IngressPointStatusToUpdate": { "base": null, "refs": { "UpdateIngressPointRequest$StatusToUpdate": "The update status of an ingress endpoint.
" } }, "IngressPointType": { "base": null, "refs": { "CreateIngressPointRequest$Type": "The type of the ingress endpoint to create.
", "GetIngressPointResponse$Type": "The type of ingress endpoint.
", "IngressPoint$Type": "The type of ingress endpoint resource.
" } }, "IngressPointsList": { "base": null, "refs": { "ListIngressPointsResponse$IngressPoints": "The list of ingress endpoints.
" } }, "IngressStringEmailAttribute": { "base": null, "refs": { "IngressStringToEvaluate$Attribute": "The enum type representing the allowed attribute types for a string condition.
" } }, "IngressStringExpression": { "base": "The structure for a string based condition matching on the incoming mail.
", "refs": { "PolicyCondition$StringExpression": "This represents a string based condition matching on the incoming mail. It performs the string operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.
" } }, "IngressStringOperator": { "base": null, "refs": { "IngressStringExpression$Operator": "The matching operator for a string condition expression.
" } }, "IngressStringToEvaluate": { "base": "The union type representing the allowed types for the left hand side of a string condition.
", "refs": { "IngressStringExpression$Evaluate": "The left hand side argument of a string condition expression.
" } }, "IngressTlsAttribute": { "base": null, "refs": { "IngressTlsProtocolToEvaluate$Attribute": "The enum type representing the allowed attribute types for the TLS condition.
" } }, "IngressTlsProtocolAttribute": { "base": null, "refs": { "IngressTlsProtocolExpression$Value": "The right hand side argument of a TLS condition expression.
" } }, "IngressTlsProtocolExpression": { "base": "The structure for a TLS related condition matching on the incoming mail.
", "refs": { "PolicyCondition$TlsExpression": "This represents a TLS based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.
" } }, "IngressTlsProtocolOperator": { "base": null, "refs": { "IngressTlsProtocolExpression$Operator": "The matching operator for a TLS condition expression.
" } }, "IngressTlsProtocolToEvaluate": { "base": "The union type representing the allowed types for the left hand side of a TLS condition.
", "refs": { "IngressTlsProtocolExpression$Evaluate": "The left hand side argument of a TLS condition expression.
" } }, "Integer": { "base": null, "refs": { "ListRelaysRequest$PageSize": "The number of relays to be returned in one request.
" } }, "IpType": { "base": null, "refs": { "PublicNetworkConfiguration$IpType": "The IP address type for the public ingress point. Valid values are IPV4 and DUAL_STACK.
" } }, "Ipv4Cidr": { "base": null, "refs": { "Ipv4Cidrs$member": null } }, "Ipv4Cidrs": { "base": null, "refs": { "IngressIpv4Expression$Values": "The right hand side argument of an IP condition expression.
" } }, "Ipv6Cidr": { "base": null, "refs": { "Ipv6Cidrs$member": null } }, "Ipv6Cidrs": { "base": null, "refs": { "IngressIpv6Expression$Values": "The right hand side argument of an IPv6 condition expression.
" } }, "JobId": { "base": null, "refs": { "CreateAddressListImportJobResponse$JobId": "The identifier of the created import job.
", "GetAddressListImportJobRequest$JobId": "The identifier of the import job that needs to be retrieved.
", "GetAddressListImportJobResponse$JobId": "The identifier of the import job.
", "ImportJob$JobId": "The identifier of the import job.
", "StartAddressListImportJobRequest$JobId": "The identifier of the import job that needs to be started.
", "StopAddressListImportJobRequest$JobId": "The identifier of the import job that needs to be stopped.
" } }, "JobItemsCount": { "base": null, "refs": { "GetAddressListImportJobResponse$ImportedItemsCount": "The number of input addresses successfully imported into the address list.
", "GetAddressListImportJobResponse$FailedItemsCount": "The number of input addresses that failed to be imported into the address list.
", "ImportJob$ImportedItemsCount": "The number of addresses in the input that were successfully imported into the address list.
", "ImportJob$FailedItemsCount": "The number of addresses in the input that failed to get imported into address list.
" } }, "JobName": { "base": null, "refs": { "CreateAddressListImportJobRequest$Name": "A user-friendly name for the import job.
", "GetAddressListImportJobResponse$Name": "A user-friendly name for the import job.
", "ImportJob$Name": "A user-friendly name for the import job.
" } }, "KmsKeyArn": { "base": null, "refs": { "CreateArchiveRequest$KmsKeyArn": "The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
", "GetArchiveResponse$KmsKeyArn": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.
" } }, "KmsKeyId": { "base": null, "refs": { "S3Action$S3SseKmsKeyId": "The KMS Key ID to use to encrypt the message in S3.
" } }, "ListAddonInstancesRequest": { "base": null, "refs": {} }, "ListAddonInstancesResponse": { "base": null, "refs": {} }, "ListAddonSubscriptionsRequest": { "base": null, "refs": {} }, "ListAddonSubscriptionsResponse": { "base": null, "refs": {} }, "ListAddressListImportJobsRequest": { "base": null, "refs": {} }, "ListAddressListImportJobsResponse": { "base": null, "refs": {} }, "ListAddressListsRequest": { "base": null, "refs": {} }, "ListAddressListsResponse": { "base": null, "refs": {} }, "ListArchiveExportsRequest": { "base": "The request to list archive export jobs in your account.
", "refs": {} }, "ListArchiveExportsResponse": { "base": "The response containing a list of archive export jobs and their statuses.
", "refs": {} }, "ListArchiveSearchesRequest": { "base": "The request to list archive search jobs in your account.
", "refs": {} }, "ListArchiveSearchesResponse": { "base": "The response containing a list of archive search jobs and their statuses.
", "refs": {} }, "ListArchivesRequest": { "base": "The request to list email archives in your account.
", "refs": {} }, "ListArchivesResponse": { "base": "The response containing a list of your email archives.
", "refs": {} }, "ListIngressPointsRequest": { "base": null, "refs": {} }, "ListIngressPointsResponse": { "base": null, "refs": {} }, "ListMembersOfAddressListRequest": { "base": null, "refs": {} }, "ListMembersOfAddressListResponse": { "base": null, "refs": {} }, "ListRelaysRequest": { "base": null, "refs": {} }, "ListRelaysResponse": { "base": null, "refs": {} }, "ListRuleSetsRequest": { "base": null, "refs": {} }, "ListRuleSetsResponse": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "ListTrafficPoliciesRequest": { "base": null, "refs": {} }, "ListTrafficPoliciesResponse": { "base": null, "refs": {} }, "MailFrom": { "base": null, "refs": { "RelayAction$MailFrom": "This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server.
" } }, "MaxMessageSizeBytes": { "base": null, "refs": { "CreateTrafficPolicyRequest$MaxMessageSizeBytes": "The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
", "GetTrafficPolicyResponse$MaxMessageSizeBytes": "The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
", "UpdateTrafficPolicyRequest$MaxMessageSizeBytes": "The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
" } }, "MessageBody": { "base": "The textual body content of an email message.
", "refs": { "GetArchiveMessageContentResponse$Body": "The textual body content of the email message.
" } }, "Metadata": { "base": "The metadata about the email.
", "refs": { "GetArchiveMessageResponse$Metadata": "The metadata about the email.
" } }, "MimeHeaderAttribute": { "base": null, "refs": { "RuleStringToEvaluate$MimeHeaderAttribute": "The email MIME X-Header attribute to evaluate in a string condition expression.
" } }, "NameOrArn": { "base": null, "refs": { "ArchiveAction$TargetArchive": "The identifier of the archive to send the email to.
", "DeliverToMailboxAction$MailboxArn": "The Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to.
" } }, "NetworkConfiguration": { "base": "The network type (IPv4-only, Dual-Stack, PrivateLink) of the ingress endpoint resource.
", "refs": { "CreateIngressPointRequest$NetworkConfiguration": "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.
", "GetIngressPointResponse$NetworkConfiguration": "The network configuration for the ingress point.
" } }, "NoAuthentication": { "base": "Explicitly indicate that the relay destination server does not require SMTP credential authentication.
", "refs": { "RelayAuthentication$NoAuthentication": "Keep an empty structure if the relay destination server does not require SMTP credential authentication.
" } }, "PageSize": { "base": null, "refs": { "ListAddonInstancesRequest$PageSize": "The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
", "ListAddonSubscriptionsRequest$PageSize": "The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
", "ListAddressListImportJobsRequest$PageSize": "The maximum number of import jobs that are returned per call. You can use NextToken to retrieve the next page of jobs.
", "ListAddressListsRequest$PageSize": "The maximum number of address list resources that are returned per call. You can use NextToken to retrieve the next page of address lists.
", "ListArchiveExportsRequest$PageSize": "The maximum number of archive export jobs that are returned per call. You can use NextToken to obtain further pages of archives.
", "ListArchiveSearchesRequest$PageSize": "The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives.
", "ListArchivesRequest$PageSize": "The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives.
", "ListIngressPointsRequest$PageSize": "The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
", "ListRuleSetsRequest$PageSize": "The maximum number of rule set resources that are returned per call. You can use NextToken to obtain further rule sets.
", "ListTrafficPoliciesRequest$PageSize": "The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.
" } }, "PaginationToken": { "base": null, "refs": { "ListAddonInstancesRequest$NextToken": "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.
", "ListAddonInstancesResponse$NextToken": "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.
", "ListAddonSubscriptionsRequest$NextToken": "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.
", "ListAddonSubscriptionsResponse$NextToken": "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.
", "ListAddressListImportJobsRequest$NextToken": "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.
", "ListAddressListImportJobsResponse$NextToken": "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.
", "ListAddressListsRequest$NextToken": "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.
", "ListAddressListsResponse$NextToken": "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.
", "ListArchiveExportsRequest$NextToken": "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.
", "ListArchiveExportsResponse$NextToken": "If present, use to retrieve the next page of results.
", "ListArchiveSearchesRequest$NextToken": "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.
", "ListArchiveSearchesResponse$NextToken": "If present, use to retrieve the next page of results.
", "ListArchivesRequest$NextToken": "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.
", "ListArchivesResponse$NextToken": "If present, use to retrieve the next page of results.
", "ListIngressPointsRequest$NextToken": "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.
", "ListIngressPointsResponse$NextToken": "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.
", "ListMembersOfAddressListRequest$NextToken": "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.
", "ListMembersOfAddressListResponse$NextToken": "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.
", "ListRelaysRequest$NextToken": "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.
", "ListRelaysResponse$NextToken": "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.
", "ListRuleSetsRequest$NextToken": "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.
", "ListRuleSetsResponse$NextToken": "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.
", "ListTrafficPoliciesRequest$NextToken": "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.
", "ListTrafficPoliciesResponse$NextToken": "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.
" } }, "PolicyCondition": { "base": "The email traffic filtering conditions which are contained in a traffic policy resource.
", "refs": { "PolicyConditions$member": null } }, "PolicyConditions": { "base": null, "refs": { "PolicyStatement$Conditions": "The list of conditions to apply to incoming messages for filtering email traffic.
" } }, "PolicyStatement": { "base": "The structure containing traffic policy conditions and actions.
", "refs": { "PolicyStatementList$member": null } }, "PolicyStatementList": { "base": null, "refs": { "CreateTrafficPolicyRequest$PolicyStatements": "Conditional statements for filtering email traffic.
", "GetTrafficPolicyResponse$PolicyStatements": "The list of conditions which are in the traffic policy resource.
", "UpdateTrafficPolicyRequest$PolicyStatements": "The list of conditions to be updated for filtering email traffic.
" } }, "PreSignedUrl": { "base": null, "refs": { "CreateAddressListImportJobResponse$PreSignedUrl": "The pre-signed URL target for uploading the input file.
", "GetAddressListImportJobResponse$PreSignedUrl": "The pre-signed URL target for uploading the input file.
", "ImportJob$PreSignedUrl": "The pre-signed URL target for uploading the input file.
" } }, "PrivateNetworkConfiguration": { "base": "Specifies the network configuration for the private ingress point.
", "refs": { "NetworkConfiguration$PrivateNetworkConfiguration": "Specifies the network configuration for the private ingress point.
" } }, "PublicNetworkConfiguration": { "base": "Specifies the network configuration for the public ingress point.
", "refs": { "NetworkConfiguration$PublicNetworkConfiguration": "Specifies the network configuration for the public ingress point.
" } }, "QBusinessApplicationId": { "base": null, "refs": { "DeliverToQBusinessAction$ApplicationId": "The unique identifier of the Amazon Q Business application instance where the email content will be delivered.
" } }, "QBusinessIndexId": { "base": null, "refs": { "DeliverToQBusinessAction$IndexId": "The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.
" } }, "Recipients": { "base": null, "refs": { "ReplaceRecipientAction$ReplaceWith": "This action specifies the replacement recipient email addresses to insert.
" } }, "RegisterMemberToAddressListRequest": { "base": null, "refs": {} }, "RegisterMemberToAddressListResponse": { "base": null, "refs": {} }, "Relay": { "base": "The relay resource that can be used as a rule to relay receiving emails to the destination relay server.
", "refs": { "Relays$member": null } }, "RelayAction": { "base": "The action relays the email via SMTP to another specific SMTP server.
", "refs": { "RuleAction$Relay": "This action relays the email to another SMTP server.
" } }, "RelayArn": { "base": null, "refs": { "GetRelayResponse$RelayArn": "The Amazon Resource Name (ARN) of the relay.
" } }, "RelayAuthentication": { "base": "Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored, or specify an empty NoAuthentication structure if the relay destination server does not require SMTP credential authentication.
", "refs": { "CreateRelayRequest$Authentication": "Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.
", "GetRelayResponse$Authentication": "The authentication attribute—contains the secret ARN where the customer relay server credentials are stored.
", "UpdateRelayRequest$Authentication": "Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.
" } }, "RelayId": { "base": null, "refs": { "CreateRelayResponse$RelayId": "A unique identifier of the created relay resource.
", "DeleteRelayRequest$RelayId": "The unique relay identifier.
", "GetRelayRequest$RelayId": "A unique relay identifier.
", "GetRelayResponse$RelayId": "The unique relay identifier.
", "Relay$RelayId": "The unique relay identifier.
", "UpdateRelayRequest$RelayId": "The unique relay identifier.
" } }, "RelayName": { "base": null, "refs": { "CreateRelayRequest$RelayName": "The unique name of the relay resource.
", "GetRelayResponse$RelayName": "The unique name of the relay.
", "Relay$RelayName": "The unique relay name.
", "UpdateRelayRequest$RelayName": "The name of the relay resource.
" } }, "RelayServerName": { "base": null, "refs": { "CreateRelayRequest$ServerName": "The destination relay server address.
", "GetRelayResponse$ServerName": "The destination relay server address.
", "UpdateRelayRequest$ServerName": "The destination relay server address.
" } }, "RelayServerPort": { "base": null, "refs": { "CreateRelayRequest$ServerPort": "The destination relay server port.
", "GetRelayResponse$ServerPort": "The destination relay server port.
", "UpdateRelayRequest$ServerPort": "The destination relay server port.
" } }, "Relays": { "base": null, "refs": { "ListRelaysResponse$Relays": "The list of returned relays.
" } }, "ReplaceRecipientAction": { "base": "This action replaces the email envelope recipients with the given list of recipients. If the condition of this action applies only to a subset of recipients, only those recipients are replaced with the recipients specified in the action. The message contents and headers are unaffected by this action, only the envelope recipients are updated.
", "refs": { "RuleAction$ReplaceRecipient": "The action replaces certain or all recipients with a different set of recipients.
" } }, "ResourceNotFoundException": { "base": "Occurs when a requested resource is not found.
", "refs": {} }, "ResultField": { "base": null, "refs": { "Analysis$ResultField": "The returned value from an Add On.
", "IngressAnalysis$ResultField": "The returned value from an Add On.
" } }, "RetentionPeriod": { "base": null, "refs": { "ArchiveRetention$RetentionPeriod": "The enum value sets the period for retaining emails in an archive.
" } }, "Row": { "base": "A result row containing metadata for an archived email message.
", "refs": { "RowsList$member": null } }, "RowsList": { "base": null, "refs": { "GetArchiveSearchResultsResponse$Rows": "The list of email result objects matching the search criteria.
" } }, "Rule": { "base": "A rule contains conditions, \"unless conditions\" and actions. For each envelope recipient of an email, if all conditions match and none of the \"unless conditions\" match, then all of the actions are executed sequentially. If no conditions are provided, the rule always applies and the actions are implicitly executed. If only \"unless conditions\" are provided, the rule applies if the email does not match the evaluation of the \"unless conditions\".
", "refs": { "Rules$member": null } }, "RuleAction": { "base": "The action for a rule to take. Only one of the contained actions can be set.
", "refs": { "RuleActions$member": null } }, "RuleActions": { "base": null, "refs": { "Rule$Actions": "The list of actions to execute when the conditions match the incoming email, and none of the \"unless conditions\" match.
" } }, "RuleAddressListArnList": { "base": null, "refs": { "RuleIsInAddressList$AddressLists": "The address lists that will be used for evaluation.
" } }, "RuleAddressListEmailAttribute": { "base": null, "refs": { "RuleIsInAddressList$Attribute": "The email attribute that needs to be evaluated against the address list.
" } }, "RuleBooleanEmailAttribute": { "base": null, "refs": { "RuleBooleanToEvaluate$Attribute": "The boolean type representing the allowed attribute types for an email.
" } }, "RuleBooleanExpression": { "base": "A boolean expression to be used in a rule condition.
", "refs": { "RuleCondition$BooleanExpression": "The condition applies to a boolean expression passed in this field.
" } }, "RuleBooleanOperator": { "base": null, "refs": { "RuleBooleanExpression$Operator": "The matching operator for a boolean condition expression.
" } }, "RuleBooleanToEvaluate": { "base": "The union type representing the allowed types of operands for a boolean condition.
", "refs": { "RuleBooleanExpression$Evaluate": "The operand on which to perform a boolean condition operation.
" } }, "RuleCondition": { "base": "The conditional expression used to evaluate an email for determining if a rule action should be taken.
", "refs": { "RuleConditions$member": null } }, "RuleConditions": { "base": null, "refs": { "Rule$Conditions": "The conditions of this rule. All conditions must match the email for the actions to be executed. An empty list of conditions means that all emails match, but are still subject to any \"unless conditions\"
", "Rule$Unless": "The \"unless conditions\" of this rule. None of the conditions can match the email for the actions to be executed. If any of these conditions do match the email, then the actions are not executed.
" } }, "RuleDmarcExpression": { "base": "A DMARC policy expression. The condition matches if the given DMARC policy matches that of the incoming email.
", "refs": { "RuleCondition$DmarcExpression": "The condition applies to a DMARC policy expression passed in this field.
" } }, "RuleDmarcOperator": { "base": null, "refs": { "RuleDmarcExpression$Operator": "The operator to apply to the DMARC policy of the incoming email.
" } }, "RuleDmarcPolicy": { "base": null, "refs": { "RuleDmarcValueList$member": null } }, "RuleDmarcValueList": { "base": null, "refs": { "RuleDmarcExpression$Values": "The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match.
" } }, "RuleIpEmailAttribute": { "base": null, "refs": { "RuleIpToEvaluate$Attribute": "The attribute of the email to evaluate.
" } }, "RuleIpExpression": { "base": "An IP address expression matching certain IP addresses within a given range of IP addresses.
", "refs": { "RuleCondition$IpExpression": "The condition applies to an IP address expression passed in this field.
" } }, "RuleIpOperator": { "base": null, "refs": { "RuleIpExpression$Operator": "The operator to evaluate the IP address.
" } }, "RuleIpStringValue": { "base": null, "refs": { "RuleIpValueList$member": null } }, "RuleIpToEvaluate": { "base": "The IP address to evaluate for this condition.
", "refs": { "RuleIpExpression$Evaluate": "The IP address to evaluate in this condition.
" } }, "RuleIpValueList": { "base": null, "refs": { "RuleIpExpression$Values": "The IP CIDR blocks in format \"x.y.z.w/n\" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges.
" } }, "RuleIsInAddressList": { "base": "The structure type for a boolean condition that provides the address lists and address list attribute to evaluate.
", "refs": { "RuleBooleanToEvaluate$IsInAddressList": "The structure representing the address lists and address list attribute that will be used in evaluation of boolean expression.
" } }, "RuleName": { "base": null, "refs": { "Rule$Name": "The user-friendly name of the rule.
" } }, "RuleNumberEmailAttribute": { "base": null, "refs": { "RuleNumberToEvaluate$Attribute": "An email attribute that is used as the number to evaluate.
" } }, "RuleNumberExpression": { "base": "A number expression to match numeric conditions with integers from the incoming email.
", "refs": { "RuleCondition$NumberExpression": "The condition applies to a number expression passed in this field.
" } }, "RuleNumberOperator": { "base": null, "refs": { "RuleNumberExpression$Operator": "The operator for a numeric condition expression.
" } }, "RuleNumberToEvaluate": { "base": "The number to evaluate in a numeric condition expression.
", "refs": { "RuleNumberExpression$Evaluate": "The number to evaluate in a numeric condition expression.
" } }, "RuleSet": { "base": "A rule set contains a list of rules that are evaluated in order. Each rule is evaluated sequentially for each email.
", "refs": { "RuleSets$member": null } }, "RuleSetArn": { "base": null, "refs": { "GetRuleSetResponse$RuleSetArn": "The Amazon Resource Name (ARN) of the rule set resource.
" } }, "RuleSetId": { "base": null, "refs": { "CreateIngressPointRequest$RuleSetId": "The identifier of an existing rule set that you attach to an ingress endpoint resource.
", "CreateRuleSetResponse$RuleSetId": "The identifier of the created rule set.
", "DeleteRuleSetRequest$RuleSetId": "The identifier of an existing rule set resource to delete.
", "GetIngressPointResponse$RuleSetId": "The identifier of a rule set resource associated with the ingress endpoint.
", "GetRuleSetRequest$RuleSetId": "The identifier of an existing rule set to be retrieved.
", "GetRuleSetResponse$RuleSetId": "The identifier of the rule set resource.
", "Metadata$RuleSetId": "The ID of the rule set that processed the email.
", "RuleSet$RuleSetId": "The identifier of the rule set.
", "UpdateIngressPointRequest$RuleSetId": "The identifier of an existing rule set that you attach to an ingress endpoint resource.
", "UpdateRuleSetRequest$RuleSetId": "The identifier of a rule set you want to update.
" } }, "RuleSetName": { "base": null, "refs": { "CreateRuleSetRequest$RuleSetName": "A user-friendly name for the rule set.
", "GetRuleSetResponse$RuleSetName": "A user-friendly name for the rule set resource.
", "RuleSet$RuleSetName": "A user-friendly name for the rule set.
", "UpdateRuleSetRequest$RuleSetName": "A user-friendly name for the rule set resource.
" } }, "RuleSets": { "base": null, "refs": { "ListRuleSetsResponse$RuleSets": "The list of rule sets.
" } }, "RuleStringEmailAttribute": { "base": null, "refs": { "RuleStringToEvaluate$Attribute": "The email attribute to evaluate in a string condition expression.
" } }, "RuleStringExpression": { "base": "A string expression is evaluated against strings or substrings of the email.
", "refs": { "RuleCondition$StringExpression": "The condition applies to a string expression passed in this field.
" } }, "RuleStringList": { "base": null, "refs": { "RuleStringExpression$Values": "The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email's string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email's string.
" } }, "RuleStringOperator": { "base": null, "refs": { "RuleStringExpression$Operator": "The matching operator for a string condition expression.
" } }, "RuleStringToEvaluate": { "base": "The string to evaluate in a string condition expression.
", "refs": { "RuleStringExpression$Evaluate": "The string to evaluate in a string condition expression.
" } }, "RuleStringValue": { "base": null, "refs": { "RuleStringList$member": null } }, "RuleVerdict": { "base": null, "refs": { "RuleVerdictValueList$member": null } }, "RuleVerdictAttribute": { "base": null, "refs": { "RuleVerdictToEvaluate$Attribute": "The email verdict attribute to evaluate in a string verdict expression.
" } }, "RuleVerdictExpression": { "base": "A verdict expression is evaluated against verdicts of the email.
", "refs": { "RuleCondition$VerdictExpression": "The condition applies to a verdict expression passed in this field.
" } }, "RuleVerdictOperator": { "base": null, "refs": { "RuleVerdictExpression$Operator": "The matching operator for a verdict condition expression.
" } }, "RuleVerdictToEvaluate": { "base": "The verdict to evaluate in a verdict condition expression.
", "refs": { "RuleVerdictExpression$Evaluate": "The verdict to evaluate in a verdict condition expression.
" } }, "RuleVerdictValueList": { "base": null, "refs": { "RuleVerdictExpression$Values": "The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email.
" } }, "Rules": { "base": null, "refs": { "CreateRuleSetRequest$Rules": "Conditional rules that are evaluated for determining actions on email.
", "GetRuleSetResponse$Rules": "The rules contained in the rule set.
", "UpdateRuleSetRequest$Rules": "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.
" } }, "S3Action": { "base": "Writes the MIME content of the email to an S3 bucket.
", "refs": { "RuleAction$WriteToS3": "This action writes the MIME content of the email to an S3 bucket.
" } }, "S3Bucket": { "base": null, "refs": { "S3Action$S3Bucket": "The bucket name of the S3 bucket to write to.
" } }, "S3ExportDestinationConfiguration": { "base": "The configuration for exporting email data to an Amazon S3 bucket.
", "refs": { "ExportDestinationConfiguration$S3": "Configuration for delivering to an Amazon S3 bucket.
" } }, "S3Location": { "base": null, "refs": { "S3ExportDestinationConfiguration$S3Location": "The S3 location to deliver the exported email data.
" } }, "S3Prefix": { "base": null, "refs": { "S3Action$S3Prefix": "The S3 prefix to use for the write to the s3 bucket.
" } }, "S3PresignedURL": { "base": null, "refs": { "GetArchiveMessageResponse$MessageDownloadLink": "A pre-signed URL to temporarily download the full message content.
" } }, "SavedAddress": { "base": "An address that is a member of an address list.
", "refs": { "SavedAddresses$member": null } }, "SavedAddresses": { "base": null, "refs": { "ListMembersOfAddressListResponse$Addresses": "The list of addresses.
" } }, "SearchId": { "base": null, "refs": { "GetArchiveSearchRequest$SearchId": "The identifier of the search job to get details for.
", "GetArchiveSearchResultsRequest$SearchId": "The identifier of the completed search job.
", "SearchSummary$SearchId": "The unique identifier of the search job.
", "StartArchiveSearchResponse$SearchId": "The unique identifier for the initiated search job.
", "StopArchiveSearchRequest$SearchId": "The identifier of the search job to stop.
" } }, "SearchMaxResults": { "base": null, "refs": { "GetArchiveSearchResponse$MaxResults": "The maximum number of search results to return.
", "StartArchiveSearchRequest$MaxResults": "The maximum number of search results to return.
" } }, "SearchState": { "base": null, "refs": { "SearchStatus$State": "The current state of the search job.
" } }, "SearchStatus": { "base": "The current status of an archive search job.
", "refs": { "GetArchiveSearchResponse$Status": "The current status of the search job.
", "SearchSummary$Status": "The current status of the search job.
" } }, "SearchSummary": { "base": "Summary details of an archive search job.
", "refs": { "SearchSummaryList$member": null } }, "SearchSummaryList": { "base": null, "refs": { "ListArchiveSearchesResponse$Searches": "The list of search job identifiers and statuses.
" } }, "SecretArn": { "base": null, "refs": { "IngressPointAuthConfiguration$SecretArn": "The ingress endpoint SecretsManager::Secret ARN configuration for the ingress endpoint resource.
", "IngressPointConfiguration$SecretArn": "The SecretsManager::Secret ARN of the ingress endpoint resource.
", "RelayAuthentication$SecretArn": "The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored.
" } }, "SendAction": { "base": "Sends the email to the internet using the ses:SendRawEmail API.
", "refs": { "RuleAction$Send": "This action sends the email to the internet.
" } }, "SenderIpAddress": { "base": null, "refs": { "Metadata$SenderIpAddress": "The IP address of the host from which the email was received.
", "Row$SenderIpAddress": "Mail archived with Mail Manager: The IP address of the client that connects to the ingress endpoint.
Mail sent through a configuration set with the archiving option enabled: The IP address of the client that makes the SendEmail API call.
Occurs when an operation exceeds a predefined service quota or limit.
", "refs": {} }, "SmtpPassword": { "base": null, "refs": { "IngressPointConfiguration$SmtpPassword": "The password of the ingress endpoint resource.
" } }, "SnsAction": { "base": "The action to publish the email content to an Amazon SNS topic. When executed, this action will send the email as a notification to the specified SNS topic.
", "refs": { "RuleAction$PublishToSns": "This action publishes the email content to an Amazon SNS topic.
" } }, "SnsNotificationEncoding": { "base": null, "refs": { "SnsAction$Encoding": "The encoding to use for the email within the Amazon SNS notification. The default value is UTF-8. Use BASE64 if you need to preserve all special characters, especially when the original message uses a different encoding format.
The expected payload type within the Amazon SNS notification. CONTENT attempts to publish the full email content with 20KB of headers content. HEADERS extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is CONTENT.
The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.
" } }, "StartAddressListImportJobRequest": { "base": null, "refs": {} }, "StartAddressListImportJobResponse": { "base": null, "refs": {} }, "StartArchiveExportRequest": { "base": "The request to initiate an export of emails from an archive.
", "refs": {} }, "StartArchiveExportResponse": { "base": "The response from initiating an archive export.
", "refs": {} }, "StartArchiveSearchRequest": { "base": "The request to initiate a search across emails in an archive.
", "refs": {} }, "StartArchiveSearchResponse": { "base": "The response from initiating an archive search.
", "refs": {} }, "StopAddressListImportJobRequest": { "base": null, "refs": {} }, "StopAddressListImportJobResponse": { "base": null, "refs": {} }, "StopArchiveExportRequest": { "base": "The request to stop an in-progress archive export job.
", "refs": {} }, "StopArchiveExportResponse": { "base": "The response indicating if the request to stop the export job succeeded.
On success, returns an HTTP 200 status code. On failure, returns an error message.
", "refs": {} }, "StopArchiveSearchRequest": { "base": "The request to stop an in-progress archive search job.
", "refs": {} }, "StopArchiveSearchResponse": { "base": "The response indicating if the request to stop the search job succeeded.
On success, returns an HTTP 200 status code. On failure, returns an error message.
", "refs": {} }, "String": { "base": null, "refs": { "EmailReceivedHeadersList$member": null, "Envelope$Helo": "The HELO used by the host from which the email was received.
", "Envelope$From": "The RCPT FROM given by the host from which the email was received.
", "IngressPointPasswordConfiguration$SmtpPasswordVersion": "The current password expiry timestamp of the ingress endpoint resource.
", "IngressPointPasswordConfiguration$PreviousSmtpPasswordVersion": "The previous password version of the ingress endpoint resource.
", "MessageBody$Text": "The plain text body content of the message.
", "MessageBody$Html": "The HTML body content of the message.
", "Metadata$SenderHostname": "The name of the host from which the email was received.
", "Metadata$TlsCipherSuite": "The TLS cipher suite used to communicate with the host from which the email was received.
", "Metadata$TlsProtocol": "The TLS protocol used to communicate with the host from which the email was received.
", "Metadata$SendingMethod": "The name of the API call used when sent through a configuration set with archiving enabled.
", "Metadata$SourceIdentity": "The identity name used to authorize the sending action when sent through a configuration set with archiving enabled.
", "Metadata$SendingPool": "The name of the dedicated IP pool used when sent through a configuration set with archiving enabled.
", "Metadata$ConfigurationSet": "The name of the configuration set used when sent through a configuration set with archiving enabled.
", "Metadata$SourceArn": "Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.
", "Row$Date": "The date the email was sent.
", "Row$To": "The email addresses in the To header.
", "Row$From": "The email address of the sender.
", "Row$Cc": "The email addresses in the CC header.
", "Row$Subject": "The subject header value of the email.
", "Row$MessageId": "The unique message ID of the email.
", "Row$InReplyTo": "The email message ID this is a reply to.
", "Row$XMailer": "The user agent that sent the email.
", "Row$XOriginalMailer": "The original user agent that sent the email.
", "Row$XPriority": "The priority level of the email.
", "Row$SenderHostname": "The name of the host from which the email was received.
", "Row$SourceArn": "Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.
", "StringList$member": null } }, "StringList": { "base": null, "refs": { "Envelope$To": "All SMTP TO entries given by the host from which the email was received.
", "IngressStringExpression$Values": "The right hand side argument of a string condition expression.
" } }, "StringValue": { "base": null, "refs": { "StringValueList$member": null } }, "StringValueList": { "base": null, "refs": { "ArchiveStringExpression$Values": "The list of string values to evaluate the email attribute against.
" } }, "Tag": { "base": "A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources.
", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$Key": "The key of the key-value tag.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.
" } }, "TagList": { "base": null, "refs": { "CreateAddonInstanceRequest$Tags": "The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateAddonSubscriptionRequest$Tags": "The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateAddressListRequest$Tags": "The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateArchiveRequest$Tags": "The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateIngressPointRequest$Tags": "The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateRelayRequest$Tags": "The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateRuleSetRequest$Tags": "The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateTrafficPolicyRequest$Tags": "The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "ListTagsForResourceResponse$Tags": "The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "TagResourceRequest$Tags": "The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagValue": { "base": null, "refs": { "Tag$Value": "The value of the key-value tag.
" } }, "TaggableResourceArn": { "base": null, "refs": { "ListTagsForResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource to retrieve tags from.
", "TagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource that you want to tag.
", "UntagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource that you want to untag.
" } }, "ThrottlingException": { "base": "Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
", "refs": {} }, "Timestamp": { "base": null, "refs": { "AddonInstance$CreatedTimestamp": "The timestamp of when the Add On instance was created.
", "AddonSubscription$CreatedTimestamp": "The timestamp of when the Add On subscription was created.
", "AddressList$CreatedTimestamp": "The timestamp of when the address list was created.
", "AddressList$LastUpdatedTimestamp": "The timestamp of when the address list was last updated.
", "Archive$LastUpdatedTimestamp": "The timestamp of when the archive was last updated.
", "ExportStatus$SubmissionTimestamp": "The timestamp of when the export job was submitted.
", "ExportStatus$CompletionTimestamp": "The timestamp of when the export job completed (if finished).
", "GetAddonInstanceResponse$CreatedTimestamp": "The timestamp of when the Add On instance was created.
", "GetAddonSubscriptionResponse$CreatedTimestamp": "The timestamp of when the Add On subscription was created.
", "GetAddressListImportJobResponse$CreatedTimestamp": "The timestamp of when the import job was created.
", "GetAddressListImportJobResponse$StartTimestamp": "The timestamp of when the import job was started.
", "GetAddressListImportJobResponse$CompletedTimestamp": "The timestamp of when the import job was completed.
", "GetAddressListResponse$CreatedTimestamp": "The date of when then address list was created.
", "GetAddressListResponse$LastUpdatedTimestamp": "The date of when the address list was last updated.
", "GetArchiveExportResponse$FromTimestamp": "The start of the timestamp range the exported emails cover.
", "GetArchiveExportResponse$ToTimestamp": "The end of the date range the exported emails cover.
", "GetArchiveResponse$CreatedTimestamp": "The timestamp of when the archive was created.
", "GetArchiveResponse$LastUpdatedTimestamp": "The timestamp of when the archive was modified.
", "GetArchiveSearchResponse$FromTimestamp": "The start timestamp of the range the searched emails cover.
", "GetArchiveSearchResponse$ToTimestamp": "The end timestamp of the range the searched emails cover.
", "GetIngressPointResponse$CreatedTimestamp": "The timestamp of when the ingress endpoint was created.
", "GetIngressPointResponse$LastUpdatedTimestamp": "The timestamp of when the ingress endpoint was last updated.
", "GetMemberOfAddressListResponse$CreatedTimestamp": "The timestamp of when the address was created.
", "GetRelayResponse$CreatedTimestamp": "The timestamp of when the relay was created.
", "GetRelayResponse$LastModifiedTimestamp": "The timestamp of when relay was last updated.
", "GetRuleSetResponse$CreatedDate": "The date of when then rule set was created.
", "GetRuleSetResponse$LastModificationDate": "The date of when the rule set was last modified.
", "GetTrafficPolicyResponse$CreatedTimestamp": "The timestamp of when the traffic policy was created.
", "GetTrafficPolicyResponse$LastUpdatedTimestamp": "The timestamp of when the traffic policy was last updated.
", "ImportJob$CreatedTimestamp": "The timestamp of when the import job was created.
", "ImportJob$StartTimestamp": "The timestamp of when the import job was started.
", "ImportJob$CompletedTimestamp": "The timestamp of when the import job was completed.
", "IngressPointPasswordConfiguration$PreviousSmtpPasswordExpiryTimestamp": "The previous password expiry timestamp of the ingress endpoint resource.
", "Metadata$Timestamp": "The timestamp of when the email was received.
", "Relay$LastModifiedTimestamp": "The timestamp of when the relay was last modified.
", "Row$ReceivedTimestamp": "The timestamp of when the email was received.
", "RuleSet$LastModificationDate": "The last modification date of the rule set.
", "SavedAddress$CreatedTimestamp": "The timestamp of when the address was added to the address list.
", "SearchStatus$SubmissionTimestamp": "The timestamp of when the search was submitted.
", "SearchStatus$CompletionTimestamp": "The timestamp of when the search completed (if finished).
", "StartArchiveExportRequest$FromTimestamp": "The start of the timestamp range to include emails from.
", "StartArchiveExportRequest$ToTimestamp": "The end of the timestamp range to include emails from.
", "StartArchiveSearchRequest$FromTimestamp": "The start timestamp of the range to search emails from.
", "StartArchiveSearchRequest$ToTimestamp": "The end timestamp of the range to search emails from.
" } }, "TrafficPolicy": { "base": "The structure of a traffic policy resource which is a container for policy statements.
", "refs": { "TrafficPolicyList$member": null } }, "TrafficPolicyArn": { "base": null, "refs": { "GetTrafficPolicyResponse$TrafficPolicyArn": "The Amazon Resource Name (ARN) of the traffic policy resource.
" } }, "TrafficPolicyId": { "base": null, "refs": { "CreateIngressPointRequest$TrafficPolicyId": "The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
", "CreateTrafficPolicyResponse$TrafficPolicyId": "The identifier of the traffic policy resource.
", "DeleteTrafficPolicyRequest$TrafficPolicyId": "The identifier of the traffic policy that you want to delete.
", "GetIngressPointResponse$TrafficPolicyId": "The identifier of the traffic policy resource associated with the ingress endpoint.
", "GetTrafficPolicyRequest$TrafficPolicyId": "The identifier of the traffic policy resource.
", "GetTrafficPolicyResponse$TrafficPolicyId": "The identifier of the traffic policy resource.
", "Metadata$TrafficPolicyId": "The ID of the traffic policy that was in effect when the email was received.
", "TrafficPolicy$TrafficPolicyId": "The identifier of the traffic policy resource.
", "UpdateIngressPointRequest$TrafficPolicyId": "The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
", "UpdateTrafficPolicyRequest$TrafficPolicyId": "The identifier of the traffic policy that you want to update.
" } }, "TrafficPolicyList": { "base": null, "refs": { "ListTrafficPoliciesResponse$TrafficPolicies": "The list of traffic policies.
" } }, "TrafficPolicyName": { "base": null, "refs": { "CreateTrafficPolicyRequest$TrafficPolicyName": "A user-friendly name for the traffic policy resource.
", "GetTrafficPolicyResponse$TrafficPolicyName": "A user-friendly name for the traffic policy resource.
", "TrafficPolicy$TrafficPolicyName": "A user-friendly name of the traffic policy resource.
", "UpdateTrafficPolicyRequest$TrafficPolicyName": "A user-friendly name for the traffic policy resource.
" } }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "UpdateArchiveRequest": { "base": "The request to update properties of an existing email archive.
", "refs": {} }, "UpdateArchiveResponse": { "base": "The response indicating if the archive update succeeded or failed.
On success, returns an HTTP 200 status code. On failure, returns an error message.
", "refs": {} }, "UpdateIngressPointRequest": { "base": null, "refs": {} }, "UpdateIngressPointResponse": { "base": null, "refs": {} }, "UpdateRelayRequest": { "base": null, "refs": {} }, "UpdateRelayResponse": { "base": null, "refs": {} }, "UpdateRuleSetRequest": { "base": null, "refs": {} }, "UpdateRuleSetResponse": { "base": null, "refs": {} }, "UpdateTrafficPolicyRequest": { "base": null, "refs": {} }, "UpdateTrafficPolicyResponse": { "base": null, "refs": {} }, "ValidationException": { "base": "The request validation has failed. For details, see the accompanying error message.
", "refs": {} }, "VpcEndpointId": { "base": null, "refs": { "PrivateNetworkConfiguration$VpcEndpointId": "The identifier of the VPC endpoint to associate with this private ingress point.
" } } } }