String addonInstanceArn
The Amazon Resource Name (ARN) of the Add On instance.
String addonInstanceId
The unique ID of the Add On instance.
String addonName
The name of the Add On for the instance.
String addonSubscriptionId
The subscription ID for the instance.
Date createdTimestamp
The timestamp of when the Add On instance was created.
String addonName
The name of the Add On.
String addonSubscriptionArn
The Amazon Resource Name (ARN) of the Add On subscription.
String addonSubscriptionId
The unique ID of the Add On subscription.
Date createdTimestamp
The timestamp of when the Add On subscription was created.
String archiveId
The unique identifier of the archive.
String archiveName
The unique name assigned to the archive.
String 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.
Date lastUpdatedTimestamp
The timestamp of when the archive was last updated.
ArchiveBooleanToEvaluate evaluate
The email attribute value to evaluate.
String operator
The boolean operator to use for evaluation.
String attribute
The name of the email attribute to evaluate.
ArchiveBooleanExpression booleanExpression
A boolean expression to evaluate against email attributes.
ArchiveStringExpression stringExpression
A string expression to evaluate against email attributes.
String retentionPeriod
The enum value sets the period for retaining emails in an archive.
ArchiveStringToEvaluate evaluate
The attribute of the email to evaluate.
String operator
The operator to use when evaluating the string values.
List<E> values
The list of string values to evaluate the email attribute against.
String attribute
The name of the email attribute to evaluate.
String 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.
String clientToken
A unique token that Amazon SES uses to recognize subsequent retries of the same request.
List<E> tags
The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
String addonInstanceId
The unique ID of the Add On instance created by this API.
String addonName
The name of the Add On to subscribe to. You can only have one subscription for each Add On name.
String clientToken
A unique token that Amazon SES uses to recognize subsequent retries of the same request.
List<E> tags
The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
String addonSubscriptionId
The unique ID of the Add On subscription created by this API.
String archiveName
A unique name for the new archive.
String clientToken
A unique token Amazon SES uses to recognize retries of this request.
String kmsKeyArn
The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
ArchiveRetention retention
The period for retaining emails in the archive before automatic deletion.
List<E> tags
The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
String archiveId
The unique identifier for the newly created archive.
String clientToken
A unique token that Amazon SES uses to recognize subsequent retries of the same request.
IngressPointConfiguration ingressPointConfiguration
If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
String ingressPointName
A user friendly name for an ingress endpoint resource.
String ruleSetId
The identifier of an existing rule set that you attach to an ingress endpoint resource.
List<E> tags
The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
String trafficPolicyId
The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
String type
The type of the ingress endpoint to create.
String ingressPointId
The unique identifier for a previously created ingress endpoint.
RelayAuthentication authentication
Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.
String clientToken
A unique token that Amazon SES uses to recognize subsequent retries of the same request.
String relayName
The unique name of the relay resource.
String serverName
The destination relay server address.
Integer serverPort
The destination relay server port.
List<E> tags
The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
String relayId
A unique identifier of the created relay resource.
String clientToken
A unique token that Amazon SES uses to recognize subsequent retries of the same request.
String ruleSetName
A user-friendly name for the rule set.
List<E> rules
Conditional rules that are evaluated for determining actions on email.
List<E> tags
The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
String ruleSetId
The identifier of the created rule set.
String clientToken
A unique token that Amazon SES uses to recognize subsequent retries of the same request.
String 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
Integer maxMessageSizeBytes
The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
List<E> policyStatements
Conditional statements for filtering email traffic.
List<E> tags
The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
String trafficPolicyName
A user-friendly name for the traffic policy resource.
String trafficPolicyId
The identifier of the traffic policy resource.
String addonInstanceId
The Add On instance ID to delete.
String addonSubscriptionId
The Add On subscription ID to delete.
String archiveId
The identifier of the archive to delete.
String ingressPointId
The identifier of the ingress endpoint resource that you want to delete.
String relayId
The unique relay identifier.
String ruleSetId
The identifier of an existing rule set resource to delete.
String trafficPolicyId
The identifier of the traffic policy that you want to delete.
String 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.
String mailboxArn
The Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to.
String 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.
S3ExportDestinationConfiguration s3
Configuration for delivering to an Amazon S3 bucket.
Date completionTimestamp
The timestamp of when the export job completed (if finished).
String errorMessage
An error message if the export job failed.
String state
The current state of the export job.
Date submissionTimestamp
The timestamp of when the export job was submitted.
String exportId
The unique identifier of the export job.
ExportStatus status
The current status of the export job.
String addonInstanceId
The Add On instance ID to retrieve information for.
String addonInstanceArn
The Amazon Resource Name (ARN) of the Add On instance.
String addonName
The name of the Add On provider associated to the subscription of the instance.
String addonSubscriptionId
The subscription ID associated to the instance.
Date createdTimestamp
The timestamp of when the Add On instance was created.
String addonSubscriptionId
The Add On subscription ID to retrieve information for.
String exportId
The identifier of the export job to get details for.
String archiveId
The identifier of the archive the email export was performed from.
ExportDestinationConfiguration exportDestinationConfiguration
Where the exported emails are being delivered.
ArchiveFilters filters
The criteria used to filter emails included in the export.
Date fromTimestamp
The start of the timestamp range the exported emails cover.
Integer maxResults
The maximum number of email items included in the export.
ExportStatus status
The current status of the export job.
Date toTimestamp
The end of the date range the exported emails cover.
String archivedMessageId
The unique identifier of the archived email message.
MessageBody body
The textual body content of the email message.
String archivedMessageId
The unique identifier of the archived email message.
String messageDownloadLink
A pre-signed URL to temporarily download the full message content.
String archiveId
The identifier of the archive to retrieve.
String archiveArn
The Amazon Resource Name (ARN) of the archive.
String archiveId
The unique identifier of the archive.
String archiveName
The unique name assigned to the archive.
String 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.
Date createdTimestamp
The timestamp of when the archive was created.
String kmsKeyArn
The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.
Date lastUpdatedTimestamp
The timestamp of when the archive was modified.
ArchiveRetention retention
The retention period for emails in this archive.
String searchId
The identifier of the search job to get details for.
String archiveId
The identifier of the archive the email search was performed in.
ArchiveFilters filters
The criteria used to filter emails included in the search.
Date fromTimestamp
The start timestamp of the range the searched emails cover.
Integer maxResults
The maximum number of search results to return.
SearchStatus status
The current status of the search job.
Date toTimestamp
The end timestamp of the range the searched emails cover.
String searchId
The identifier of the completed search job.
String ingressPointId
The identifier of an ingress endpoint.
String 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.
Date createdTimestamp
The timestamp of when the ingress endpoint was created.
String ingressPointArn
The Amazon Resource Name (ARN) of the ingress endpoint resource.
IngressPointAuthConfiguration ingressPointAuthConfiguration
The authentication configuration of the ingress endpoint resource.
String ingressPointId
The identifier of an ingress endpoint resource.
String ingressPointName
A user friendly name for the ingress endpoint.
Date lastUpdatedTimestamp
The timestamp of when the ingress endpoint was last updated.
String ruleSetId
The identifier of a rule set resource associated with the ingress endpoint.
String status
The status of the ingress endpoint resource.
String trafficPolicyId
The identifier of the traffic policy resource associated with the ingress endpoint.
String type
The type of ingress endpoint.
String relayId
A unique relay identifier.
RelayAuthentication authentication
The authentication attribute—contains the secret ARN where the customer relay server credentials are stored.
Date createdTimestamp
The timestamp of when the relay was created.
Date lastModifiedTimestamp
The timestamp of when relay was last updated.
String relayArn
The Amazon Resource Name (ARN) of the relay.
String relayId
The unique relay identifier.
String relayName
The unique name of the relay.
String serverName
The destination relay server address.
Integer serverPort
The destination relay server port.
String ruleSetId
The identifier of an existing rule set to be retrieved.
Date createdDate
The date of when then rule set was created.
Date lastModificationDate
The date of when the rule set was last modified.
String ruleSetArn
The Amazon Resource Name (ARN) of the rule set resource.
String ruleSetId
The identifier of the rule set resource.
String ruleSetName
A user-friendly name for the rule set resource.
List<E> rules
The rules contained in the rule set.
String trafficPolicyId
The identifier of the traffic policy resource.
Date createdTimestamp
The timestamp of when the traffic policy was created.
String defaultAction
The default action of the traffic policy.
Date lastUpdatedTimestamp
The timestamp of when the traffic policy was last updated.
Integer maxMessageSizeBytes
The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
List<E> policyStatements
The list of conditions which are in the traffic policy resource.
String trafficPolicyArn
The Amazon Resource Name (ARN) of the traffic policy resource.
String trafficPolicyId
The identifier of the traffic policy resource.
String trafficPolicyName
A user-friendly name for the traffic policy resource.
IngressBooleanToEvaluate evaluate
The operand on which to perform a boolean condition operation.
String operator
The matching operator for a boolean condition expression.
IngressAnalysis analysis
The structure type for a boolean condition stating the Add On ARN and its returned value.
String attribute
An enum type representing the allowed attribute types for an IP condition.
IngressIpToEvaluate evaluate
The left hand side argument of an IP condition expression.
String operator
The matching operator for an IP condition expression.
List<E> values
The right hand side argument of an IP condition expression.
String 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.
String ingressPointId
The identifier of the ingress endpoint resource.
String ingressPointName
A user friendly name for the ingress endpoint resource.
String status
The status of the ingress endpoint resource.
String type
The type of ingress endpoint resource.
IngressPointPasswordConfiguration ingressPointPasswordConfiguration
The ingress endpoint password configuration for the ingress endpoint resource.
String secretArn
The ingress endpoint SecretsManager::Secret ARN configuration for the ingress endpoint resource.
Date previousSmtpPasswordExpiryTimestamp
The previous password expiry timestamp of the ingress endpoint resource.
String previousSmtpPasswordVersion
The previous password version of the ingress endpoint resource.
String smtpPasswordVersion
The current password expiry timestamp of the ingress endpoint resource.
IngressStringToEvaluate evaluate
The left hand side argument of a string condition expression.
String operator
The matching operator for a string condition expression.
List<E> values
The right hand side argument of a string condition expression.
String attribute
The enum type representing the allowed attribute types for a string condition.
IngressTlsProtocolToEvaluate evaluate
The left hand side argument of a TLS condition expression.
String operator
The matching operator for a TLS condition expression.
String value
The right hand side argument of a TLS condition expression.
String attribute
The enum type representing the allowed attribute types for the TLS condition.
String 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.
Integer pageSize
The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
String 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.
Integer pageSize
The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
List<E> addonSubscriptions
The list of ingress endpoints.
String 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.
String archiveId
The identifier of the archive.
String 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.
Integer pageSize
The maximum number of archive export jobs that are returned per call. You can use NextToken to obtain further pages of archives.
String archiveId
The identifier of the archive.
String 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.
Integer pageSize
The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives.
String 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.
Integer pageSize
The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives.
String 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.
Integer pageSize
The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
String 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.
Integer pageSize
The maximum number of rule set resources that are returned per call. You can use NextToken to obtain further rule sets.
String resourceArn
The Amazon Resource Name (ARN) of the resource to retrieve tags from.
String 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.
Integer pageSize
The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.
IngressBooleanExpression 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'.
IngressIpv4Expression 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'.
IngressStringExpression 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'.
IngressTlsProtocolExpression 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'.
String 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 relay has been deleted.
String mailFrom
This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server.
String relay
The identifier of the relay resource to be used when relaying an email.
NoAuthentication noAuthentication
Keep an empty structure if the relay destination server does not require SMTP credential authentication.
String secretArn
The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored.
String archivedMessageId
The unique identifier of the archived message.
String cc
The email addresses in the CC header.
String date
The date the email was sent.
String from
The email address of the sender.
Boolean hasAttachments
A flag indicating if the email has attachments.
String inReplyTo
The email message ID this is a reply to.
String messageId
The unique message ID of the email.
List<E> receivedHeaders
The received headers from the email delivery path.
Date receivedTimestamp
The timestamp of when the email was received.
String subject
The subject header value of the email.
String to
The email addresses in the To header.
String xMailer
The user agent that sent the email.
String xOriginalMailer
The original user agent that sent the email.
String xPriority
The priority level of the email.
List<E> actions
The list of actions to execute when the conditions match the incoming email, and none of the "unless conditions" match.
List<E> 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"
String name
The user-friendly name of the rule.
List<E> 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.
AddHeaderAction addHeader
This action adds a header. This can be used to add arbitrary email headers.
ArchiveAction archive
This action archives the email. This can be used to deliver an email to an archive.
DeliverToMailboxAction deliverToMailbox
This action delivers an email to a WorkMail mailbox.
DropAction drop
This action terminates the evaluation of rules in the rule set.
RelayAction relay
This action relays the email to another SMTP server.
ReplaceRecipientAction replaceRecipient
The action replaces certain or all recipients with a different set of recipients.
SendAction send
This action sends the email to the internet.
S3Action writeToS3
This action writes the MIME content of the email to an S3 bucket.
RuleBooleanToEvaluate evaluate
The operand on which to perform a boolean condition operation.
String operator
The matching operator for a boolean condition expression.
String attribute
The boolean type representing the allowed attribute types for an email.
RuleBooleanExpression booleanExpression
The condition applies to a boolean expression passed in this field.
RuleDmarcExpression dmarcExpression
The condition applies to a DMARC policy expression passed in this field.
RuleIpExpression ipExpression
The condition applies to an IP address expression passed in this field.
RuleNumberExpression numberExpression
The condition applies to a number expression passed in this field.
RuleStringExpression stringExpression
The condition applies to a string expression passed in this field.
RuleVerdictExpression verdictExpression
The condition applies to a verdict expression passed in this field.
String operator
The operator to apply to the DMARC policy of the incoming email.
List<E> 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.
RuleIpToEvaluate evaluate
The IP address to evaluate in this condition.
String operator
The operator to evaluate the IP address.
List<E> 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.
String attribute
The attribute of the email to evaluate.
RuleNumberToEvaluate evaluate
The number to evaluate in a numeric condition expression.
String operator
The operator for a numeric condition expression.
Double value
The value to evaluate in a numeric condition expression.
String attribute
An email attribute that is used as the number to evaluate.
RuleStringToEvaluate evaluate
The string to evaluate in a string condition expression.
String operator
The matching operator for a string condition expression.
List<E> 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.
String attribute
The email attribute to evaluate in a string condition expression.
RuleVerdictToEvaluate evaluate
The verdict to evaluate in a verdict condition expression.
String operator
The matching operator for a verdict condition expression.
List<E> 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.
String 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.
String roleArn
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.
String s3Bucket
The bucket name of the S3 bucket to write to.
String s3Prefix
The S3 prefix to use for the write to the s3 bucket.
String s3SseKmsKeyId
The KMS Key ID to use to encrypt the message in S3.
String s3Location
The S3 location to deliver the exported email data.
Date completionTimestamp
The timestamp of when the search completed (if finished).
String errorMessage
An error message if the search failed.
String state
The current state of the search job.
Date submissionTimestamp
The timestamp of when the search was submitted.
String searchId
The unique identifier of the search job.
SearchStatus status
The current status of the search job.
String 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.
String roleArn
The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API.
String archiveId
The identifier of the archive to export emails from.
ExportDestinationConfiguration exportDestinationConfiguration
Details on where to deliver the exported email data.
ArchiveFilters filters
Criteria to filter which emails are included in the export.
Date fromTimestamp
The start of the timestamp range to include emails from.
Integer maxResults
The maximum number of email items to include in the export.
Date toTimestamp
The end of the timestamp range to include emails from.
String exportId
The unique identifier for the initiated export job.
String archiveId
The identifier of the archive to search emails in.
ArchiveFilters filters
Criteria to filter which emails are included in the search results.
Date fromTimestamp
The start timestamp of the range to search emails from.
Integer maxResults
The maximum number of search results to return.
Date toTimestamp
The end timestamp of the range to search emails from.
String searchId
The unique identifier for the initiated search job.
String exportId
The identifier of the export job to stop.
String searchId
The identifier of the search job to stop.
String 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
String trafficPolicyId
The identifier of the traffic policy resource.
String trafficPolicyName
A user-friendly name of the traffic policy resource.
String archiveId
The identifier of the archive to update.
String archiveName
A new, unique name for the archive.
ArchiveRetention retention
A new retention period for emails in the archive.
IngressPointConfiguration ingressPointConfiguration
If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
String ingressPointId
The identifier for the ingress endpoint you want to update.
String ingressPointName
A user friendly name for the ingress endpoint resource.
String ruleSetId
The identifier of an existing rule set that you attach to an ingress endpoint resource.
String statusToUpdate
The update status of an ingress endpoint.
String trafficPolicyId
The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
RelayAuthentication authentication
Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.
String relayId
The unique relay identifier.
String relayName
The name of the relay resource.
String serverName
The destination relay server address.
Integer serverPort
The destination relay server port.
String 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
Integer maxMessageSizeBytes
The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
List<E> policyStatements
The list of conditions to be updated for filtering email traffic.
String trafficPolicyId
The identifier of the traffic policy that you want to update.
String trafficPolicyName
A user-friendly name for the traffic policy resource.
Copyright © 2024. All rights reserved.