Package-level declarations

Types

Link copied to clipboard
data class ConfigurationSetDashboardOptions(val engagementMetrics: String)

Preferences regarding the Dashboard feature.

Link copied to clipboard
data class ConfigurationSetDeliveryOptions(val maxDeliverySeconds: Double? = null, val sendingPoolName: String? = null, val tlsPolicy: String? = null)

An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.

data class ConfigurationSetEventDestinationDimensionConfiguration(val defaultDimensionValue: String, val dimensionName: String, val dimensionValueSource: String)

A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.

An object that contains Event bus ARN associated with the event bridge destination.

data class ConfigurationSetEventDestinationEventDestination(val cloudWatchDestination: ConfigurationSetEventDestinationCloudWatchDestination? = null, val enabled: Boolean? = null, val eventBridgeDestination: ConfigurationSetEventDestinationEventBridgeDestination? = null, val kinesisFirehoseDestination: ConfigurationSetEventDestinationKinesisFirehoseDestination? = null, val matchingEventTypes: List<String>, val name: String? = null, val snsDestination: ConfigurationSetEventDestinationSnsDestination? = null)
data class ConfigurationSetEventDestinationKinesisFirehoseDestination(val deliveryStreamArn: String, val iamRoleArn: String)

An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

An object that contains SNS topic ARN associated event destination.

Link copied to clipboard
data class ConfigurationSetGuardianOptions(val optimizedSharedDelivery: String)

Preferences regarding the Guardian feature.

Link copied to clipboard
data class ConfigurationSetReputationOptions(val reputationMetricsEnabled: Boolean? = null)

An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

Link copied to clipboard
data class ConfigurationSetSendingOptions(val sendingEnabled: Boolean? = null)

An object that defines whether or not Amazon SES can send email that you send using the configuration set.

Link copied to clipboard
data class ConfigurationSetSuppressionOptions(val suppressedReasons: List<String>? = null)

An object that contains information about the suppression list preferences for your account.

Link copied to clipboard
data class ConfigurationSetTrackingOptions(val customRedirectDomain: String? = null, val httpsPolicy: String? = null)

An object that defines the open and click tracking options for emails that you send using the configuration set.

Link copied to clipboard
data class ConfigurationSetVdmOptions(val dashboardOptions: ConfigurationSetDashboardOptions? = null, val guardianOptions: ConfigurationSetGuardianOptions? = null)

An object that contains Virtual Deliverability Manager (VDM) settings for this configuration set.

Link copied to clipboard
data class ContactListTopic(val defaultSubscriptionStatus: String, val description: String? = null, val displayName: String, val topicName: String)
Link copied to clipboard
data class EmailIdentityConfigurationSetAttributes(val configurationSetName: String? = null)

Used to associate a configuration set with an email identity.

Link copied to clipboard
data class EmailIdentityDkimAttributes(val signingEnabled: Boolean? = null)

Used to enable or disable DKIM authentication for an email identity.

Link copied to clipboard
data class EmailIdentityDkimSigningAttributes(val domainSigningPrivateKey: String? = null, val domainSigningSelector: String? = null, val nextSigningKeyLength: String? = null)

If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM.

Link copied to clipboard
data class EmailIdentityFeedbackAttributes(val emailForwardingEnabled: Boolean? = null)

Used to enable or disable feedback forwarding for an identity.

Link copied to clipboard
data class EmailIdentityMailFromAttributes(val behaviorOnMxFailure: String? = null, val mailFromDomain: String? = null)

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Link copied to clipboard
data class GetConfigurationSetResult(val deliveryOptions: ConfigurationSetDeliveryOptions? = null, val reputationOptions: ConfigurationSetReputationOptions? = null, val sendingOptions: ConfigurationSetSendingOptions? = null, val suppressionOptions: ConfigurationSetSuppressionOptions? = null, val trackingOptions: ConfigurationSetTrackingOptions? = null, val vdmOptions: ConfigurationSetVdmOptions? = null)
Link copied to clipboard
data class GetContactListResult(val description: String? = null, val tags: List<Tag>? = null, val topics: List<ContactListTopic>? = null)
Link copied to clipboard
data class GetDedicatedIpPoolResult(val scalingMode: String? = null)
Link copied to clipboard
data class GetEmailIdentityResult(val configurationSetAttributes: EmailIdentityConfigurationSetAttributes? = null, val dkimAttributes: EmailIdentityDkimAttributes? = null, val dkimDnsTokenName1: String? = null, val dkimDnsTokenName2: String? = null, val dkimDnsTokenName3: String? = null, val dkimDnsTokenValue1: String? = null, val dkimDnsTokenValue2: String? = null, val dkimDnsTokenValue3: String? = null, val dkimSigningAttributes: EmailIdentityDkimSigningAttributes? = null, val feedbackAttributes: EmailIdentityFeedbackAttributes? = null, val mailFromAttributes: EmailIdentityMailFromAttributes? = null)
Link copied to clipboard
data class GetMailManagerAddonInstanceResult(val addonInstanceArn: String? = null, val addonInstanceId: String? = null, val addonName: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetMailManagerAddonSubscriptionResult(val addonSubscriptionArn: String? = null, val addonSubscriptionId: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetMailManagerArchiveResult(val archiveArn: String? = null, val archiveId: String? = null, val archiveName: String? = null, val archiveState: MailManagerArchiveArchiveState? = null, val retention: MailManagerArchiveArchiveRetentionProperties? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetMailManagerIngressPointResult(val aRecord: String? = null, val ingressPointArn: String? = null, val ingressPointId: String? = null, val ingressPointName: String? = null, val ruleSetId: String? = null, val status: MailManagerIngressPointIngressPointStatus? = null, val statusToUpdate: MailManagerIngressPointIngressPointStatusToUpdate? = null, val tags: List<Tag>? = null, val trafficPolicyId: String? = null)
Link copied to clipboard
data class GetMailManagerRelayResult(val authentication: Either<MailManagerRelayRelayAuthentication0Properties, MailManagerRelayRelayAuthentication1Properties>? = null, val relayArn: String? = null, val relayId: String? = null, val relayName: String? = null, val serverName: String? = null, val serverPort: Double? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetMailManagerRuleSetResult(val ruleSetArn: String? = null, val ruleSetId: String? = null, val ruleSetName: String? = null, val rules: List<MailManagerRuleSetRule>? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetMailManagerTrafficPolicyResult(val defaultAction: MailManagerTrafficPolicyAcceptAction? = null, val maxMessageSizeBytes: Double? = null, val policyStatements: List<MailManagerTrafficPolicyPolicyStatement>? = null, val tags: List<Tag>? = null, val trafficPolicyArn: String? = null, val trafficPolicyId: String? = null, val trafficPolicyName: String? = null)
Link copied to clipboard
data class GetTemplateResult(val id: String? = null, val template: Template? = null)
Link copied to clipboard
data class GetVdmAttributesResult(val dashboardAttributes: VdmAttributesDashboardAttributes? = null, val guardianAttributes: VdmAttributesGuardianAttributes? = null, val vdmAttributesResourceId: String? = null)
Link copied to clipboard
data class MailManagerRuleSetAddHeaderAction(val headerName: String, val headerValue: String)
Link copied to clipboard
data class MailManagerRuleSetAnalysis(val analyzer: String, val resultField: String)
Link copied to clipboard
data class MailManagerRuleSetArchiveAction(val actionFailurePolicy: MailManagerRuleSetActionFailurePolicy? = null, val targetArchive: String)
Link copied to clipboard
data class MailManagerRuleSetDeliverToMailboxAction(val actionFailurePolicy: MailManagerRuleSetActionFailurePolicy? = null, val mailboxArn: String, val roleArn: String)
data class MailManagerRuleSetDeliverToQBusinessAction(val actionFailurePolicy: MailManagerRuleSetActionFailurePolicy? = null, val applicationId: String, val indexId: String, val roleArn: String)
Link copied to clipboard
data class MailManagerRuleSetRelayAction(val actionFailurePolicy: MailManagerRuleSetActionFailurePolicy? = null, val mailFrom: MailManagerRuleSetMailFrom? = null, val relay: String)
Link copied to clipboard
data class MailManagerRuleSetReplaceRecipientAction(val replaceWith: List<String>? = null)
Link copied to clipboard
data class MailManagerRuleSetRule(val actions: List<Any>, val conditions: List<Any>? = null, val name: String? = null, val unless: List<Any>? = null)
Link copied to clipboard
data class MailManagerRuleSetRuleStringExpression(val evaluate: Any, val operator: MailManagerRuleSetRuleStringOperator, val values: List<String>)
Link copied to clipboard
data class MailManagerRuleSetS3Action(val actionFailurePolicy: MailManagerRuleSetActionFailurePolicy? = null, val roleArn: String, val s3Bucket: String, val s3Prefix: String? = null, val s3SseKmsKeyId: String? = null)
Link copied to clipboard
data class MailManagerRuleSetSendAction(val actionFailurePolicy: MailManagerRuleSetActionFailurePolicy? = null, val roleArn: String)
Link copied to clipboard
data class MailManagerTrafficPolicyIngressAnalysis(val analyzer: String, val resultField: String)
Link copied to clipboard
data class Template(val htmlPart: String? = null, val subjectPart: String, val templateName: String? = null, val textPart: String? = null)

The content of the email, composed of a subject line, an HTML part, and a text-only part

Link copied to clipboard
data class VdmAttributesDashboardAttributes(val engagementMetrics: String? = null)

Preferences regarding the Dashboard feature.

Link copied to clipboard
data class VdmAttributesGuardianAttributes(val optimizedSharedDelivery: String? = null)

Preferences regarding the Guardian feature.