Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Account
Details An object that contains information about your account details.
- Archiving
Options Used to associate a configuration set with a MailManager archive.
- Attachment
Contains metadata and attachment raw content.
- Batch
GetMetric Data Query Represents a single metric data query to include in a batch.
- Blacklist
Entry An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.
- Body
Represents the body of the email message.
- Bounce
Information about a
Bounce
event.- Bulk
Email Content An object that contains the body of the message. You can specify a template message.
- Bulk
Email Entry - Bulk
Email Entry Result The result of the
SendBulkEmail
operation of each specifiedBulkEmailEntry
.- Cloud
Watch Destination An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
- Cloud
Watch Dimension Configuration An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.
- Complaint
Information about a
Complaint
event.- Contact
A contact is the end-user who is receiving the email.
- Contact
List A list that contains contacts that have subscribed to a particular topic or topics.
- Contact
List Destination An object that contains details about the action of a contact list.
- Content
An object that represents the content of the email, and optionally a character set specification.
- Custom
Verification Email Template Metadata Contains information about a custom verification email template.
- Daily
Volume An object that contains information about the volume of email sent on each day of the analysis period.
- Dashboard
Attributes An object containing additional settings for your VDM configuration as applicable to the Dashboard.
- Dashboard
Options An object containing additional settings for your VDM configuration as applicable to the Dashboard.
- Dedicated
Ip Contains information about a dedicated IP address that is associated with your Amazon SES account.
To learn more about requesting dedicated IP addresses, see Requesting and Relinquishing Dedicated IP Addresses in the Amazon SES Developer Guide.
- Dedicated
IpPool Contains information about a dedicated IP pool.
- Deliverability
Test Report An object that contains metadata related to a predictive inbox placement test.
- Delivery
Options Used to associate a configuration set with a dedicated IP pool.
- Destination
An object that describes the recipients for an email.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.
- Details
An object that contains configuration details of multi-region endpoint (global-endpoint).
- Dkim
Attributes An object that contains information about the DKIM authentication status for an email identity.
Amazon SES determines the authentication status by searching for specific records in the DNS configuration for the domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain. If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity
- Dkim
Signing Attributes An object that contains configuration for Bring Your Own DKIM (BYODKIM), or, for Easy DKIM
- Domain
Deliverability Campaign An object that contains the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (
PutDeliverabilityDashboardOption
operation).- Domain
Deliverability Tracking Option An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.
- Domain
IspPlacement An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.
- Email
Content An object that defines the entire content of the email, including the message headers, body content, and attachments. For a simple email message, you specify the subject and provide both text and HTML versions of the message body. You can also add attachments to simple and templated messages. For a raw message, you provide a complete MIME-formatted message, which can include custom headers and attachments.
- Email
Insights An email's insights contain metadata and delivery information about a specific email.
- Email
Template Content The content of the email, composed of a subject line, an HTML part, and a text-only part.
- Email
Template Metadata Contains information about an email template.
- Event
Bridge Destination An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur.
- Event
Destination In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
- Event
Destination Definition An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.
- Event
Details Contains a
Bounce
object if the event type isBOUNCE
. Contains aComplaint
object if the event type isCOMPLAINT
.- Export
Data Source An object that contains details about the data source of the export job. It can only contain one of
MetricsDataSource
orMessageInsightsDataSource
object.- Export
Destination An object that contains details about the destination of the export job.
- Export
JobSummary A summary of the export job.
- Export
Metric An object that contains a mapping between a
Metric
andMetricAggregation
.- Export
Statistics Statistics about the execution of an export job.
- Failure
Info An object that contains the failure details about a job.
- Guardian
Attributes An object containing additional settings for your VDM configuration as applicable to the Guardian.
- Guardian
Options An object containing additional settings for your VDM configuration as applicable to the Guardian.
- Identity
Info Information about an email identity.
- Import
Data Source An object that contains details about the data source of the import job.
- Import
Destination An object that contains details about the resource destination the import job is going to target.
- Import
JobSummary A summary of the import job.
- Inbox
Placement Tracking Option An object that contains information about the inbox placement data settings for a verified domain that’s associated with your Amazon Web Services account. This data is available only if you enabled the Deliverability dashboard for the domain.
- Insights
Event An object containing details about a specific event.
- IspPlacement
An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.
- Kinesis
Firehose Destination An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
- List
Contacts Filter A filter that can be applied to a list of contacts.
- List
Management Options An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
- Mail
From Attributes A list of attributes that are associated with a MAIL FROM domain.
- Message
Represents the email message that you're sending. The
Message
object consists of a subject line and a message body.- Message
Header Contains the name and value of a message header that you add to an email.
- Message
Insights Data Source An object that contains filters applied when performing the Message Insights export.
- Message
Insights Filters An object containing Message Insights filters.
If you specify multiple filters, the filters are joined by AND.
If you specify multiple values for a filter, the values are joined by OR. Filter values are case-sensitive.
FromEmailAddress
,Destination
, andSubject
filters support partial match. A partial match is performed by using the*
wildcard character placed at the beginning (suffix match), the end (prefix match) or both ends of the string (contains match). In order to match the literal characters*
or\
, they must be escaped using the\
character. If no wildcard character is present, an exact match is performed.- Message
Tag Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.
- Metric
Data Error An error corresponding to the unsuccessful processing of a single metric data query.
- Metric
Data Result The result of a single metric data query.
- Metrics
Data Source An object that contains details about the data source for the metrics export.
- Multi
Region Endpoint An object that contains multi-region endpoint (global-endpoint) properties.
- Overall
Volume An object that contains information about email that was sent from the selected domain.
- Pinpoint
Destination An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
- Placement
Statistics An object that contains inbox placement data for an email provider.
- RawMessage
Represents the raw content of an email message.
- Recommendation
A recommendation generated for your account.
- Replacement
Email Content The
ReplaceEmailContent
object to be used for a specificBulkEmailEntry
. TheReplacementTemplate
can be specified within this object.- Replacement
Template An object which contains
ReplacementTemplateData
to be used for a specificBulkEmailEntry
.- Reputation
Entity An object that contains information about a reputation entity, including its reference, type, policy, status records, and reputation impact.
- Reputation
Options Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current Amazon Web Services Region.
- Resource
Tenant Metadata A structure that contains information about a tenant associated with a resource.
- Review
Details An object that contains information about your account details review.
- Route
An object which contains an AWS-Region and routing status.
- Route
Details An object that contains route configuration. Includes secondary region name.
- Send
Quota An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current Amazon Web Services Region.
- Sending
Options Used to enable or disable email sending for messages that use this configuration set in the current Amazon Web Services Region.
- SnsDestination
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notifications when certain email events occur.
- SoaRecord
An object that contains information about the start of authority (SOA) record associated with the identity.
- Status
Record An object that contains status information for a reputation entity, including the current status, cause description, and timestamp.
- Suppressed
Destination An object that contains information about an email address that is on the suppression list for your account.
- Suppressed
Destination Attributes An object that contains additional attributes that are related an email address that is on the suppression list for your account.
- Suppressed
Destination Summary A summary that describes the suppressed email address.
- Suppression
Attributes An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.
- Suppression
List Destination An object that contains details about the action of suppression list.
- Suppression
Options An object that contains information about the suppression list preferences for your account.
- Tag
An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
-
Tag keys and values are case sensitive.
-
For each associated resource, each tag key must be unique and it can have only one value.
-
The
aws:
prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource. -
You can associate tags with public or shared resources, but the tags are available only for your Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.
-
- Template
An object that defines the email template to use for an email message, and the values to use for any message variables in that template. An email template is a type of message template that contains content that you want to reuse in email messages that you send. You can specifiy the email template by providing the name or ARN of an email template previously saved in your Amazon SES account or by providing the full template content.
- Tenant
A structure that contains details about a tenant.
- Tenant
Info A structure that contains basic information about a tenant.
- Tenant
Resource A structure that contains information about a resource associated with a tenant.
- Topic
An interest group, theme, or label within a list. Lists can have multiple topics.
- Topic
Filter Used for filtering by a specific topic preference.
- Topic
Preference The contact's preference for being opted-in to or opted-out of a topic.
- Tracking
Options An object that defines the tracking options for a configuration set. When you use the Amazon SES API v2 to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.
These images and links include references to a domain operated by Amazon Web Services. You can optionally configure the Amazon SES to use a domain that you operate for these images and links.
- VdmAttributes
The VDM attributes that apply to your Amazon SES account.
- VdmOptions
An object that defines the VDM settings that apply to emails that you send using the configuration set.
- Verification
Info An object that contains additional information about the verification status for the identity.
- Volume
Statistics An object that contains information about the amount of email that was delivered to recipients.
Enums§
- Attachment
Content Disposition - When writing a match expression against
AttachmentContentDisposition
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Attachment
Content Transfer Encoding - When writing a match expression against
AttachmentContentTransferEncoding
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Behavior
OnMx Failure - When writing a match expression against
BehaviorOnMxFailure
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Bounce
Type - When writing a match expression against
BounceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Bulk
Email Status - When writing a match expression against
BulkEmailStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Contact
Language - When writing a match expression against
ContactLanguage
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Contact
List Import Action - When writing a match expression against
ContactListImportAction
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Data
Format - When writing a match expression against
DataFormat
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Deliverability
Dashboard Account Status - When writing a match expression against
DeliverabilityDashboardAccountStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Deliverability
Test Status - When writing a match expression against
DeliverabilityTestStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Delivery
Event Type - When writing a match expression against
DeliveryEventType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Dimension
Value Source - When writing a match expression against
DimensionValueSource
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Dkim
Signing Attributes Origin - When writing a match expression against
DkimSigningAttributesOrigin
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Dkim
Signing KeyLength - When writing a match expression against
DkimSigningKeyLength
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Dkim
Status - When writing a match expression against
DkimStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Engagement
Event Type - When writing a match expression against
EngagementEventType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Event
Type - When writing a match expression against
EventType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Export
Source Type - When writing a match expression against
ExportSourceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Feature
Status - When writing a match expression against
FeatureStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Https
Policy - When writing a match expression against
HttpsPolicy
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Identity
Type - When writing a match expression against
IdentityType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Import
Destination Type - When writing a match expression against
ImportDestinationType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - JobStatus
- When writing a match expression against
JobStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - List
Recommendations Filter Key - When writing a match expression against
ListRecommendationsFilterKey
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - List
Tenant Resources Filter Key - When writing a match expression against
ListTenantResourcesFilterKey
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Mail
From Domain Status - When writing a match expression against
MailFromDomainStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Mail
Type - When writing a match expression against
MailType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Metric
- When writing a match expression against
Metric
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Metric
Aggregation - When writing a match expression against
MetricAggregation
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Metric
Dimension Name - When writing a match expression against
MetricDimensionName
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Metric
Namespace - When writing a match expression against
MetricNamespace
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Query
Error Code - When writing a match expression against
QueryErrorCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Recommendation
Impact - When writing a match expression against
RecommendationImpact
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Recommendation
Status - When writing a match expression against
RecommendationStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Recommendation
Type - When writing a match expression against
RecommendationType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Reputation
Entity Filter Key - When writing a match expression against
ReputationEntityFilterKey
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Reputation
Entity Type - When writing a match expression against
ReputationEntityType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Resource
Type - When writing a match expression against
ResourceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Review
Status - When writing a match expression against
ReviewStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Scaling
Mode - When writing a match expression against
ScalingMode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Sending
Status - When writing a match expression against
SendingStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Status
- When writing a match expression against
Status
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Subscription
Status - When writing a match expression against
SubscriptionStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Suppression
List Import Action - When writing a match expression against
SuppressionListImportAction
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Suppression
List Reason - When writing a match expression against
SuppressionListReason
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - TlsPolicy
- When writing a match expression against
TlsPolicy
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Verification
Error - When writing a match expression against
VerificationError
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Verification
Status - When writing a match expression against
VerificationStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Warmup
Status - When writing a match expression against
WarmupStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.