Struct aws_sdk_pinpointemail::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for Amazon Pinpoint Email Service
Client for invoking operations on Amazon Pinpoint Email Service. Each operation on Amazon Pinpoint Email Service is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_pinpointemail::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_pinpointemail::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_pinpointemail::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn create_configuration_set(&self) -> CreateConfigurationSet
pub fn create_configuration_set(&self) -> CreateConfigurationSet
Constructs a fluent builder for the CreateConfigurationSet
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:The name of the configuration set.
tracking_options(TrackingOptions)
/set_tracking_options(Option<TrackingOptions>)
:An object that defines the open and click tracking options for emails that you send using the configuration set.
delivery_options(DeliveryOptions)
/set_delivery_options(Option<DeliveryOptions>)
:An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
reputation_options(ReputationOptions)
/set_reputation_options(Option<ReputationOptions>)
:An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
sending_options(SendingOptions)
/set_sending_options(Option<SendingOptions>)
:An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:An array of objects that define the tags (keys and values) that you want to associate with the configuration set.
- On success, responds with
CreateConfigurationSetOutput
- On failure, responds with
SdkError<CreateConfigurationSetError>
sourcepub fn create_configuration_set_event_destination(
&self
) -> CreateConfigurationSetEventDestination
pub fn create_configuration_set_event_destination(
&self
) -> CreateConfigurationSetEventDestination
Constructs a fluent builder for the CreateConfigurationSetEventDestination
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:The name of the configuration set that you want to add an event destination to.
event_destination_name(impl Into<String>)
/set_event_destination_name(Option<String>)
:A name that identifies the event destination within the configuration set.
event_destination(EventDestinationDefinition)
/set_event_destination(Option<EventDestinationDefinition>)
:An object that defines the event destination.
- On success, responds with
CreateConfigurationSetEventDestinationOutput
- On failure, responds with
SdkError<CreateConfigurationSetEventDestinationError>
sourcepub fn create_dedicated_ip_pool(&self) -> CreateDedicatedIpPool
pub fn create_dedicated_ip_pool(&self) -> CreateDedicatedIpPool
Constructs a fluent builder for the CreateDedicatedIpPool
operation.
- The fluent builder is configurable:
pool_name(impl Into<String>)
/set_pool_name(Option<String>)
:The name of the dedicated IP pool.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:An object that defines the tags (keys and values) that you want to associate with the pool.
- On success, responds with
CreateDedicatedIpPoolOutput
- On failure, responds with
SdkError<CreateDedicatedIpPoolError>
sourcepub fn create_deliverability_test_report(
&self
) -> CreateDeliverabilityTestReport
pub fn create_deliverability_test_report(
&self
) -> CreateDeliverabilityTestReport
Constructs a fluent builder for the CreateDeliverabilityTestReport
operation.
- The fluent builder is configurable:
report_name(impl Into<String>)
/set_report_name(Option<String>)
:A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.
from_email_address(impl Into<String>)
/set_from_email_address(Option<String>)
:The email address that the predictive inbox placement test email was sent from.
content(EmailContent)
/set_content(Option<EmailContent>)
:The HTML body of the message that you sent when you performed the predictive inbox placement test.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.
- On success, responds with
CreateDeliverabilityTestReportOutput
with field(s):report_id(Option<String>)
:A unique string that identifies the predictive inbox placement test.
deliverability_test_status(Option<DeliverabilityTestStatus>)
:The status of the predictive inbox placement test. If the status is
IN_PROGRESS
, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status isCOMPLETE
, then the test is finished, and you can use theGetDeliverabilityTestReport
to view the results of the test.
- On failure, responds with
SdkError<CreateDeliverabilityTestReportError>
sourcepub fn create_email_identity(&self) -> CreateEmailIdentity
pub fn create_email_identity(&self) -> CreateEmailIdentity
Constructs a fluent builder for the CreateEmailIdentity
operation.
- The fluent builder is configurable:
email_identity(impl Into<String>)
/set_email_identity(Option<String>)
:The email address or domain that you want to verify.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:An array of objects that define the tags (keys and values) that you want to associate with the email identity.
- On success, responds with
CreateEmailIdentityOutput
with field(s):identity_type(Option<IdentityType>)
:The email identity type.
verified_for_sending_status(bool)
:Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
dkim_attributes(Option<DkimAttributes>)
:An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.
- On failure, responds with
SdkError<CreateEmailIdentityError>
sourcepub fn delete_configuration_set(&self) -> DeleteConfigurationSet
pub fn delete_configuration_set(&self) -> DeleteConfigurationSet
Constructs a fluent builder for the DeleteConfigurationSet
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:The name of the configuration set that you want to delete.
- On success, responds with
DeleteConfigurationSetOutput
- On failure, responds with
SdkError<DeleteConfigurationSetError>
sourcepub fn delete_configuration_set_event_destination(
&self
) -> DeleteConfigurationSetEventDestination
pub fn delete_configuration_set_event_destination(
&self
) -> DeleteConfigurationSetEventDestination
Constructs a fluent builder for the DeleteConfigurationSetEventDestination
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:The name of the configuration set that contains the event destination that you want to delete.
event_destination_name(impl Into<String>)
/set_event_destination_name(Option<String>)
:The name of the event destination that you want to delete.
- On success, responds with
DeleteConfigurationSetEventDestinationOutput
- On failure, responds with
SdkError<DeleteConfigurationSetEventDestinationError>
sourcepub fn delete_dedicated_ip_pool(&self) -> DeleteDedicatedIpPool
pub fn delete_dedicated_ip_pool(&self) -> DeleteDedicatedIpPool
Constructs a fluent builder for the DeleteDedicatedIpPool
operation.
- The fluent builder is configurable:
pool_name(impl Into<String>)
/set_pool_name(Option<String>)
:The name of the dedicated IP pool that you want to delete.
- On success, responds with
DeleteDedicatedIpPoolOutput
- On failure, responds with
SdkError<DeleteDedicatedIpPoolError>
sourcepub fn delete_email_identity(&self) -> DeleteEmailIdentity
pub fn delete_email_identity(&self) -> DeleteEmailIdentity
Constructs a fluent builder for the DeleteEmailIdentity
operation.
- The fluent builder is configurable:
email_identity(impl Into<String>)
/set_email_identity(Option<String>)
:The identity (that is, the email address or domain) that you want to delete from your Amazon Pinpoint account.
- On success, responds with
DeleteEmailIdentityOutput
- On failure, responds with
SdkError<DeleteEmailIdentityError>
sourcepub fn get_account(&self) -> GetAccount
pub fn get_account(&self) -> GetAccount
Constructs a fluent builder for the GetAccount
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetAccountOutput
with field(s):send_quota(Option<SendQuota>)
:An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.
sending_enabled(bool)
:Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region.
dedicated_ip_auto_warmup_enabled(bool)
:Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.
enforcement_status(Option<String>)
:The reputation status of your Amazon Pinpoint account. The status can be one of the following:
-
HEALTHY
– There are no reputation-related issues that currently impact your account. -
PROBATION
– We’ve identified some issues with your Amazon Pinpoint account. We’re placing your account under review while you work on correcting these issues. -
SHUTDOWN
– Your account’s ability to send email is currently paused because of an issue with the email sent from your account. When you correct the issue, you can contact us and request that your account’s ability to send email is resumed.
-
production_access_enabled(bool)
:Indicates whether or not your account has production access in the current AWS Region.
If the value is
false
, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.If the value is
true
, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.
- On failure, responds with
SdkError<GetAccountError>
sourcepub fn get_blacklist_reports(&self) -> GetBlacklistReports
pub fn get_blacklist_reports(&self) -> GetBlacklistReports
Constructs a fluent builder for the GetBlacklistReports
operation.
- The fluent builder is configurable:
blacklist_item_names(Vec<String>)
/set_blacklist_item_names(Option<Vec<String>>)
:A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon Pinpoint or Amazon SES.
- On success, responds with
GetBlacklistReportsOutput
with field(s):blacklist_report(Option<HashMap<String, Vec<BlacklistEntry>>>)
:An object that contains information about a blacklist that one of your dedicated IP addresses appears on.
- On failure, responds with
SdkError<GetBlacklistReportsError>
sourcepub fn get_configuration_set(&self) -> GetConfigurationSet
pub fn get_configuration_set(&self) -> GetConfigurationSet
Constructs a fluent builder for the GetConfigurationSet
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:The name of the configuration set that you want to obtain more information about.
- On success, responds with
GetConfigurationSetOutput
with field(s):configuration_set_name(Option<String>)
:The name of the configuration set.
tracking_options(Option<TrackingOptions>)
:An object that defines the open and click tracking options for emails that you send using the configuration set.
delivery_options(Option<DeliveryOptions>)
:An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
reputation_options(Option<ReputationOptions>)
:An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
sending_options(Option<SendingOptions>)
:An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
tags(Option<Vec<Tag>>)
:An array of objects that define the tags (keys and values) that are associated with the configuration set.
- On failure, responds with
SdkError<GetConfigurationSetError>
sourcepub fn get_configuration_set_event_destinations(
&self
) -> GetConfigurationSetEventDestinations
pub fn get_configuration_set_event_destinations(
&self
) -> GetConfigurationSetEventDestinations
Constructs a fluent builder for the GetConfigurationSetEventDestinations
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:The name of the configuration set that contains the event destination.
- On success, responds with
GetConfigurationSetEventDestinationsOutput
with field(s):event_destinations(Option<Vec<EventDestination>>)
:An array that includes all of the events destinations that have been configured for the configuration set.
- On failure, responds with
SdkError<GetConfigurationSetEventDestinationsError>
sourcepub fn get_dedicated_ip(&self) -> GetDedicatedIp
pub fn get_dedicated_ip(&self) -> GetDedicatedIp
Constructs a fluent builder for the GetDedicatedIp
operation.
- The fluent builder is configurable:
ip(impl Into<String>)
/set_ip(Option<String>)
:The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that’s assocaited with your Amazon Pinpoint account.
- On success, responds with
GetDedicatedIpOutput
with field(s):dedicated_ip(Option<DedicatedIp>)
:An object that contains information about a dedicated IP address.
- On failure, responds with
SdkError<GetDedicatedIpError>
sourcepub fn get_dedicated_ips(&self) -> GetDedicatedIps
pub fn get_dedicated_ips(&self) -> GetDedicatedIps
Constructs a fluent builder for the GetDedicatedIps
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
pool_name(impl Into<String>)
/set_pool_name(Option<String>)
:The name of the IP pool that the dedicated IP address is associated with.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token returned from a previous call to
GetDedicatedIps
to indicate the position of the dedicated IP pool in the list of IP pools.page_size(i32)
/set_page_size(Option<i32>)
:The number of results to show in a single call to
GetDedicatedIpsRequest
. If the number of results is larger than the number you specified in this parameter, then the response includes aNextToken
element, which you can use to obtain additional results.
- On success, responds with
GetDedicatedIpsOutput
with field(s):dedicated_ips(Option<Vec<DedicatedIp>>)
:A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account.
next_token(Option<String>)
:A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to
GetDedicatedIps
, passing this token in theNextToken
parameter.
- On failure, responds with
SdkError<GetDedicatedIpsError>
sourcepub fn get_deliverability_dashboard_options(
&self
) -> GetDeliverabilityDashboardOptions
pub fn get_deliverability_dashboard_options(
&self
) -> GetDeliverabilityDashboardOptions
Constructs a fluent builder for the GetDeliverabilityDashboardOptions
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetDeliverabilityDashboardOptionsOutput
with field(s):dashboard_enabled(bool)
:Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is
true
, the dashboard is enabled.subscription_expiry_date(Option<DateTime>)
:The date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.
account_status(Option<DeliverabilityDashboardAccountStatus>)
:The current status of your Deliverability dashboard subscription. If this value is
PENDING_EXPIRATION
, your subscription is scheduled to expire at the end of the current calendar month.active_subscribed_domains(Option<Vec<DomainDeliverabilityTrackingOption>>)
:An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.
pending_expiration_subscribed_domains(Option<Vec<DomainDeliverabilityTrackingOption>>)
:An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that’s scheduled to expire at the end of the current calendar month.
- On failure, responds with
SdkError<GetDeliverabilityDashboardOptionsError>
sourcepub fn get_deliverability_test_report(&self) -> GetDeliverabilityTestReport
pub fn get_deliverability_test_report(&self) -> GetDeliverabilityTestReport
Constructs a fluent builder for the GetDeliverabilityTestReport
operation.
- The fluent builder is configurable:
report_id(impl Into<String>)
/set_report_id(Option<String>)
:A unique string that identifies the predictive inbox placement test.
- On success, responds with
GetDeliverabilityTestReportOutput
with field(s):deliverability_test_report(Option<DeliverabilityTestReport>)
:An object that contains the results of the predictive inbox placement test.
overall_placement(Option<PlacementStatistics>)
:An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients’ inboxes, how many were sent to recipients’ spam folders, and how many weren’t delivered.
isp_placements(Option<Vec<IspPlacement>>)
:An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
message(Option<String>)
:An object that contains the message that you sent when you performed this predictive inbox placement test.
tags(Option<Vec<Tag>>)
:An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.
- On failure, responds with
SdkError<GetDeliverabilityTestReportError>
sourcepub fn get_domain_deliverability_campaign(
&self
) -> GetDomainDeliverabilityCampaign
pub fn get_domain_deliverability_campaign(
&self
) -> GetDomainDeliverabilityCampaign
Constructs a fluent builder for the GetDomainDeliverabilityCampaign
operation.
- The fluent builder is configurable:
campaign_id(impl Into<String>)
/set_campaign_id(Option<String>)
:The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.
- On success, responds with
GetDomainDeliverabilityCampaignOutput
with field(s):domain_deliverability_campaign(Option<DomainDeliverabilityCampaign>)
:An object that contains the deliverability data for the campaign.
- On failure, responds with
SdkError<GetDomainDeliverabilityCampaignError>
sourcepub fn get_domain_statistics_report(&self) -> GetDomainStatisticsReport
pub fn get_domain_statistics_report(&self) -> GetDomainStatisticsReport
Constructs a fluent builder for the GetDomainStatisticsReport
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:The domain that you want to obtain deliverability metrics for.
start_date(DateTime)
/set_start_date(Option<DateTime>)
:The first day (in Unix time) that you want to obtain domain deliverability metrics for.
end_date(DateTime)
/set_end_date(Option<DateTime>)
:The last day (in Unix time) that you want to obtain domain deliverability metrics for. The
EndDate
that you specify has to be less than or equal to 30 days after theStartDate
.
- On success, responds with
GetDomainStatisticsReportOutput
with field(s):overall_volume(Option<OverallVolume>)
:An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the
StartDate
to theEndDate
.daily_volumes(Option<Vec<DailyVolume>>)
:An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the
StartDate
and ending on theEndDate
.
- On failure, responds with
SdkError<GetDomainStatisticsReportError>
sourcepub fn get_email_identity(&self) -> GetEmailIdentity
pub fn get_email_identity(&self) -> GetEmailIdentity
Constructs a fluent builder for the GetEmailIdentity
operation.
- The fluent builder is configurable:
email_identity(impl Into<String>)
/set_email_identity(Option<String>)
:The email identity that you want to retrieve details for.
- On success, responds with
GetEmailIdentityOutput
with field(s):identity_type(Option<IdentityType>)
:The email identity type.
feedback_forwarding_status(bool)
:The feedback forwarding configuration for the identity.
If the value is
true
, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.When you set this value to
false
, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You’re required to have a method of tracking bounces and complaints. If you haven’t set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).verified_for_sending_status(bool)
:Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
dkim_attributes(Option<DkimAttributes>)
:An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.
mail_from_attributes(Option<MailFromAttributes>)
:An object that contains information about the Mail-From attributes for the email identity.
tags(Option<Vec<Tag>>)
:An array of objects that define the tags (keys and values) that are associated with the email identity.
- On failure, responds with
SdkError<GetEmailIdentityError>
sourcepub fn list_configuration_sets(&self) -> ListConfigurationSets
pub fn list_configuration_sets(&self) -> ListConfigurationSets
Constructs a fluent builder for the ListConfigurationSets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token returned from a previous call to
ListConfigurationSets
to indicate the position in the list of configuration sets.page_size(i32)
/set_page_size(Option<i32>)
:The number of results to show in a single call to
ListConfigurationSets
. If the number of results is larger than the number you specified in this parameter, then the response includes aNextToken
element, which you can use to obtain additional results.
- On success, responds with
ListConfigurationSetsOutput
with field(s):configuration_sets(Option<Vec<String>>)
:An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.
next_token(Option<String>)
:A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to
ListConfigurationSets
, and pass this token in theNextToken
parameter.
- On failure, responds with
SdkError<ListConfigurationSetsError>
sourcepub fn list_dedicated_ip_pools(&self) -> ListDedicatedIpPools
pub fn list_dedicated_ip_pools(&self) -> ListDedicatedIpPools
Constructs a fluent builder for the ListDedicatedIpPools
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token returned from a previous call to
ListDedicatedIpPools
to indicate the position in the list of dedicated IP pools.page_size(i32)
/set_page_size(Option<i32>)
:The number of results to show in a single call to
ListDedicatedIpPools
. If the number of results is larger than the number you specified in this parameter, then the response includes aNextToken
element, which you can use to obtain additional results.
- On success, responds with
ListDedicatedIpPoolsOutput
with field(s):dedicated_ip_pools(Option<Vec<String>>)
:A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint account.
next_token(Option<String>)
:A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to
ListDedicatedIpPools
, passing this token in theNextToken
parameter.
- On failure, responds with
SdkError<ListDedicatedIpPoolsError>
sourcepub fn list_deliverability_test_reports(&self) -> ListDeliverabilityTestReports
pub fn list_deliverability_test_reports(&self) -> ListDeliverabilityTestReports
Constructs a fluent builder for the ListDeliverabilityTestReports
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token returned from a previous call to
ListDeliverabilityTestReports
to indicate the position in the list of predictive inbox placement tests.page_size(i32)
/set_page_size(Option<i32>)
:The number of results to show in a single call to
ListDeliverabilityTestReports
. If the number of results is larger than the number you specified in this parameter, then the response includes aNextToken
element, which you can use to obtain additional results.The value you specify has to be at least 0, and can be no more than 1000.
- On success, responds with
ListDeliverabilityTestReportsOutput
with field(s):deliverability_test_reports(Option<Vec<DeliverabilityTestReport>>)
:An object that contains a lists of predictive inbox placement tests that you’ve performed.
next_token(Option<String>)
:A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to
ListDeliverabilityTestReports
, and pass this token in theNextToken
parameter.
- On failure, responds with
SdkError<ListDeliverabilityTestReportsError>
sourcepub fn list_domain_deliverability_campaigns(
&self
) -> ListDomainDeliverabilityCampaigns
pub fn list_domain_deliverability_campaigns(
&self
) -> ListDomainDeliverabilityCampaigns
Constructs a fluent builder for the ListDomainDeliverabilityCampaigns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
start_date(DateTime)
/set_start_date(Option<DateTime>)
:The first day, in Unix time format, that you want to obtain deliverability data for.
end_date(DateTime)
/set_end_date(Option<DateTime>)
:The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the
StartDate
parameter.subscribed_domain(impl Into<String>)
/set_subscribed_domain(Option<String>)
:The domain to obtain deliverability data for.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token that’s returned from a previous call to the
ListDomainDeliverabilityCampaigns
operation. This token indicates the position of a campaign in the list of campaigns.page_size(i32)
/set_page_size(Option<i32>)
:The maximum number of results to include in response to a single call to the
ListDomainDeliverabilityCampaigns
operation. If the number of results is larger than the number that you specify in this parameter, the response includes aNextToken
element, which you can use to obtain additional results.
- On success, responds with
ListDomainDeliverabilityCampaignsOutput
with field(s):domain_deliverability_campaigns(Option<Vec<DomainDeliverabilityCampaign>>)
:An array of responses, one for each campaign that used the domain to send email during the specified time range.
next_token(Option<String>)
:A token that’s returned from a previous call to the
ListDomainDeliverabilityCampaigns
operation. This token indicates the position of the campaign in the list of campaigns.
- On failure, responds with
SdkError<ListDomainDeliverabilityCampaignsError>
sourcepub fn list_email_identities(&self) -> ListEmailIdentities
pub fn list_email_identities(&self) -> ListEmailIdentities
Constructs a fluent builder for the ListEmailIdentities
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token returned from a previous call to
ListEmailIdentities
to indicate the position in the list of identities.page_size(i32)
/set_page_size(Option<i32>)
:The number of results to show in a single call to
ListEmailIdentities
. If the number of results is larger than the number you specified in this parameter, then the response includes aNextToken
element, which you can use to obtain additional results.The value you specify has to be at least 0, and can be no more than 1000.
- On success, responds with
ListEmailIdentitiesOutput
with field(s):email_identities(Option<Vec<IdentityInfo>>)
:An array that includes all of the identities associated with your Amazon Pinpoint account.
next_token(Option<String>)
:A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to
ListEmailIdentities
, and pass this token in theNextToken
parameter.
- On failure, responds with
SdkError<ListEmailIdentitiesError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec<Tag>>)
:An array that lists all the tags that are associated with the resource. Each tag consists of a required tag key (
Key
) and an associated tag value (Value
)
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn put_account_dedicated_ip_warmup_attributes(
&self
) -> PutAccountDedicatedIpWarmupAttributes
pub fn put_account_dedicated_ip_warmup_attributes(
&self
) -> PutAccountDedicatedIpWarmupAttributes
Constructs a fluent builder for the PutAccountDedicatedIpWarmupAttributes
operation.
- The fluent builder is configurable:
auto_warmup_enabled(bool)
/set_auto_warmup_enabled(bool)
:Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon Pinpoint account in the current AWS Region. Set to
true
to enable the automatic warm-up feature, or set tofalse
to disable it.
- On success, responds with
PutAccountDedicatedIpWarmupAttributesOutput
- On failure, responds with
SdkError<PutAccountDedicatedIpWarmupAttributesError>
sourcepub fn put_account_sending_attributes(&self) -> PutAccountSendingAttributes
pub fn put_account_sending_attributes(&self) -> PutAccountSendingAttributes
Constructs a fluent builder for the PutAccountSendingAttributes
operation.
- The fluent builder is configurable:
sending_enabled(bool)
/set_sending_enabled(bool)
:Enables or disables your account’s ability to send email. Set to
true
to enable email sending, or set tofalse
to disable email sending.If AWS paused your account’s ability to send email, you can’t use this operation to resume your account’s ability to send email.
- On success, responds with
PutAccountSendingAttributesOutput
- On failure, responds with
SdkError<PutAccountSendingAttributesError>
sourcepub fn put_configuration_set_delivery_options(
&self
) -> PutConfigurationSetDeliveryOptions
pub fn put_configuration_set_delivery_options(
&self
) -> PutConfigurationSetDeliveryOptions
Constructs a fluent builder for the PutConfigurationSetDeliveryOptions
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:The name of the configuration set that you want to associate with a dedicated IP pool.
tls_policy(TlsPolicy)
/set_tls_policy(Option<TlsPolicy>)
:Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is
Require
, messages are only delivered if a TLS connection can be established. If the value isOptional
, messages can be delivered in plain text if a TLS connection can’t be established.sending_pool_name(impl Into<String>)
/set_sending_pool_name(Option<String>)
:The name of the dedicated IP pool that you want to associate with the configuration set.
- On success, responds with
PutConfigurationSetDeliveryOptionsOutput
- On failure, responds with
SdkError<PutConfigurationSetDeliveryOptionsError>
sourcepub fn put_configuration_set_reputation_options(
&self
) -> PutConfigurationSetReputationOptions
pub fn put_configuration_set_reputation_options(
&self
) -> PutConfigurationSetReputationOptions
Constructs a fluent builder for the PutConfigurationSetReputationOptions
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:The name of the configuration set that you want to enable or disable reputation metric tracking for.
reputation_metrics_enabled(bool)
/set_reputation_metrics_enabled(bool)
:If
true
, tracking of reputation metrics is enabled for the configuration set. Iffalse
, tracking of reputation metrics is disabled for the configuration set.
- On success, responds with
PutConfigurationSetReputationOptionsOutput
- On failure, responds with
SdkError<PutConfigurationSetReputationOptionsError>
sourcepub fn put_configuration_set_sending_options(
&self
) -> PutConfigurationSetSendingOptions
pub fn put_configuration_set_sending_options(
&self
) -> PutConfigurationSetSendingOptions
Constructs a fluent builder for the PutConfigurationSetSendingOptions
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:The name of the configuration set that you want to enable or disable email sending for.
sending_enabled(bool)
/set_sending_enabled(bool)
:If
true
, email sending is enabled for the configuration set. Iffalse
, email sending is disabled for the configuration set.
- On success, responds with
PutConfigurationSetSendingOptionsOutput
- On failure, responds with
SdkError<PutConfigurationSetSendingOptionsError>
sourcepub fn put_configuration_set_tracking_options(
&self
) -> PutConfigurationSetTrackingOptions
pub fn put_configuration_set_tracking_options(
&self
) -> PutConfigurationSetTrackingOptions
Constructs a fluent builder for the PutConfigurationSetTrackingOptions
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:The name of the configuration set that you want to add a custom tracking domain to.
custom_redirect_domain(impl Into<String>)
/set_custom_redirect_domain(Option<String>)
:The domain that you want to use to track open and click events.
- On success, responds with
PutConfigurationSetTrackingOptionsOutput
- On failure, responds with
SdkError<PutConfigurationSetTrackingOptionsError>
sourcepub fn put_dedicated_ip_in_pool(&self) -> PutDedicatedIpInPool
pub fn put_dedicated_ip_in_pool(&self) -> PutDedicatedIpInPool
Constructs a fluent builder for the PutDedicatedIpInPool
operation.
- The fluent builder is configurable:
ip(impl Into<String>)
/set_ip(Option<String>)
:The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that’s associated with your Amazon Pinpoint account.
destination_pool_name(impl Into<String>)
/set_destination_pool_name(Option<String>)
:The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.
- On success, responds with
PutDedicatedIpInPoolOutput
- On failure, responds with
SdkError<PutDedicatedIpInPoolError>
sourcepub fn put_dedicated_ip_warmup_attributes(
&self
) -> PutDedicatedIpWarmupAttributes
pub fn put_dedicated_ip_warmup_attributes(
&self
) -> PutDedicatedIpWarmupAttributes
Constructs a fluent builder for the PutDedicatedIpWarmupAttributes
operation.
- The fluent builder is configurable:
ip(impl Into<String>)
/set_ip(Option<String>)
:The dedicated IP address that you want to update the warm-up attributes for.
warmup_percentage(i32)
/set_warmup_percentage(Option<i32>)
:The warm-up percentage that you want to associate with the dedicated IP address.
- On success, responds with
PutDedicatedIpWarmupAttributesOutput
- On failure, responds with
SdkError<PutDedicatedIpWarmupAttributesError>
sourcepub fn put_deliverability_dashboard_option(
&self
) -> PutDeliverabilityDashboardOption
pub fn put_deliverability_dashboard_option(
&self
) -> PutDeliverabilityDashboardOption
Constructs a fluent builder for the PutDeliverabilityDashboardOption
operation.
- The fluent builder is configurable:
dashboard_enabled(bool)
/set_dashboard_enabled(bool)
:Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the dashboard, set this value to
true
.subscribed_domains(Vec<DomainDeliverabilityTrackingOption>)
/set_subscribed_domains(Option<Vec<DomainDeliverabilityTrackingOption>>)
:An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.
- On success, responds with
PutDeliverabilityDashboardOptionOutput
- On failure, responds with
SdkError<PutDeliverabilityDashboardOptionError>
sourcepub fn put_email_identity_dkim_attributes(
&self
) -> PutEmailIdentityDkimAttributes
pub fn put_email_identity_dkim_attributes(
&self
) -> PutEmailIdentityDkimAttributes
Constructs a fluent builder for the PutEmailIdentityDkimAttributes
operation.
- The fluent builder is configurable:
email_identity(impl Into<String>)
/set_email_identity(Option<String>)
:The email identity that you want to change the DKIM settings for.
signing_enabled(bool)
/set_signing_enabled(bool)
:Sets the DKIM signing configuration for the identity.
When you set this value
true
, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. When you set this value tofalse
, then the messages that Amazon Pinpoint sends from the identity aren’t DKIM-signed.
- On success, responds with
PutEmailIdentityDkimAttributesOutput
- On failure, responds with
SdkError<PutEmailIdentityDkimAttributesError>
sourcepub fn put_email_identity_feedback_attributes(
&self
) -> PutEmailIdentityFeedbackAttributes
pub fn put_email_identity_feedback_attributes(
&self
) -> PutEmailIdentityFeedbackAttributes
Constructs a fluent builder for the PutEmailIdentityFeedbackAttributes
operation.
- The fluent builder is configurable:
email_identity(impl Into<String>)
/set_email_identity(Option<String>)
:The email identity that you want to configure bounce and complaint feedback forwarding for.
email_forwarding_enabled(bool)
/set_email_forwarding_enabled(bool)
:Sets the feedback forwarding configuration for the identity.
If the value is
true
, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.When you set this value to
false
, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You’re required to have a method of tracking bounces and complaints. If you haven’t set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
- On success, responds with
PutEmailIdentityFeedbackAttributesOutput
- On failure, responds with
SdkError<PutEmailIdentityFeedbackAttributesError>
sourcepub fn put_email_identity_mail_from_attributes(
&self
) -> PutEmailIdentityMailFromAttributes
pub fn put_email_identity_mail_from_attributes(
&self
) -> PutEmailIdentityMailFromAttributes
Constructs a fluent builder for the PutEmailIdentityMailFromAttributes
operation.
- The fluent builder is configurable:
email_identity(impl Into<String>)
/set_email_identity(Option<String>)
:The verified email identity that you want to set up the custom MAIL FROM domain for.
mail_from_domain(impl Into<String>)
/set_mail_from_domain(Option<String>)
:The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:
-
It has to be a subdomain of the verified identity.
-
It can’t be used to receive email.
-
It can’t be used in a “From” address if the MAIL FROM domain is a destination for feedback forwarding emails.
-
behavior_on_mx_failure(BehaviorOnMxFailure)
/set_behavior_on_mx_failure(Option<BehaviorOnMxFailure>)
:The action that you want Amazon Pinpoint to take if it can’t read the required MX record when you send an email. When you set this value to
UseDefaultValue
, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value toRejectMessage
, Amazon Pinpoint returns aMailFromDomainNotVerified
error, and doesn’t attempt to deliver the email.These behaviors are taken when the custom MAIL FROM domain configuration is in the
Pending
,Failed
, andTemporaryFailure
states.
- On success, responds with
PutEmailIdentityMailFromAttributesOutput
- On failure, responds with
SdkError<PutEmailIdentityMailFromAttributesError>
sourcepub fn send_email(&self) -> SendEmail
pub fn send_email(&self) -> SendEmail
Constructs a fluent builder for the SendEmail
operation.
- The fluent builder is configurable:
from_email_address(impl Into<String>)
/set_from_email_address(Option<String>)
:The email address that you want to use as the “From” address for the email. The address that you specify has to be verified.
destination(Destination)
/set_destination(Option<Destination>)
:An object that contains the recipients of the email message.
reply_to_addresses(Vec<String>)
/set_reply_to_addresses(Option<Vec<String>>)
:The “Reply-to” email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
feedback_forwarding_email_address(impl Into<String>)
/set_feedback_forwarding_email_address(Option<String>)
:The address that Amazon Pinpoint should send bounce and complaint notifications to.
content(EmailContent)
/set_content(Option<EmailContent>)
:An object that contains the body of the message. You can send either a Simple message or a Raw message.
email_tags(Vec<MessageTag>)
/set_email_tags(Option<Vec<MessageTag>>)
:A list of tags, in the form of name/value pairs, to apply to an email that you send using the
SendEmail
operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:The name of the configuration set that you want to use when sending the email.
- On success, responds with
SendEmailOutput
with field(s):message_id(Option<String>)
:A unique identifier for the message that is generated when Amazon Pinpoint accepts the message.
It is possible for Amazon Pinpoint to accept a message without sending it. This can happen when the message you’re trying to send has an attachment doesn’t pass a virus check, or when you send a templated email that contains invalid personalization content, for example.
- On failure, responds with
SdkError<SendEmailError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of the tags that you want to add to the resource. A tag consists of a required tag key (
Key
) and an associated tag value (Value
). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.
To remove more than one tag from the resource, append the
TagKeys
parameter and argument for each additional tag to remove, separated by an ampersand. For example:/v1/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_configuration_set_event_destination(
&self
) -> UpdateConfigurationSetEventDestination
pub fn update_configuration_set_event_destination(
&self
) -> UpdateConfigurationSetEventDestination
Constructs a fluent builder for the UpdateConfigurationSetEventDestination
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:The name of the configuration set that contains the event destination that you want to modify.
event_destination_name(impl Into<String>)
/set_event_destination_name(Option<String>)
:The name of the event destination that you want to modify.
event_destination(EventDestinationDefinition)
/set_event_destination(Option<EventDestinationDefinition>)
:An object that defines the event destination.
- On success, responds with
UpdateConfigurationSetEventDestinationOutput
- On failure, responds with
SdkError<UpdateConfigurationSetEventDestinationError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more