Struct aws_sdk_pinpoint::Client

pub struct Client { /* private fields */ }

Client for Amazon Pinpoint

Client for invoking operations on Amazon Pinpoint. Each operation on Amazon Pinpoint is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_pinpoint::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_pinpoint::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateCampaign operation has a Client::create_campaign, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_campaign()
    .application_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_app(&self) -> CreateAppFluentBuilder

Constructs a fluent builder for the CreateApp operation.

• The fluent builder is configurable:
  • create_application_request(CreateApplicationRequest) / set_create_application_request(Option<CreateApplicationRequest>):
    required: true
    

    Specifies the display name of an application and the tags to associate with the application.

    
    
• On success, responds with CreateAppOutput with field(s):
  • application_response(Option<ApplicationResponse>):

    Provides information about an application.

• On failure, responds with SdkError<CreateAppError>

impl Client

pub fn create_campaign(&self) -> CreateCampaignFluentBuilder

Constructs a fluent builder for the CreateCampaign operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • write_campaign_request(WriteCampaignRequest) / set_write_campaign_request(Option<WriteCampaignRequest>):
    required: true
    

    Specifies the configuration and other settings for a campaign.

    
    
• On success, responds with CreateCampaignOutput with field(s):
  • campaign_response(Option<CampaignResponse>):

    Provides information about the status, configuration, and other settings for a campaign.

• On failure, responds with SdkError<CreateCampaignError>

impl Client

pub fn create_email_template(&self) -> CreateEmailTemplateFluentBuilder

Constructs a fluent builder for the CreateEmailTemplate operation.

• The fluent builder is configurable:
  • email_template_request(EmailTemplateRequest) / set_email_template_request(Option<EmailTemplateRequest>):
    required: true
    

    Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
• On success, responds with CreateEmailTemplateOutput with field(s):
  • create_template_message_body(Option<CreateTemplateMessageBody>):

    Provides information about a request to create a message template.

• On failure, responds with SdkError<CreateEmailTemplateError>

impl Client

pub fn create_export_job(&self) -> CreateExportJobFluentBuilder

Constructs a fluent builder for the CreateExportJob operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • export_job_request(ExportJobRequest) / set_export_job_request(Option<ExportJobRequest>):
    required: true
    

    Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.

    
    
• On success, responds with CreateExportJobOutput with field(s):
  • export_job_response(Option<ExportJobResponse>):

    Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

• On failure, responds with SdkError<CreateExportJobError>

impl Client

pub fn create_import_job(&self) -> CreateImportJobFluentBuilder

Constructs a fluent builder for the CreateImportJob operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • import_job_request(ImportJobRequest) / set_import_job_request(Option<ImportJobRequest>):
    required: true
    

    Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.

    
    
• On success, responds with CreateImportJobOutput with field(s):
  • import_job_response(Option<ImportJobResponse>):

    Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.

• On failure, responds with SdkError<CreateImportJobError>

impl Client

pub fn create_in_app_template(&self) -> CreateInAppTemplateFluentBuilder

Constructs a fluent builder for the CreateInAppTemplate operation.

• The fluent builder is configurable:
  • in_app_template_request(InAppTemplateRequest) / set_in_app_template_request(Option<InAppTemplateRequest>):
    required: true
    

    InApp Template Request.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
• On success, responds with CreateInAppTemplateOutput with field(s):
  • template_create_message_body(Option<TemplateCreateMessageBody>):

    Provides information about a request to create a message template.

• On failure, responds with SdkError<CreateInAppTemplateError>

impl Client

pub fn create_journey(&self) -> CreateJourneyFluentBuilder

Constructs a fluent builder for the CreateJourney operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • write_journey_request(WriteJourneyRequest) / set_write_journey_request(Option<WriteJourneyRequest>):
    required: true
    

    Specifies the configuration and other settings for a journey.

    
    
• On success, responds with CreateJourneyOutput with field(s):
  • journey_response(Option<JourneyResponse>):

    Provides information about the status, configuration, and other settings for a journey.

• On failure, responds with SdkError<CreateJourneyError>

impl Client

pub fn create_push_template(&self) -> CreatePushTemplateFluentBuilder

Constructs a fluent builder for the CreatePushTemplate operation.

• The fluent builder is configurable:
  • push_notification_template_request(PushNotificationTemplateRequest) / set_push_notification_template_request(Option<PushNotificationTemplateRequest>):
    required: true
    

    Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
• On success, responds with CreatePushTemplateOutput with field(s):
  • create_template_message_body(Option<CreateTemplateMessageBody>):

    Provides information about a request to create a message template.

• On failure, responds with SdkError<CreatePushTemplateError>

impl Client

pub fn create_recommender_configuration( &self ) -> CreateRecommenderConfigurationFluentBuilder

Constructs a fluent builder for the CreateRecommenderConfiguration operation.

• The fluent builder is configurable:
  • create_recommender_configuration(CreateRecommenderConfigurationShape) / set_create_recommender_configuration(Option<CreateRecommenderConfigurationShape>):
    required: true
    

    Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

    
    
• On success, responds with CreateRecommenderConfigurationOutput with field(s):
  • recommender_configuration_response(Option<RecommenderConfigurationResponse>):

    Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

• On failure, responds with SdkError<CreateRecommenderConfigurationError>

impl Client

pub fn create_segment(&self) -> CreateSegmentFluentBuilder

Constructs a fluent builder for the CreateSegment operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • write_segment_request(WriteSegmentRequest) / set_write_segment_request(Option<WriteSegmentRequest>):
    required: true
    

    Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.

    
    
• On success, responds with CreateSegmentOutput with field(s):
  • segment_response(Option<SegmentResponse>):

    Provides information about the configuration, dimension, and other settings for a segment.

• On failure, responds with SdkError<CreateSegmentError>

impl Client

pub fn create_sms_template(&self) -> CreateSmsTemplateFluentBuilder

Constructs a fluent builder for the CreateSmsTemplate operation.

• The fluent builder is configurable:
  • sms_template_request(SmsTemplateRequest) / set_sms_template_request(Option<SmsTemplateRequest>):
    required: true
    

    Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
• On success, responds with CreateSmsTemplateOutput with field(s):
  • create_template_message_body(Option<CreateTemplateMessageBody>):

    Provides information about a request to create a message template.

• On failure, responds with SdkError<CreateSmsTemplateError>

impl Client

pub fn create_voice_template(&self) -> CreateVoiceTemplateFluentBuilder

Constructs a fluent builder for the CreateVoiceTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • voice_template_request(VoiceTemplateRequest) / set_voice_template_request(Option<VoiceTemplateRequest>):
    required: true
    

    Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

    
    
• On success, responds with CreateVoiceTemplateOutput with field(s):
  • create_template_message_body(Option<CreateTemplateMessageBody>):

    Provides information about a request to create a message template.

• On failure, responds with SdkError<CreateVoiceTemplateError>

impl Client

pub fn delete_adm_channel(&self) -> DeleteAdmChannelFluentBuilder

Constructs a fluent builder for the DeleteAdmChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with DeleteAdmChannelOutput with field(s):
  • adm_channel_response(Option<AdmChannelResponse>):

    Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

• On failure, responds with SdkError<DeleteAdmChannelError>

impl Client

pub fn delete_apns_channel(&self) -> DeleteApnsChannelFluentBuilder

Constructs a fluent builder for the DeleteApnsChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with DeleteApnsChannelOutput with field(s):
  • apns_channel_response(Option<ApnsChannelResponse>):

    Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

• On failure, responds with SdkError<DeleteApnsChannelError>

impl Client

pub fn delete_apns_sandbox_channel( &self ) -> DeleteApnsSandboxChannelFluentBuilder

Constructs a fluent builder for the DeleteApnsSandboxChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with DeleteApnsSandboxChannelOutput with field(s):
  • apns_sandbox_channel_response(Option<ApnsSandboxChannelResponse>):

    Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

• On failure, responds with SdkError<DeleteApnsSandboxChannelError>

impl Client

pub fn delete_apns_voip_channel(&self) -> DeleteApnsVoipChannelFluentBuilder

Constructs a fluent builder for the DeleteApnsVoipChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with DeleteApnsVoipChannelOutput with field(s):
  • apns_voip_channel_response(Option<ApnsVoipChannelResponse>):

    Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

• On failure, responds with SdkError<DeleteApnsVoipChannelError>

impl Client

pub fn delete_apns_voip_sandbox_channel( &self ) -> DeleteApnsVoipSandboxChannelFluentBuilder

Constructs a fluent builder for the DeleteApnsVoipSandboxChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with DeleteApnsVoipSandboxChannelOutput with field(s):
  • apns_voip_sandbox_channel_response(Option<ApnsVoipSandboxChannelResponse>):

    Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

• On failure, responds with SdkError<DeleteApnsVoipSandboxChannelError>

impl Client

pub fn delete_app(&self) -> DeleteAppFluentBuilder

Constructs a fluent builder for the DeleteApp operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with DeleteAppOutput with field(s):
  • application_response(Option<ApplicationResponse>):

    Provides information about an application.

• On failure, responds with SdkError<DeleteAppError>

impl Client

pub fn delete_baidu_channel(&self) -> DeleteBaiduChannelFluentBuilder

Constructs a fluent builder for the DeleteBaiduChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with DeleteBaiduChannelOutput with field(s):
  • baidu_channel_response(Option<BaiduChannelResponse>):

    Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

• On failure, responds with SdkError<DeleteBaiduChannelError>

impl Client

pub fn delete_campaign(&self) -> DeleteCampaignFluentBuilder

Constructs a fluent builder for the DeleteCampaign operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • campaign_id(impl Into<String>) / set_campaign_id(Option<String>):
    required: true
    

    The unique identifier for the campaign.

    
    
• On success, responds with DeleteCampaignOutput with field(s):
  • campaign_response(Option<CampaignResponse>):

    Provides information about the status, configuration, and other settings for a campaign.

• On failure, responds with SdkError<DeleteCampaignError>

impl Client

pub fn delete_email_channel(&self) -> DeleteEmailChannelFluentBuilder

Constructs a fluent builder for the DeleteEmailChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with DeleteEmailChannelOutput with field(s):
  • email_channel_response(Option<EmailChannelResponse>):

    Provides information about the status and settings of the email channel for an application.

• On failure, responds with SdkError<DeleteEmailChannelError>

impl Client

pub fn delete_email_template(&self) -> DeleteEmailTemplateFluentBuilder

Constructs a fluent builder for the DeleteEmailTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
• On success, responds with DeleteEmailTemplateOutput with field(s):
  • message_body(Option<MessageBody>):

    Provides information about an API request or response.

• On failure, responds with SdkError<DeleteEmailTemplateError>

impl Client

pub fn delete_endpoint(&self) -> DeleteEndpointFluentBuilder

Constructs a fluent builder for the DeleteEndpoint operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • endpoint_id(impl Into<String>) / set_endpoint_id(Option<String>):
    required: true
    

    The case insensitive unique identifier for the endpoint. The identifier can’t contain $, { or }.

    
    
• On success, responds with DeleteEndpointOutput with field(s):
  • endpoint_response(Option<EndpointResponse>):

    Provides information about the channel type and other settings for an endpoint.

• On failure, responds with SdkError<DeleteEndpointError>

impl Client

pub fn delete_event_stream(&self) -> DeleteEventStreamFluentBuilder

Constructs a fluent builder for the DeleteEventStream operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with DeleteEventStreamOutput with field(s):
  • event_stream(Option<EventStream>):

    Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

• On failure, responds with SdkError<DeleteEventStreamError>

impl Client

pub fn delete_gcm_channel(&self) -> DeleteGcmChannelFluentBuilder

Constructs a fluent builder for the DeleteGcmChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with DeleteGcmChannelOutput with field(s):
  • gcm_channel_response(Option<GcmChannelResponse>):

    Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

• On failure, responds with SdkError<DeleteGcmChannelError>

impl Client

pub fn delete_in_app_template(&self) -> DeleteInAppTemplateFluentBuilder

Constructs a fluent builder for the DeleteInAppTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
• On success, responds with DeleteInAppTemplateOutput with field(s):
  • message_body(Option<MessageBody>):

    Provides information about an API request or response.

• On failure, responds with SdkError<DeleteInAppTemplateError>

impl Client

pub fn delete_journey(&self) -> DeleteJourneyFluentBuilder

Constructs a fluent builder for the DeleteJourney operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • journey_id(impl Into<String>) / set_journey_id(Option<String>):
    required: true
    

    The unique identifier for the journey.

    
    
• On success, responds with DeleteJourneyOutput with field(s):
  • journey_response(Option<JourneyResponse>):

    Provides information about the status, configuration, and other settings for a journey.

• On failure, responds with SdkError<DeleteJourneyError>

impl Client

pub fn delete_push_template(&self) -> DeletePushTemplateFluentBuilder

Constructs a fluent builder for the DeletePushTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
• On success, responds with DeletePushTemplateOutput with field(s):
  • message_body(Option<MessageBody>):

    Provides information about an API request or response.

• On failure, responds with SdkError<DeletePushTemplateError>

impl Client

pub fn delete_recommender_configuration( &self ) -> DeleteRecommenderConfigurationFluentBuilder

Constructs a fluent builder for the DeleteRecommenderConfiguration operation.

• The fluent builder is configurable:
  • recommender_id(impl Into<String>) / set_recommender_id(Option<String>):
    required: true
    

    The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.

    
    
• On success, responds with DeleteRecommenderConfigurationOutput with field(s):
  • recommender_configuration_response(Option<RecommenderConfigurationResponse>):

    Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

• On failure, responds with SdkError<DeleteRecommenderConfigurationError>

impl Client

pub fn delete_segment(&self) -> DeleteSegmentFluentBuilder

Constructs a fluent builder for the DeleteSegment operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • segment_id(impl Into<String>) / set_segment_id(Option<String>):
    required: true
    

    The unique identifier for the segment.

    
    
• On success, responds with DeleteSegmentOutput with field(s):
  • segment_response(Option<SegmentResponse>):

    Provides information about the configuration, dimension, and other settings for a segment.

• On failure, responds with SdkError<DeleteSegmentError>

impl Client

pub fn delete_sms_channel(&self) -> DeleteSmsChannelFluentBuilder

Constructs a fluent builder for the DeleteSmsChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with DeleteSmsChannelOutput with field(s):
  • sms_channel_response(Option<SmsChannelResponse>):

    Provides information about the status and settings of the SMS channel for an application.

• On failure, responds with SdkError<DeleteSmsChannelError>

impl Client

pub fn delete_sms_template(&self) -> DeleteSmsTemplateFluentBuilder

Constructs a fluent builder for the DeleteSmsTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
• On success, responds with DeleteSmsTemplateOutput with field(s):
  • message_body(Option<MessageBody>):

    Provides information about an API request or response.

• On failure, responds with SdkError<DeleteSmsTemplateError>

impl Client

pub fn delete_user_endpoints(&self) -> DeleteUserEndpointsFluentBuilder

Constructs a fluent builder for the DeleteUserEndpoints operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The unique identifier for the user.

    
    
• On success, responds with DeleteUserEndpointsOutput with field(s):
  • endpoints_response(Option<EndpointsResponse>):

    Provides information about all the endpoints that are associated with a user ID.

• On failure, responds with SdkError<DeleteUserEndpointsError>

impl Client

pub fn delete_voice_channel(&self) -> DeleteVoiceChannelFluentBuilder

Constructs a fluent builder for the DeleteVoiceChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with DeleteVoiceChannelOutput with field(s):
  • voice_channel_response(Option<VoiceChannelResponse>):

    Provides information about the status and settings of the voice channel for an application.

• On failure, responds with SdkError<DeleteVoiceChannelError>

impl Client

pub fn delete_voice_template(&self) -> DeleteVoiceTemplateFluentBuilder

Constructs a fluent builder for the DeleteVoiceTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
• On success, responds with DeleteVoiceTemplateOutput with field(s):
  • message_body(Option<MessageBody>):

    Provides information about an API request or response.

• On failure, responds with SdkError<DeleteVoiceTemplateError>

impl Client

pub fn get_adm_channel(&self) -> GetAdmChannelFluentBuilder

Constructs a fluent builder for the GetAdmChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetAdmChannelOutput with field(s):
  • adm_channel_response(Option<AdmChannelResponse>):

    Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

• On failure, responds with SdkError<GetAdmChannelError>

impl Client

pub fn get_apns_channel(&self) -> GetApnsChannelFluentBuilder

Constructs a fluent builder for the GetApnsChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetApnsChannelOutput with field(s):
  • apns_channel_response(Option<ApnsChannelResponse>):

    Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

• On failure, responds with SdkError<GetApnsChannelError>

impl Client

pub fn get_apns_sandbox_channel(&self) -> GetApnsSandboxChannelFluentBuilder

Constructs a fluent builder for the GetApnsSandboxChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetApnsSandboxChannelOutput with field(s):
  • apns_sandbox_channel_response(Option<ApnsSandboxChannelResponse>):

    Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

• On failure, responds with SdkError<GetApnsSandboxChannelError>

impl Client

pub fn get_apns_voip_channel(&self) -> GetApnsVoipChannelFluentBuilder

Constructs a fluent builder for the GetApnsVoipChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetApnsVoipChannelOutput with field(s):
  • apns_voip_channel_response(Option<ApnsVoipChannelResponse>):

    Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

• On failure, responds with SdkError<GetApnsVoipChannelError>

impl Client

pub fn get_apns_voip_sandbox_channel( &self ) -> GetApnsVoipSandboxChannelFluentBuilder

Constructs a fluent builder for the GetApnsVoipSandboxChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetApnsVoipSandboxChannelOutput with field(s):
  • apns_voip_sandbox_channel_response(Option<ApnsVoipSandboxChannelResponse>):

    Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

• On failure, responds with SdkError<GetApnsVoipSandboxChannelError>

impl Client

pub fn get_app(&self) -> GetAppFluentBuilder

Constructs a fluent builder for the GetApp operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetAppOutput with field(s):
  • application_response(Option<ApplicationResponse>):

    Provides information about an application.

• On failure, responds with SdkError<GetAppError>

impl Client

pub fn get_application_date_range_kpi( &self ) -> GetApplicationDateRangeKpiFluentBuilder

Constructs a fluent builder for the GetApplicationDateRangeKpi operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

    
    
  • kpi_name(impl Into<String>) / set_kpi_name(Option<String>):
    required: true
    

    The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

    
    
• On success, responds with GetApplicationDateRangeKpiOutput with field(s):
  • application_date_range_kpi_response(Option<ApplicationDateRangeKpiResponse>):

    Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query.

• On failure, responds with SdkError<GetApplicationDateRangeKpiError>

impl Client

pub fn get_application_settings(&self) -> GetApplicationSettingsFluentBuilder

Constructs a fluent builder for the GetApplicationSettings operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetApplicationSettingsOutput with field(s):
  • application_settings_resource(Option<ApplicationSettingsResource>):

    Provides information about an application, including the default settings for an application.

• On failure, responds with SdkError<GetApplicationSettingsError>

impl Client

pub fn get_apps(&self) -> GetAppsFluentBuilder

Constructs a fluent builder for the GetApps operation.

• The fluent builder is configurable:
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: false
    

    The NextToken string that specifies which page of results to return in a paginated response.

    
    
• On success, responds with GetAppsOutput with field(s):
  • applications_response(Option<ApplicationsResponse>):

    Provides information about all of your applications.

• On failure, responds with SdkError<GetAppsError>

impl Client

pub fn get_baidu_channel(&self) -> GetBaiduChannelFluentBuilder

Constructs a fluent builder for the GetBaiduChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetBaiduChannelOutput with field(s):
  • baidu_channel_response(Option<BaiduChannelResponse>):

    Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

• On failure, responds with SdkError<GetBaiduChannelError>

impl Client

pub fn get_campaign(&self) -> GetCampaignFluentBuilder

Constructs a fluent builder for the GetCampaign operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • campaign_id(impl Into<String>) / set_campaign_id(Option<String>):
    required: true
    

    The unique identifier for the campaign.

    
    
• On success, responds with GetCampaignOutput with field(s):
  • campaign_response(Option<CampaignResponse>):

    Provides information about the status, configuration, and other settings for a campaign.

• On failure, responds with SdkError<GetCampaignError>

impl Client

pub fn get_campaign_activities(&self) -> GetCampaignActivitiesFluentBuilder

Constructs a fluent builder for the GetCampaignActivities operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • campaign_id(impl Into<String>) / set_campaign_id(Option<String>):
    required: true
    

    The unique identifier for the campaign.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: false
    

    The NextToken string that specifies which page of results to return in a paginated response.

    
    
• On success, responds with GetCampaignActivitiesOutput with field(s):
  • activities_response(Option<ActivitiesResponse>):

    Provides information about the activities that were performed by a campaign.

• On failure, responds with SdkError<GetCampaignActivitiesError>

impl Client

pub fn get_campaign_date_range_kpi( &self ) -> GetCampaignDateRangeKpiFluentBuilder

Constructs a fluent builder for the GetCampaignDateRangeKpi operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • campaign_id(impl Into<String>) / set_campaign_id(Option<String>):
    required: true
    

    The unique identifier for the campaign.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

    
    
  • kpi_name(impl Into<String>) / set_kpi_name(Option<String>):
    required: true
    

    The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

    
    
• On success, responds with GetCampaignDateRangeKpiOutput with field(s):
  • campaign_date_range_kpi_response(Option<CampaignDateRangeKpiResponse>):

    Provides the results of a query that retrieved the data for a standard metric that applies to a campaign, and provides information about that query.

• On failure, responds with SdkError<GetCampaignDateRangeKpiError>

impl Client

pub fn get_campaign_version(&self) -> GetCampaignVersionFluentBuilder

Constructs a fluent builder for the GetCampaignVersion operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • campaign_id(impl Into<String>) / set_campaign_id(Option<String>):
    required: true
    

    The unique identifier for the campaign.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: true
    

    The unique version number (Version property) for the campaign version.

    
    
• On success, responds with GetCampaignVersionOutput with field(s):
  • campaign_response(Option<CampaignResponse>):

    Provides information about the status, configuration, and other settings for a campaign.

• On failure, responds with SdkError<GetCampaignVersionError>

impl Client

pub fn get_campaign_versions(&self) -> GetCampaignVersionsFluentBuilder

Constructs a fluent builder for the GetCampaignVersions operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • campaign_id(impl Into<String>) / set_campaign_id(Option<String>):
    required: true
    

    The unique identifier for the campaign.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: false
    

    The NextToken string that specifies which page of results to return in a paginated response.

    
    
• On success, responds with GetCampaignVersionsOutput with field(s):
  • campaigns_response(Option<CampaignsResponse>):

    Provides information about the configuration and other settings for all the campaigns that are associated with an application.

• On failure, responds with SdkError<GetCampaignVersionsError>

impl Client

pub fn get_campaigns(&self) -> GetCampaignsFluentBuilder

Constructs a fluent builder for the GetCampaigns operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: false
    

    The NextToken string that specifies which page of results to return in a paginated response.

    
    
• On success, responds with GetCampaignsOutput with field(s):
  • campaigns_response(Option<CampaignsResponse>):

    Provides information about the configuration and other settings for all the campaigns that are associated with an application.

• On failure, responds with SdkError<GetCampaignsError>

impl Client

pub fn get_channels(&self) -> GetChannelsFluentBuilder

Constructs a fluent builder for the GetChannels operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetChannelsOutput with field(s):
  • channels_response(Option<ChannelsResponse>):

    Provides information about the general settings and status of all channels for an application, including channels that aren’t enabled for the application.

• On failure, responds with SdkError<GetChannelsError>

impl Client

pub fn get_email_channel(&self) -> GetEmailChannelFluentBuilder

Constructs a fluent builder for the GetEmailChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetEmailChannelOutput with field(s):
  • email_channel_response(Option<EmailChannelResponse>):

    Provides information about the status and settings of the email channel for an application.

• On failure, responds with SdkError<GetEmailChannelError>

impl Client

pub fn get_email_template(&self) -> GetEmailTemplateFluentBuilder

Constructs a fluent builder for the GetEmailTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
• On success, responds with GetEmailTemplateOutput with field(s):
  • email_template_response(Option<EmailTemplateResponse>):

    Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.

• On failure, responds with SdkError<GetEmailTemplateError>

impl Client

pub fn get_endpoint(&self) -> GetEndpointFluentBuilder

Constructs a fluent builder for the GetEndpoint operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • endpoint_id(impl Into<String>) / set_endpoint_id(Option<String>):
    required: true
    

    The case insensitive unique identifier for the endpoint. The identifier can’t contain $, { or }.

    
    
• On success, responds with GetEndpointOutput with field(s):
  • endpoint_response(Option<EndpointResponse>):

    Provides information about the channel type and other settings for an endpoint.

• On failure, responds with SdkError<GetEndpointError>

impl Client

pub fn get_event_stream(&self) -> GetEventStreamFluentBuilder

Constructs a fluent builder for the GetEventStream operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetEventStreamOutput with field(s):
  • event_stream(Option<EventStream>):

    Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

• On failure, responds with SdkError<GetEventStreamError>

impl Client

pub fn get_export_job(&self) -> GetExportJobFluentBuilder

Constructs a fluent builder for the GetExportJob operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The unique identifier for the job.

    
    
• On success, responds with GetExportJobOutput with field(s):
  • export_job_response(Option<ExportJobResponse>):

    Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

• On failure, responds with SdkError<GetExportJobError>

impl Client

pub fn get_export_jobs(&self) -> GetExportJobsFluentBuilder

Constructs a fluent builder for the GetExportJobs operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: false
    

    The NextToken string that specifies which page of results to return in a paginated response.

    
    
• On success, responds with GetExportJobsOutput with field(s):
  • export_jobs_response(Option<ExportJobsResponse>):

    Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.

• On failure, responds with SdkError<GetExportJobsError>

impl Client

pub fn get_gcm_channel(&self) -> GetGcmChannelFluentBuilder

Constructs a fluent builder for the GetGcmChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetGcmChannelOutput with field(s):
  • gcm_channel_response(Option<GcmChannelResponse>):

    Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

• On failure, responds with SdkError<GetGcmChannelError>

impl Client

pub fn get_import_job(&self) -> GetImportJobFluentBuilder

Constructs a fluent builder for the GetImportJob operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The unique identifier for the job.

    
    
• On success, responds with GetImportJobOutput with field(s):
  • import_job_response(Option<ImportJobResponse>):

    Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.

• On failure, responds with SdkError<GetImportJobError>

impl Client

pub fn get_import_jobs(&self) -> GetImportJobsFluentBuilder

Constructs a fluent builder for the GetImportJobs operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: false
    

    The NextToken string that specifies which page of results to return in a paginated response.

    
    
• On success, responds with GetImportJobsOutput with field(s):
  • import_jobs_response(Option<ImportJobsResponse>):

    Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.

• On failure, responds with SdkError<GetImportJobsError>

impl Client

pub fn get_in_app_messages(&self) -> GetInAppMessagesFluentBuilder

Constructs a fluent builder for the GetInAppMessages operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • endpoint_id(impl Into<String>) / set_endpoint_id(Option<String>):
    required: true
    

    The unique identifier for the endpoint.

    
    
• On success, responds with GetInAppMessagesOutput with field(s):
  • in_app_messages_response(Option<InAppMessagesResponse>):

    Get in-app messages response object.

• On failure, responds with SdkError<GetInAppMessagesError>

impl Client

pub fn get_in_app_template(&self) -> GetInAppTemplateFluentBuilder

Constructs a fluent builder for the GetInAppTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
• On success, responds with GetInAppTemplateOutput with field(s):
  • in_app_template_response(Option<InAppTemplateResponse>):

    In-App Template Response.

• On failure, responds with SdkError<GetInAppTemplateError>

impl Client

pub fn get_journey(&self) -> GetJourneyFluentBuilder

Constructs a fluent builder for the GetJourney operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • journey_id(impl Into<String>) / set_journey_id(Option<String>):
    required: true
    

    The unique identifier for the journey.

    
    
• On success, responds with GetJourneyOutput with field(s):
  • journey_response(Option<JourneyResponse>):

    Provides information about the status, configuration, and other settings for a journey.

• On failure, responds with SdkError<GetJourneyError>

impl Client

pub fn get_journey_date_range_kpi(&self) -> GetJourneyDateRangeKpiFluentBuilder

Constructs a fluent builder for the GetJourneyDateRangeKpi operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

    
    
  • journey_id(impl Into<String>) / set_journey_id(Option<String>):
    required: true
    

    The unique identifier for the journey.

    
    
  • kpi_name(impl Into<String>) / set_kpi_name(Option<String>):
    required: true
    

    The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

    
    
• On success, responds with GetJourneyDateRangeKpiOutput with field(s):
  • journey_date_range_kpi_response(Option<JourneyDateRangeKpiResponse>):

    Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.

• On failure, responds with SdkError<GetJourneyDateRangeKpiError>

impl Client

pub fn get_journey_execution_activity_metrics( &self ) -> GetJourneyExecutionActivityMetricsFluentBuilder

Constructs a fluent builder for the GetJourneyExecutionActivityMetrics operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • journey_activity_id(impl Into<String>) / set_journey_activity_id(Option<String>):
    required: true
    

    The unique identifier for the journey activity.

    
    
  • journey_id(impl Into<String>) / set_journey_id(Option<String>):
    required: true
    

    The unique identifier for the journey.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
• On success, responds with GetJourneyExecutionActivityMetricsOutput with field(s):
  • journey_execution_activity_metrics_response(Option<JourneyExecutionActivityMetricsResponse>):

    Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.

• On failure, responds with SdkError<GetJourneyExecutionActivityMetricsError>

impl Client

pub fn get_journey_execution_metrics( &self ) -> GetJourneyExecutionMetricsFluentBuilder

Constructs a fluent builder for the GetJourneyExecutionMetrics operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • journey_id(impl Into<String>) / set_journey_id(Option<String>):
    required: true
    

    The unique identifier for the journey.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
• On success, responds with GetJourneyExecutionMetricsOutput with field(s):
  • journey_execution_metrics_response(Option<JourneyExecutionMetricsResponse>):

    Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.

• On failure, responds with SdkError<GetJourneyExecutionMetricsError>

impl Client

pub fn get_journey_run_execution_activity_metrics( &self ) -> GetJourneyRunExecutionActivityMetricsFluentBuilder

Constructs a fluent builder for the GetJourneyRunExecutionActivityMetrics operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • journey_activity_id(impl Into<String>) / set_journey_activity_id(Option<String>):
    required: true
    

    The unique identifier for the journey activity.

    
    
  • journey_id(impl Into<String>) / set_journey_id(Option<String>):
    required: true
    

    The unique identifier for the journey.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • run_id(impl Into<String>) / set_run_id(Option<String>):
    required: true
    

    The unique identifier for the journey run.

    
    
• On success, responds with GetJourneyRunExecutionActivityMetricsOutput with field(s):
  • journey_run_execution_activity_metrics_response(Option<JourneyRunExecutionActivityMetricsResponse>):

    Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity for a particular journey run, and provides information about that query.

• On failure, responds with SdkError<GetJourneyRunExecutionActivityMetricsError>

impl Client

pub fn get_journey_run_execution_metrics( &self ) -> GetJourneyRunExecutionMetricsFluentBuilder

Constructs a fluent builder for the GetJourneyRunExecutionMetrics operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • journey_id(impl Into<String>) / set_journey_id(Option<String>):
    required: true
    

    The unique identifier for the journey.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • run_id(impl Into<String>) / set_run_id(Option<String>):
    required: true
    

    The unique identifier for the journey run.

    
    
• On success, responds with GetJourneyRunExecutionMetricsOutput with field(s):
  • journey_run_execution_metrics_response(Option<JourneyRunExecutionMetricsResponse>):

    Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey run, and provides information about that query.

• On failure, responds with SdkError<GetJourneyRunExecutionMetricsError>

impl Client

pub fn get_journey_runs(&self) -> GetJourneyRunsFluentBuilder

Constructs a fluent builder for the GetJourneyRuns operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • journey_id(impl Into<String>) / set_journey_id(Option<String>):
    required: true
    

    The unique identifier for the journey.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: false
    

    The NextToken string that specifies which page of results to return in a paginated response.

    
    
• On success, responds with GetJourneyRunsOutput with field(s):
  • journey_runs_response(Option<JourneyRunsResponse>):

    Provides information from all runs of a journey.

• On failure, responds with SdkError<GetJourneyRunsError>

impl Client

pub fn get_push_template(&self) -> GetPushTemplateFluentBuilder

Constructs a fluent builder for the GetPushTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
• On success, responds with GetPushTemplateOutput with field(s):
  • push_notification_template_response(Option<PushNotificationTemplateResponse>):

    Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.

• On failure, responds with SdkError<GetPushTemplateError>

impl Client

pub fn get_recommender_configuration( &self ) -> GetRecommenderConfigurationFluentBuilder

Constructs a fluent builder for the GetRecommenderConfiguration operation.

• The fluent builder is configurable:
  • recommender_id(impl Into<String>) / set_recommender_id(Option<String>):
    required: true
    

    The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetRecommenderConfigurationOutput with field(s):
  • recommender_configuration_response(Option<RecommenderConfigurationResponse>):

    Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

• On failure, responds with SdkError<GetRecommenderConfigurationError>

impl Client

pub fn get_recommender_configurations( &self ) -> GetRecommenderConfigurationsFluentBuilder

Constructs a fluent builder for the GetRecommenderConfigurations operation.

• The fluent builder is configurable:
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: false
    

    The NextToken string that specifies which page of results to return in a paginated response.

    
    
• On success, responds with GetRecommenderConfigurationsOutput with field(s):
  • list_recommender_configurations_response(Option<ListRecommenderConfigurationsResponse>):

    Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

• On failure, responds with SdkError<GetRecommenderConfigurationsError>

impl Client

pub fn get_segment(&self) -> GetSegmentFluentBuilder

Constructs a fluent builder for the GetSegment operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • segment_id(impl Into<String>) / set_segment_id(Option<String>):
    required: true
    

    The unique identifier for the segment.

    
    
• On success, responds with GetSegmentOutput with field(s):
  • segment_response(Option<SegmentResponse>):

    Provides information about the configuration, dimension, and other settings for a segment.

• On failure, responds with SdkError<GetSegmentError>

impl Client

pub fn get_segment_export_jobs(&self) -> GetSegmentExportJobsFluentBuilder

Constructs a fluent builder for the GetSegmentExportJobs operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • segment_id(impl Into<String>) / set_segment_id(Option<String>):
    required: true
    

    The unique identifier for the segment.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: false
    

    The NextToken string that specifies which page of results to return in a paginated response.

    
    
• On success, responds with GetSegmentExportJobsOutput with field(s):
  • export_jobs_response(Option<ExportJobsResponse>):

    Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.

• On failure, responds with SdkError<GetSegmentExportJobsError>

impl Client

pub fn get_segment_import_jobs(&self) -> GetSegmentImportJobsFluentBuilder

Constructs a fluent builder for the GetSegmentImportJobs operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • segment_id(impl Into<String>) / set_segment_id(Option<String>):
    required: true
    

    The unique identifier for the segment.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: false
    

    The NextToken string that specifies which page of results to return in a paginated response.

    
    
• On success, responds with GetSegmentImportJobsOutput with field(s):
  • import_jobs_response(Option<ImportJobsResponse>):

    Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.

• On failure, responds with SdkError<GetSegmentImportJobsError>

impl Client

pub fn get_segment_version(&self) -> GetSegmentVersionFluentBuilder

Constructs a fluent builder for the GetSegmentVersion operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • segment_id(impl Into<String>) / set_segment_id(Option<String>):
    required: true
    

    The unique identifier for the segment.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: true
    

    The unique version number (Version property) for the campaign version.

    
    
• On success, responds with GetSegmentVersionOutput with field(s):
  • segment_response(Option<SegmentResponse>):

    Provides information about the configuration, dimension, and other settings for a segment.

• On failure, responds with SdkError<GetSegmentVersionError>

impl Client

pub fn get_segment_versions(&self) -> GetSegmentVersionsFluentBuilder

Constructs a fluent builder for the GetSegmentVersions operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • segment_id(impl Into<String>) / set_segment_id(Option<String>):
    required: true
    

    The unique identifier for the segment.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: false
    

    The NextToken string that specifies which page of results to return in a paginated response.

    
    
• On success, responds with GetSegmentVersionsOutput with field(s):
  • segments_response(Option<SegmentsResponse>):

    Provides information about all the segments that are associated with an application.

• On failure, responds with SdkError<GetSegmentVersionsError>

impl Client

pub fn get_segments(&self) -> GetSegmentsFluentBuilder

Constructs a fluent builder for the GetSegments operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: false
    

    The NextToken string that specifies which page of results to return in a paginated response.

    
    
• On success, responds with GetSegmentsOutput with field(s):
  • segments_response(Option<SegmentsResponse>):

    Provides information about all the segments that are associated with an application.

• On failure, responds with SdkError<GetSegmentsError>

impl Client

pub fn get_sms_channel(&self) -> GetSmsChannelFluentBuilder

Constructs a fluent builder for the GetSmsChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetSmsChannelOutput with field(s):
  • sms_channel_response(Option<SmsChannelResponse>):

    Provides information about the status and settings of the SMS channel for an application.

• On failure, responds with SdkError<GetSmsChannelError>

impl Client

pub fn get_sms_template(&self) -> GetSmsTemplateFluentBuilder

Constructs a fluent builder for the GetSmsTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
• On success, responds with GetSmsTemplateOutput with field(s):
  • sms_template_response(Option<SmsTemplateResponse>):

    Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

• On failure, responds with SdkError<GetSmsTemplateError>

impl Client

pub fn get_user_endpoints(&self) -> GetUserEndpointsFluentBuilder

Constructs a fluent builder for the GetUserEndpoints operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The unique identifier for the user.

    
    
• On success, responds with GetUserEndpointsOutput with field(s):
  • endpoints_response(Option<EndpointsResponse>):

    Provides information about all the endpoints that are associated with a user ID.

• On failure, responds with SdkError<GetUserEndpointsError>

impl Client

pub fn get_voice_channel(&self) -> GetVoiceChannelFluentBuilder

Constructs a fluent builder for the GetVoiceChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with GetVoiceChannelOutput with field(s):
  • voice_channel_response(Option<VoiceChannelResponse>):

    Provides information about the status and settings of the voice channel for an application.

• On failure, responds with SdkError<GetVoiceChannelError>

impl Client

pub fn get_voice_template(&self) -> GetVoiceTemplateFluentBuilder

Constructs a fluent builder for the GetVoiceTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
• On success, responds with GetVoiceTemplateOutput with field(s):
  • voice_template_response(Option<VoiceTemplateResponse>):

    Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.

• On failure, responds with SdkError<GetVoiceTemplateError>

impl Client

pub fn list_journeys(&self) -> ListJourneysFluentBuilder

Constructs a fluent builder for the ListJourneys operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: false
    

    The NextToken string that specifies which page of results to return in a paginated response.

    
    
• On success, responds with ListJourneysOutput with field(s):
  • journeys_response(Option<JourneysResponse>):

    Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.

• On failure, responds with SdkError<ListJourneysError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags_model(Option<TagsModel>):

    Specifies the tags (keys and values) for an application, campaign, message template, or segment.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_template_versions(&self) -> ListTemplateVersionsFluentBuilder

Constructs a fluent builder for the ListTemplateVersions operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • template_type(impl Into<String>) / set_template_type(Option<String>):
    required: true
    

    The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.

    
    
• On success, responds with ListTemplateVersionsOutput with field(s):
  • template_versions_response(Option<TemplateVersionsResponse>):

    Provides information about all the versions of a specific message template.

• On failure, responds with SdkError<ListTemplateVersionsError>

impl Client

pub fn list_templates(&self) -> ListTemplatesFluentBuilder

Constructs a fluent builder for the ListTemplates operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • page_size(impl Into<String>) / set_page_size(Option<String>):
    required: false
    

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    
    
  • prefix(impl Into<String>) / set_prefix(Option<String>):
    required: false
    

    The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

    
    
  • template_type(impl Into<String>) / set_template_type(Option<String>):
    required: false
    

    The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don’t include this parameter in your request.

    
    
• On success, responds with ListTemplatesOutput with field(s):
  • templates_response(Option<TemplatesResponse>):

    Provides information about all the message templates that are associated with your Amazon Pinpoint account.

• On failure, responds with SdkError<ListTemplatesError>

impl Client

pub fn phone_number_validate(&self) -> PhoneNumberValidateFluentBuilder

Constructs a fluent builder for the PhoneNumberValidate operation.

• The fluent builder is configurable:
  • number_validate_request(NumberValidateRequest) / set_number_validate_request(Option<NumberValidateRequest>):
    required: true
    

    Specifies a phone number to validate and retrieve information about.

    
    
• On success, responds with PhoneNumberValidateOutput with field(s):
  • number_validate_response(Option<NumberValidateResponse>):

    Provides information about a phone number.

• On failure, responds with SdkError<PhoneNumberValidateError>

impl Client

pub fn put_event_stream(&self) -> PutEventStreamFluentBuilder

Constructs a fluent builder for the PutEventStream operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • write_event_stream(WriteEventStream) / set_write_event_stream(Option<WriteEventStream>):
    required: true
    

    Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.

    
    
• On success, responds with PutEventStreamOutput with field(s):
  • event_stream(Option<EventStream>):

    Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

• On failure, responds with SdkError<PutEventStreamError>

impl Client

pub fn put_events(&self) -> PutEventsFluentBuilder

Constructs a fluent builder for the PutEvents operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • events_request(EventsRequest) / set_events_request(Option<EventsRequest>):
    required: true
    

    Specifies a batch of events to process.

    
    
• On success, responds with PutEventsOutput with field(s):
  • events_response(Option<EventsResponse>):

    Provides information about endpoints and the events that they’re associated with.

• On failure, responds with SdkError<PutEventsError>

impl Client

pub fn remove_attributes(&self) -> RemoveAttributesFluentBuilder

Constructs a fluent builder for the RemoveAttributes operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • attribute_type(impl Into<String>) / set_attribute_type(Option<String>):
    required: true
    

    The type of attribute or attributes to remove. Valid values are:

    • endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.

    • endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.

    • endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.

    
    
  • update_attributes_request(UpdateAttributesRequest) / set_update_attributes_request(Option<UpdateAttributesRequest>):
    required: true
    

    Specifies one or more attributes to remove from all the endpoints that are associated with an application.

    
    
• On success, responds with RemoveAttributesOutput with field(s):
  • attributes_resource(Option<AttributesResource>):

    Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.

• On failure, responds with SdkError<RemoveAttributesError>

impl Client

pub fn send_messages(&self) -> SendMessagesFluentBuilder

Constructs a fluent builder for the SendMessages operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • message_request(MessageRequest) / set_message_request(Option<MessageRequest>):
    required: true
    

    Specifies the configuration and other settings for a message.

    
    
• On success, responds with SendMessagesOutput with field(s):
  • message_response(Option<MessageResponse>):

    Provides information about the results of a request to send a message to an endpoint address.

• On failure, responds with SdkError<SendMessagesError>

impl Client

pub fn send_otp_message(&self) -> SendOTPMessageFluentBuilder

Constructs a fluent builder for the SendOTPMessage operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique ID of your Amazon Pinpoint application.

    
    
  • send_otp_message_request_parameters(SendOtpMessageRequestParameters) / set_send_otp_message_request_parameters(Option<SendOtpMessageRequestParameters>):
    required: true
    

    Send OTP message request parameters.

    
    
• On success, responds with SendOtpMessageOutput with field(s):
  • message_response(Option<MessageResponse>):

    Provides information about the results of a request to send a message to an endpoint address.

• On failure, responds with SdkError<SendOTPMessageError>

impl Client

pub fn send_users_messages(&self) -> SendUsersMessagesFluentBuilder

Constructs a fluent builder for the SendUsersMessages operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • send_users_message_request(SendUsersMessageRequest) / set_send_users_message_request(Option<SendUsersMessageRequest>):
    required: true
    

    Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.

    
    
• On success, responds with SendUsersMessagesOutput with field(s):
  • send_users_message_response(Option<SendUsersMessageResponse>):

    Provides information about which users and endpoints a message was sent to.

• On failure, responds with SdkError<SendUsersMessagesError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tags_model(TagsModel) / set_tags_model(Option<TagsModel>):
    required: true
    

    Specifies the tags (keys and values) for an application, campaign, message template, or segment.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_adm_channel(&self) -> UpdateAdmChannelFluentBuilder

Constructs a fluent builder for the UpdateAdmChannel operation.

• The fluent builder is configurable:
  • adm_channel_request(AdmChannelRequest) / set_adm_channel_request(Option<AdmChannelRequest>):
    required: true
    

    Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.

    
    
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with UpdateAdmChannelOutput with field(s):
  • adm_channel_response(Option<AdmChannelResponse>):

    Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

• On failure, responds with SdkError<UpdateAdmChannelError>

impl Client

pub fn update_apns_channel(&self) -> UpdateApnsChannelFluentBuilder

Constructs a fluent builder for the UpdateApnsChannel operation.

• The fluent builder is configurable:
  • apns_channel_request(ApnsChannelRequest) / set_apns_channel_request(Option<ApnsChannelRequest>):
    required: true
    

    Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.

    
    
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with UpdateApnsChannelOutput with field(s):
  • apns_channel_response(Option<ApnsChannelResponse>):

    Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

• On failure, responds with SdkError<UpdateApnsChannelError>

impl Client

pub fn update_apns_sandbox_channel( &self ) -> UpdateApnsSandboxChannelFluentBuilder

Constructs a fluent builder for the UpdateApnsSandboxChannel operation.

• The fluent builder is configurable:
  • apns_sandbox_channel_request(ApnsSandboxChannelRequest) / set_apns_sandbox_channel_request(Option<ApnsSandboxChannelRequest>):
    required: true
    

    Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

    
    
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with UpdateApnsSandboxChannelOutput with field(s):
  • apns_sandbox_channel_response(Option<ApnsSandboxChannelResponse>):

    Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

• On failure, responds with SdkError<UpdateApnsSandboxChannelError>

impl Client

pub fn update_apns_voip_channel(&self) -> UpdateApnsVoipChannelFluentBuilder

Constructs a fluent builder for the UpdateApnsVoipChannel operation.

• The fluent builder is configurable:
  • apns_voip_channel_request(ApnsVoipChannelRequest) / set_apns_voip_channel_request(Option<ApnsVoipChannelRequest>):
    required: true
    

    Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

    
    
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with UpdateApnsVoipChannelOutput with field(s):
  • apns_voip_channel_response(Option<ApnsVoipChannelResponse>):

    Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

• On failure, responds with SdkError<UpdateApnsVoipChannelError>

impl Client

pub fn update_apns_voip_sandbox_channel( &self ) -> UpdateApnsVoipSandboxChannelFluentBuilder

Constructs a fluent builder for the UpdateApnsVoipSandboxChannel operation.

• The fluent builder is configurable:
  • apns_voip_sandbox_channel_request(ApnsVoipSandboxChannelRequest) / set_apns_voip_sandbox_channel_request(Option<ApnsVoipSandboxChannelRequest>):
    required: true
    

    Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

    
    
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
• On success, responds with UpdateApnsVoipSandboxChannelOutput with field(s):
  • apns_voip_sandbox_channel_response(Option<ApnsVoipSandboxChannelResponse>):

    Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

• On failure, responds with SdkError<UpdateApnsVoipSandboxChannelError>

impl Client

pub fn update_application_settings( &self ) -> UpdateApplicationSettingsFluentBuilder

Constructs a fluent builder for the UpdateApplicationSettings operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • write_application_settings_request(WriteApplicationSettingsRequest) / set_write_application_settings_request(Option<WriteApplicationSettingsRequest>):
    required: true
    

    Specifies the default settings for an application.

    
    
• On success, responds with UpdateApplicationSettingsOutput with field(s):
  • application_settings_resource(Option<ApplicationSettingsResource>):

    Provides information about an application, including the default settings for an application.

• On failure, responds with SdkError<UpdateApplicationSettingsError>

impl Client

pub fn update_baidu_channel(&self) -> UpdateBaiduChannelFluentBuilder

Constructs a fluent builder for the UpdateBaiduChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • baidu_channel_request(BaiduChannelRequest) / set_baidu_channel_request(Option<BaiduChannelRequest>):
    required: true
    

    Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

    
    
• On success, responds with UpdateBaiduChannelOutput with field(s):
  • baidu_channel_response(Option<BaiduChannelResponse>):

    Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

• On failure, responds with SdkError<UpdateBaiduChannelError>

impl Client

pub fn update_campaign(&self) -> UpdateCampaignFluentBuilder

Constructs a fluent builder for the UpdateCampaign operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • campaign_id(impl Into<String>) / set_campaign_id(Option<String>):
    required: true
    

    The unique identifier for the campaign.

    
    
  • write_campaign_request(WriteCampaignRequest) / set_write_campaign_request(Option<WriteCampaignRequest>):
    required: true
    

    Specifies the configuration and other settings for a campaign.

    
    
• On success, responds with UpdateCampaignOutput with field(s):
  • campaign_response(Option<CampaignResponse>):

    Provides information about the status, configuration, and other settings for a campaign.

• On failure, responds with SdkError<UpdateCampaignError>

impl Client

pub fn update_email_channel(&self) -> UpdateEmailChannelFluentBuilder

Constructs a fluent builder for the UpdateEmailChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • email_channel_request(EmailChannelRequest) / set_email_channel_request(Option<EmailChannelRequest>):
    required: true
    

    Specifies the status and settings of the email channel for an application.

    
    
• On success, responds with UpdateEmailChannelOutput with field(s):
  • email_channel_response(Option<EmailChannelResponse>):

    Provides information about the status and settings of the email channel for an application.

• On failure, responds with SdkError<UpdateEmailChannelError>

impl Client

pub fn update_email_template(&self) -> UpdateEmailTemplateFluentBuilder

Constructs a fluent builder for the UpdateEmailTemplate operation.

• The fluent builder is configurable:
  • create_new_version(bool) / set_create_new_version(Option<bool>):
    required: false
    

    Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

    If you don’t specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don’t specify a value for the version parameter. Otherwise, an error will occur.

    
    
  • email_template_request(EmailTemplateRequest) / set_email_template_request(Option<EmailTemplateRequest>):
    required: true
    

    Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
• On success, responds with UpdateEmailTemplateOutput with field(s):
  • message_body(Option<MessageBody>):

    Provides information about an API request or response.

• On failure, responds with SdkError<UpdateEmailTemplateError>

impl Client

pub fn update_endpoint(&self) -> UpdateEndpointFluentBuilder

Constructs a fluent builder for the UpdateEndpoint operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • endpoint_id(impl Into<String>) / set_endpoint_id(Option<String>):
    required: true
    

    The case insensitive unique identifier for the endpoint. The identifier can’t contain $, { or }.

    
    
  • endpoint_request(EndpointRequest) / set_endpoint_request(Option<EndpointRequest>):
    required: true
    

    Specifies the channel type and other settings for an endpoint.

    
    
• On success, responds with UpdateEndpointOutput with field(s):
  • message_body(Option<MessageBody>):

    Provides information about an API request or response.

• On failure, responds with SdkError<UpdateEndpointError>

impl Client

pub fn update_endpoints_batch(&self) -> UpdateEndpointsBatchFluentBuilder

Constructs a fluent builder for the UpdateEndpointsBatch operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • endpoint_batch_request(EndpointBatchRequest) / set_endpoint_batch_request(Option<EndpointBatchRequest>):
    required: true
    

    Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.

    
    
• On success, responds with UpdateEndpointsBatchOutput with field(s):
  • message_body(Option<MessageBody>):

    Provides information about an API request or response.

• On failure, responds with SdkError<UpdateEndpointsBatchError>

impl Client

pub fn update_gcm_channel(&self) -> UpdateGcmChannelFluentBuilder

Constructs a fluent builder for the UpdateGcmChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • gcm_channel_request(GcmChannelRequest) / set_gcm_channel_request(Option<GcmChannelRequest>):
    required: true
    

    Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

    
    
• On success, responds with UpdateGcmChannelOutput with field(s):
  • gcm_channel_response(Option<GcmChannelResponse>):

    Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

• On failure, responds with SdkError<UpdateGcmChannelError>

impl Client

pub fn update_in_app_template(&self) -> UpdateInAppTemplateFluentBuilder

Constructs a fluent builder for the UpdateInAppTemplate operation.

• The fluent builder is configurable:
  • create_new_version(bool) / set_create_new_version(Option<bool>):
    required: false
    

    Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

    If you don’t specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don’t specify a value for the version parameter. Otherwise, an error will occur.

    
    
  • in_app_template_request(InAppTemplateRequest) / set_in_app_template_request(Option<InAppTemplateRequest>):
    required: true
    

    InApp Template Request.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
• On success, responds with UpdateInAppTemplateOutput with field(s):
  • message_body(Option<MessageBody>):

    Provides information about an API request or response.

• On failure, responds with SdkError<UpdateInAppTemplateError>

impl Client

pub fn update_journey(&self) -> UpdateJourneyFluentBuilder

Constructs a fluent builder for the UpdateJourney operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • journey_id(impl Into<String>) / set_journey_id(Option<String>):
    required: true
    

    The unique identifier for the journey.

    
    
  • write_journey_request(WriteJourneyRequest) / set_write_journey_request(Option<WriteJourneyRequest>):
    required: true
    

    Specifies the configuration and other settings for a journey.

    
    
• On success, responds with UpdateJourneyOutput with field(s):
  • journey_response(Option<JourneyResponse>):

    Provides information about the status, configuration, and other settings for a journey.

• On failure, responds with SdkError<UpdateJourneyError>

impl Client

pub fn update_journey_state(&self) -> UpdateJourneyStateFluentBuilder

Constructs a fluent builder for the UpdateJourneyState operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • journey_id(impl Into<String>) / set_journey_id(Option<String>):
    required: true
    

    The unique identifier for the journey.

    
    
  • journey_state_request(JourneyStateRequest) / set_journey_state_request(Option<JourneyStateRequest>):
    required: true
    

    Changes the status of a journey.

    
    
• On success, responds with UpdateJourneyStateOutput with field(s):
  • journey_response(Option<JourneyResponse>):

    Provides information about the status, configuration, and other settings for a journey.

• On failure, responds with SdkError<UpdateJourneyStateError>

impl Client

pub fn update_push_template(&self) -> UpdatePushTemplateFluentBuilder

Constructs a fluent builder for the UpdatePushTemplate operation.

• The fluent builder is configurable:
  • create_new_version(bool) / set_create_new_version(Option<bool>):
    required: false
    

    Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

    If you don’t specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don’t specify a value for the version parameter. Otherwise, an error will occur.

    
    
  • push_notification_template_request(PushNotificationTemplateRequest) / set_push_notification_template_request(Option<PushNotificationTemplateRequest>):
    required: true
    

    Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
• On success, responds with UpdatePushTemplateOutput with field(s):
  • message_body(Option<MessageBody>):

    Provides information about an API request or response.

• On failure, responds with SdkError<UpdatePushTemplateError>

impl Client

pub fn update_recommender_configuration( &self ) -> UpdateRecommenderConfigurationFluentBuilder

Constructs a fluent builder for the UpdateRecommenderConfiguration operation.

• The fluent builder is configurable:
  • recommender_id(impl Into<String>) / set_recommender_id(Option<String>):
    required: true
    

    The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.

    
    
  • update_recommender_configuration(UpdateRecommenderConfigurationShape) / set_update_recommender_configuration(Option<UpdateRecommenderConfigurationShape>):
    required: true
    

    Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

    
    
• On success, responds with UpdateRecommenderConfigurationOutput with field(s):
  • recommender_configuration_response(Option<RecommenderConfigurationResponse>):

    Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

• On failure, responds with SdkError<UpdateRecommenderConfigurationError>

impl Client

pub fn update_segment(&self) -> UpdateSegmentFluentBuilder

Constructs a fluent builder for the UpdateSegment operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • segment_id(impl Into<String>) / set_segment_id(Option<String>):
    required: true
    

    The unique identifier for the segment.

    
    
  • write_segment_request(WriteSegmentRequest) / set_write_segment_request(Option<WriteSegmentRequest>):
    required: true
    

    Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.

    
    
• On success, responds with UpdateSegmentOutput with field(s):
  • segment_response(Option<SegmentResponse>):

    Provides information about the configuration, dimension, and other settings for a segment.

• On failure, responds with SdkError<UpdateSegmentError>

impl Client

pub fn update_sms_channel(&self) -> UpdateSmsChannelFluentBuilder

Constructs a fluent builder for the UpdateSmsChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • sms_channel_request(SmsChannelRequest) / set_sms_channel_request(Option<SmsChannelRequest>):
    required: true
    

    Specifies the status and settings of the SMS channel for an application.

    
    
• On success, responds with UpdateSmsChannelOutput with field(s):
  • sms_channel_response(Option<SmsChannelResponse>):

    Provides information about the status and settings of the SMS channel for an application.

• On failure, responds with SdkError<UpdateSmsChannelError>

impl Client

pub fn update_sms_template(&self) -> UpdateSmsTemplateFluentBuilder

Constructs a fluent builder for the UpdateSmsTemplate operation.

• The fluent builder is configurable:
  • create_new_version(bool) / set_create_new_version(Option<bool>):
    required: false
    

    Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

    If you don’t specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don’t specify a value for the version parameter. Otherwise, an error will occur.

    
    
  • sms_template_request(SmsTemplateRequest) / set_sms_template_request(Option<SmsTemplateRequest>):
    required: true
    

    Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
• On success, responds with UpdateSmsTemplateOutput with field(s):
  • message_body(Option<MessageBody>):

    Provides information about an API request or response.

• On failure, responds with SdkError<UpdateSmsTemplateError>

impl Client

pub fn update_template_active_version( &self ) -> UpdateTemplateActiveVersionFluentBuilder

Constructs a fluent builder for the UpdateTemplateActiveVersion operation.

• The fluent builder is configurable:
  • template_active_version_request(TemplateActiveVersionRequest) / set_template_active_version_request(Option<TemplateActiveVersionRequest>):
    required: true
    

    Specifies which version of a message template to use as the active version of the template.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • template_type(impl Into<String>) / set_template_type(Option<String>):
    required: true
    

    The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.

    
    
• On success, responds with UpdateTemplateActiveVersionOutput with field(s):
  • message_body(Option<MessageBody>):

    Provides information about an API request or response.

• On failure, responds with SdkError<UpdateTemplateActiveVersionError>

impl Client

pub fn update_voice_channel(&self) -> UpdateVoiceChannelFluentBuilder

Constructs a fluent builder for the UpdateVoiceChannel operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    
    
  • voice_channel_request(VoiceChannelRequest) / set_voice_channel_request(Option<VoiceChannelRequest>):
    required: true
    

    Specifies the status and settings of the voice channel for an application.

    
    
• On success, responds with UpdateVoiceChannelOutput with field(s):
  • voice_channel_response(Option<VoiceChannelResponse>):

    Provides information about the status and settings of the voice channel for an application.

• On failure, responds with SdkError<UpdateVoiceChannelError>

impl Client

pub fn update_voice_template(&self) -> UpdateVoiceTemplateFluentBuilder

Constructs a fluent builder for the UpdateVoiceTemplate operation.

• The fluent builder is configurable:
  • create_new_version(bool) / set_create_new_version(Option<bool>):
    required: false
    

    Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

    If you don’t specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don’t specify a value for the version parameter. Otherwise, an error will occur.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    
    
  • voice_template_request(VoiceTemplateRequest) / set_voice_template_request(Option<VoiceTemplateRequest>):
    required: true
    

    Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

    
    
• On success, responds with UpdateVoiceTemplateOutput with field(s):
  • message_body(Option<MessageBody>):

    Provides information about an API request or response.

• On failure, responds with SdkError<UpdateVoiceTemplateError>

impl Client

pub fn verify_otp_message(&self) -> VerifyOTPMessageFluentBuilder

Constructs a fluent builder for the VerifyOTPMessage operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique ID of your Amazon Pinpoint application.

    
    
  • verify_otp_message_request_parameters(VerifyOtpMessageRequestParameters) / set_verify_otp_message_request_parameters(Option<VerifyOtpMessageRequestParameters>):
    required: true
    

    Verify OTP message request.

    
    
• On success, responds with VerifyOtpMessageOutput with field(s):
  • verification_response(Option<VerificationResponse>):

    Verify OTP Message Response.

• On failure, responds with SdkError<VerifyOTPMessageError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.