Struct aws_sdk_mailmanager::Client

pub struct Client { /* private fields */ }

Client for MailManager

Client for invoking operations on MailManager. Each operation on MailManager 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_mailmanager::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_mailmanager::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 GetArchiveExport operation has a Client::get_archive_export, 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.get_archive_export()
    .export_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_addon_instance(&self) -> CreateAddonInstanceFluentBuilder

Constructs a fluent builder for the CreateAddonInstance operation.

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

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    
    
  • addon_subscription_id(impl Into<String>) / set_addon_subscription_id(Option<String>):
    required: true
    

    The unique ID of a previously created subscription that an Add On instance is created for. You can only have one instance per subscription.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags used to organize, track, or control access for the resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateAddonInstanceOutput with field(s):
  • addon_instance_id(String):

    The unique ID of the Add On instance created by this API.

• On failure, responds with SdkError<CreateAddonInstanceError>

impl Client

pub fn create_addon_subscription(&self) -> CreateAddonSubscriptionFluentBuilder

Constructs a fluent builder for the CreateAddonSubscription operation.

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

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    
    
  • addon_name(impl Into<String>) / set_addon_name(Option<String>):
    required: true
    

    The name of the Add On to subscribe to. You can only have one subscription for each Add On name.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags used to organize, track, or control access for the resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateAddonSubscriptionOutput with field(s):
  • addon_subscription_id(String):

    The unique ID of the Add On subscription created by this API.

• On failure, responds with SdkError<CreateAddonSubscriptionError>

impl Client

pub fn create_archive(&self) -> CreateArchiveFluentBuilder

Constructs a fluent builder for the CreateArchive operation.

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

    A unique token Amazon SES uses to recognize retries of this request.

    
    
  • archive_name(impl Into<String>) / set_archive_name(Option<String>):
    required: true
    

    A unique name for the new archive.

    
    
  • retention(ArchiveRetention) / set_retention(Option<ArchiveRetention>):
    required: false
    

    The period for retaining emails in the archive before automatic deletion.

    
    
  • kms_key_arn(impl Into<String>) / set_kms_key_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags used to organize, track, or control access for the resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateArchiveOutput with field(s):
  • archive_id(String):

    The unique identifier for the newly created archive.

• On failure, responds with SdkError<CreateArchiveError>

impl Client

pub fn create_ingress_point(&self) -> CreateIngressPointFluentBuilder

Constructs a fluent builder for the CreateIngressPoint operation.

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

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    
    
  • ingress_point_name(impl Into<String>) / set_ingress_point_name(Option<String>):
    required: true
    

    A user friendly name for an ingress endpoint resource.

    
    
  • r#type(IngressPointType) / set_type(Option<IngressPointType>):
    required: true
    

    The type of the ingress endpoint to create.

    
    
  • rule_set_id(impl Into<String>) / set_rule_set_id(Option<String>):
    required: true
    

    The identifier of an existing rule set that you attach to an ingress endpoint resource.

    
    
  • traffic_policy_id(impl Into<String>) / set_traffic_policy_id(Option<String>):
    required: true
    

    The identifier of an existing traffic policy that you attach to an ingress endpoint resource.

    
    
  • ingress_point_configuration(IngressPointConfiguration) / set_ingress_point_configuration(Option<IngressPointConfiguration>):
    required: false
    

    If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags used to organize, track, or control access for the resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateIngressPointOutput with field(s):
  • ingress_point_id(String):

    The unique identifier for a previously created ingress endpoint.

• On failure, responds with SdkError<CreateIngressPointError>

impl Client

pub fn create_relay(&self) -> CreateRelayFluentBuilder

Constructs a fluent builder for the CreateRelay operation.

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

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    
    
  • relay_name(impl Into<String>) / set_relay_name(Option<String>):
    required: true
    

    The unique name of the relay resource.

    
    
  • server_name(impl Into<String>) / set_server_name(Option<String>):
    required: true
    

    The destination relay server address.

    
    
  • server_port(i32) / set_server_port(Option<i32>):
    required: true
    

    The destination relay server port.

    
    
  • authentication(RelayAuthentication) / set_authentication(Option<RelayAuthentication>):
    required: true
    

    Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags used to organize, track, or control access for the resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateRelayOutput with field(s):
  • relay_id(String):

    A unique identifier of the created relay resource.

• On failure, responds with SdkError<CreateRelayError>

impl Client

pub fn create_rule_set(&self) -> CreateRuleSetFluentBuilder

Constructs a fluent builder for the CreateRuleSet operation.

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

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    
    
  • rule_set_name(impl Into<String>) / set_rule_set_name(Option<String>):
    required: true
    

    A user-friendly name for the rule set.

    
    
  • rules(Rule) / set_rules(Option<Vec::<Rule>>):
    required: true
    

    Conditional rules that are evaluated for determining actions on email.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags used to organize, track, or control access for the resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateRuleSetOutput with field(s):
  • rule_set_id(String):

    The identifier of the created rule set.

• On failure, responds with SdkError<CreateRuleSetError>

impl Client

pub fn create_traffic_policy(&self) -> CreateTrafficPolicyFluentBuilder

Constructs a fluent builder for the CreateTrafficPolicy operation.

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

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    
    
  • traffic_policy_name(impl Into<String>) / set_traffic_policy_name(Option<String>):
    required: true
    

    A user-friendly name for the traffic policy resource.

    
    
  • policy_statements(PolicyStatement) / set_policy_statements(Option<Vec::<PolicyStatement>>):
    required: true
    

    Conditional statements for filtering email traffic.

    
    
  • default_action(AcceptAction) / set_default_action(Option<AcceptAction>):
    required: true
    

    Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements

    
    
  • max_message_size_bytes(i32) / set_max_message_size_bytes(Option<i32>):
    required: false
    

    The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags used to organize, track, or control access for the resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateTrafficPolicyOutput with field(s):
  • traffic_policy_id(String):

    The identifier of the traffic policy resource.

• On failure, responds with SdkError<CreateTrafficPolicyError>

impl Client

pub fn delete_addon_instance(&self) -> DeleteAddonInstanceFluentBuilder

Constructs a fluent builder for the DeleteAddonInstance operation.

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

    The Add On instance ID to delete.

    
    
• On success, responds with DeleteAddonInstanceOutput
• On failure, responds with SdkError<DeleteAddonInstanceError>

impl Client

pub fn delete_addon_subscription(&self) -> DeleteAddonSubscriptionFluentBuilder

Constructs a fluent builder for the DeleteAddonSubscription operation.

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

    The Add On subscription ID to delete.

    
    
• On success, responds with DeleteAddonSubscriptionOutput
• On failure, responds with SdkError<DeleteAddonSubscriptionError>

impl Client

pub fn delete_archive(&self) -> DeleteArchiveFluentBuilder

Constructs a fluent builder for the DeleteArchive operation.

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

    The identifier of the archive to delete.

    
    
• On success, responds with DeleteArchiveOutput
• On failure, responds with SdkError<DeleteArchiveError>

impl Client

pub fn delete_ingress_point(&self) -> DeleteIngressPointFluentBuilder

Constructs a fluent builder for the DeleteIngressPoint operation.

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

    The identifier of the ingress endpoint resource that you want to delete.

    
    
• On success, responds with DeleteIngressPointOutput
• On failure, responds with SdkError<DeleteIngressPointError>

impl Client

pub fn delete_relay(&self) -> DeleteRelayFluentBuilder

Constructs a fluent builder for the DeleteRelay operation.

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

    The unique relay identifier.

    
    
• On success, responds with DeleteRelayOutput
• On failure, responds with SdkError<DeleteRelayError>

impl Client

pub fn delete_rule_set(&self) -> DeleteRuleSetFluentBuilder

Constructs a fluent builder for the DeleteRuleSet operation.

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

    The identifier of an existing rule set resource to delete.

    
    
• On success, responds with DeleteRuleSetOutput
• On failure, responds with SdkError<DeleteRuleSetError>

impl Client

pub fn delete_traffic_policy(&self) -> DeleteTrafficPolicyFluentBuilder

Constructs a fluent builder for the DeleteTrafficPolicy operation.

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

    The identifier of the traffic policy that you want to delete.

    
    
• On success, responds with DeleteTrafficPolicyOutput
• On failure, responds with SdkError<DeleteTrafficPolicyError>

impl Client

pub fn get_addon_instance(&self) -> GetAddonInstanceFluentBuilder

Constructs a fluent builder for the GetAddonInstance operation.

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

    The Add On instance ID to retrieve information for.

    
    
• On success, responds with GetAddonInstanceOutput with field(s):
  • addon_subscription_id(Option<String>):

    The subscription ID associated to the instance.

  • addon_name(Option<String>):

    The name of the Add On provider associated to the subscription of the instance.

  • addon_instance_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Add On instance.

  • created_timestamp(Option<DateTime>):

    The timestamp of when the Add On instance was created.

• On failure, responds with SdkError<GetAddonInstanceError>

impl Client

pub fn get_addon_subscription(&self) -> GetAddonSubscriptionFluentBuilder

Constructs a fluent builder for the GetAddonSubscription operation.

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

    The Add On subscription ID to retrieve information for.

    
    
• On success, responds with GetAddonSubscriptionOutput with field(s):
  • addon_name(Option<String>):

    The name of the Add On for the subscription.

  • addon_subscription_arn(Option<String>):

    Amazon Resource Name (ARN) for the subscription.

  • created_timestamp(Option<DateTime>):

    The timestamp of when the Add On subscription was created.

• On failure, responds with SdkError<GetAddonSubscriptionError>

impl Client

pub fn get_archive(&self) -> GetArchiveFluentBuilder

Constructs a fluent builder for the GetArchive operation.

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

    The identifier of the archive to retrieve.

    
    
• On success, responds with GetArchiveOutput with field(s):
  • archive_id(String):

    The unique identifier of the archive.

  • archive_name(String):

    The unique name assigned to the archive.

  • archive_arn(String):

    The Amazon Resource Name (ARN) of the archive.

  • archive_state(ArchiveState):

    The current state of the archive:

    • ACTIVE – The archive is ready and available for use.

    • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.

  • retention(Option<ArchiveRetention>):

    The retention period for emails in this archive.

  • created_timestamp(Option<DateTime>):

    The timestamp of when the archive was created.

  • last_updated_timestamp(Option<DateTime>):

    The timestamp of when the archive was modified.

  • kms_key_arn(Option<String>):

    The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.

• On failure, responds with SdkError<GetArchiveError>

impl Client

pub fn get_archive_export(&self) -> GetArchiveExportFluentBuilder

Constructs a fluent builder for the GetArchiveExport operation.

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

    The identifier of the export job to get details for.

    
    
• On success, responds with GetArchiveExportOutput with field(s):
  • archive_id(Option<String>):

    The identifier of the archive the email export was performed from.

  • filters(Option<ArchiveFilters>):

    The criteria used to filter emails included in the export.

  • from_timestamp(Option<DateTime>):

    The start of the timestamp range the exported emails cover.

  • to_timestamp(Option<DateTime>):

    The end of the date range the exported emails cover.

  • max_results(Option<i32>):

    The maximum number of email items included in the export.

  • export_destination_configuration(Option<ExportDestinationConfiguration>):

    Where the exported emails are being delivered.

  • status(Option<ExportStatus>):

    The current status of the export job.

• On failure, responds with SdkError<GetArchiveExportError>

impl Client

pub fn get_archive_message(&self) -> GetArchiveMessageFluentBuilder

Constructs a fluent builder for the GetArchiveMessage operation.

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

    The unique identifier of the archived email message.

    
    
• On success, responds with GetArchiveMessageOutput with field(s):
  • message_download_link(Option<String>):

    A pre-signed URL to temporarily download the full message content.

• On failure, responds with SdkError<GetArchiveMessageError>

impl Client

pub fn get_archive_message_content( &self, ) -> GetArchiveMessageContentFluentBuilder

Constructs a fluent builder for the GetArchiveMessageContent operation.

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

    The unique identifier of the archived email message.

    
    
• On success, responds with GetArchiveMessageContentOutput with field(s):
  • body(Option<MessageBody>):

    The textual body content of the email message.

• On failure, responds with SdkError<GetArchiveMessageContentError>

impl Client

pub fn get_archive_search(&self) -> GetArchiveSearchFluentBuilder

Constructs a fluent builder for the GetArchiveSearch operation.

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

    The identifier of the search job to get details for.

    
    
• On success, responds with GetArchiveSearchOutput with field(s):
  • archive_id(Option<String>):

    The identifier of the archive the email search was performed in.

  • filters(Option<ArchiveFilters>):

    The criteria used to filter emails included in the search.

  • from_timestamp(Option<DateTime>):

    The start timestamp of the range the searched emails cover.

  • to_timestamp(Option<DateTime>):

    The end timestamp of the range the searched emails cover.

  • max_results(Option<i32>):

    The maximum number of search results to return.

  • status(Option<SearchStatus>):

    The current status of the search job.

• On failure, responds with SdkError<GetArchiveSearchError>

impl Client

pub fn get_archive_search_results(&self) -> GetArchiveSearchResultsFluentBuilder

Constructs a fluent builder for the GetArchiveSearchResults operation.

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

    The identifier of the completed search job.

    
    
• On success, responds with GetArchiveSearchResultsOutput with field(s):
  • rows(Option<Vec::<Row>>):

    The list of email result objects matching the search criteria.

• On failure, responds with SdkError<GetArchiveSearchResultsError>

impl Client

pub fn get_ingress_point(&self) -> GetIngressPointFluentBuilder

Constructs a fluent builder for the GetIngressPoint operation.

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

    The identifier of an ingress endpoint.

    
    
• On success, responds with GetIngressPointOutput with field(s):
  • ingress_point_id(String):

    The identifier of an ingress endpoint resource.

  • ingress_point_name(String):

    A user friendly name for the ingress endpoint.

  • ingress_point_arn(Option<String>):

    The Amazon Resource Name (ARN) of the ingress endpoint resource.

  • status(Option<IngressPointStatus>):

    The status of the ingress endpoint resource.

  • r#type(Option<IngressPointType>):

    The type of ingress endpoint.

  • a_record(Option<String>):

    The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.

  • rule_set_id(Option<String>):

    The identifier of a rule set resource associated with the ingress endpoint.

  • traffic_policy_id(Option<String>):

    The identifier of the traffic policy resource associated with the ingress endpoint.

  • ingress_point_auth_configuration(Option<IngressPointAuthConfiguration>):

    The authentication configuration of the ingress endpoint resource.

  • created_timestamp(Option<DateTime>):

    The timestamp of when the ingress endpoint was created.

  • last_updated_timestamp(Option<DateTime>):

    The timestamp of when the ingress endpoint was last updated.

• On failure, responds with SdkError<GetIngressPointError>

impl Client

pub fn get_relay(&self) -> GetRelayFluentBuilder

Constructs a fluent builder for the GetRelay operation.

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

    A unique relay identifier.

    
    
• On success, responds with GetRelayOutput with field(s):
  • relay_id(String):

    The unique relay identifier.

  • relay_arn(Option<String>):

    The Amazon Resource Name (ARN) of the relay.

  • relay_name(Option<String>):

    The unique name of the relay.

  • server_name(Option<String>):

    The destination relay server address.

  • server_port(Option<i32>):

    The destination relay server port.

  • authentication(Option<RelayAuthentication>):

    The authentication attribute—contains the secret ARN where the customer relay server credentials are stored.

  • created_timestamp(Option<DateTime>):

    The timestamp of when the relay was created.

  • last_modified_timestamp(Option<DateTime>):

    The timestamp of when relay was last updated.

• On failure, responds with SdkError<GetRelayError>

impl Client

pub fn get_rule_set(&self) -> GetRuleSetFluentBuilder

Constructs a fluent builder for the GetRuleSet operation.

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

    The identifier of an existing rule set to be retrieved.

    
    
• On success, responds with GetRuleSetOutput with field(s):
  • rule_set_id(String):

    The identifier of the rule set resource.

  • rule_set_arn(String):

    The Amazon Resource Name (ARN) of the rule set resource.

  • rule_set_name(String):

    A user-friendly name for the rule set resource.

  • created_date(DateTime):

    The date of when then rule set was created.

  • last_modification_date(DateTime):

    The date of when the rule set was last modified.

  • rules(Vec::<Rule>):

    The rules contained in the rule set.

• On failure, responds with SdkError<GetRuleSetError>

impl Client

pub fn get_traffic_policy(&self) -> GetTrafficPolicyFluentBuilder

Constructs a fluent builder for the GetTrafficPolicy operation.

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

    The identifier of the traffic policy resource.

    
    
• On success, responds with GetTrafficPolicyOutput with field(s):
  • traffic_policy_name(String):

    A user-friendly name for the traffic policy resource.

  • traffic_policy_id(String):

    The identifier of the traffic policy resource.

  • traffic_policy_arn(Option<String>):

    The Amazon Resource Name (ARN) of the traffic policy resource.

  • policy_statements(Option<Vec::<PolicyStatement>>):

    The list of conditions which are in the traffic policy resource.

  • max_message_size_bytes(Option<i32>):

    The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.

  • default_action(Option<AcceptAction>):

    The default action of the traffic policy.

  • created_timestamp(Option<DateTime>):

    The timestamp of when the traffic policy was created.

  • last_updated_timestamp(Option<DateTime>):

    The timestamp of when the traffic policy was last updated.

• On failure, responds with SdkError<GetTrafficPolicyError>

impl Client

pub fn list_addon_instances(&self) -> ListAddonInstancesFluentBuilder

Constructs a fluent builder for the ListAddonInstances operation. This operation supports pagination; See into_paginator().

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

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

    
    
• On success, responds with ListAddonInstancesOutput with field(s):
  • addon_instances(Option<Vec::<AddonInstance>>):

    The list of ingress endpoints.

  • next_token(Option<String>):

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

• On failure, responds with SdkError<ListAddonInstancesError>

impl Client

pub fn list_addon_subscriptions(&self) -> ListAddonSubscriptionsFluentBuilder

Constructs a fluent builder for the ListAddonSubscriptions operation. This operation supports pagination; See into_paginator().

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

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

    
    
• On success, responds with ListAddonSubscriptionsOutput with field(s):
  • addon_subscriptions(Option<Vec::<AddonSubscription>>):

    The list of ingress endpoints.

  • next_token(Option<String>):

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

• On failure, responds with SdkError<ListAddonSubscriptionsError>

impl Client

pub fn list_archive_exports(&self) -> ListArchiveExportsFluentBuilder

Constructs a fluent builder for the ListArchiveExports operation. This operation supports pagination; See into_paginator().

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

    The identifier of the archive.

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

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of archive export jobs that are returned per call. You can use NextToken to obtain further pages of archives.

    
    
• On success, responds with ListArchiveExportsOutput with field(s):
  • exports(Option<Vec::<ExportSummary>>):

    The list of export job identifiers and statuses.

  • next_token(Option<String>):

    If present, use to retrieve the next page of results.

• On failure, responds with SdkError<ListArchiveExportsError>

impl Client

pub fn list_archive_searches(&self) -> ListArchiveSearchesFluentBuilder

Constructs a fluent builder for the ListArchiveSearches operation. This operation supports pagination; See into_paginator().

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

    The identifier of the archive.

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

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives.

    
    
• On success, responds with ListArchiveSearchesOutput with field(s):
  • searches(Option<Vec::<SearchSummary>>):

    The list of search job identifiers and statuses.

  • next_token(Option<String>):

    If present, use to retrieve the next page of results.

• On failure, responds with SdkError<ListArchiveSearchesError>

impl Client

pub fn list_archives(&self) -> ListArchivesFluentBuilder

Constructs a fluent builder for the ListArchives operation. This operation supports pagination; See into_paginator().

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

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives.

    
    
• On success, responds with ListArchivesOutput with field(s):
  • archives(Vec::<Archive>):

    The list of archive details.

  • next_token(Option<String>):

    If present, use to retrieve the next page of results.

• On failure, responds with SdkError<ListArchivesError>

impl Client

pub fn list_ingress_points(&self) -> ListIngressPointsFluentBuilder

Constructs a fluent builder for the ListIngressPoints operation. This operation supports pagination; See into_paginator().

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

    The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

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

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

    
    
• On success, responds with ListIngressPointsOutput with field(s):
  • ingress_points(Option<Vec::<IngressPoint>>):

    The list of ingress endpoints.

  • next_token(Option<String>):

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

• On failure, responds with SdkError<ListIngressPointsError>

impl Client

pub fn list_relays(&self) -> ListRelaysFluentBuilder

Constructs a fluent builder for the ListRelays operation. This operation supports pagination; See into_paginator().

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

    The number of relays to be returned in one request.

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

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

    
    
• On success, responds with ListRelaysOutput with field(s):
  • relays(Vec::<Relay>):

    The list of returned relays.

  • next_token(Option<String>):

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

• On failure, responds with SdkError<ListRelaysError>

impl Client

pub fn list_rule_sets(&self) -> ListRuleSetsFluentBuilder

Constructs a fluent builder for the ListRuleSets operation. This operation supports pagination; See into_paginator().

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

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of rule set resources that are returned per call. You can use NextToken to obtain further rule sets.

    
    
• On success, responds with ListRuleSetsOutput with field(s):
  • rule_sets(Vec::<RuleSet>):

    The list of rule sets.

  • next_token(Option<String>):

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

• On failure, responds with SdkError<ListRuleSetsError>

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 to retrieve tags from.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Vec::<Tag>):

    The tags used to organize, track, or control access for the resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_traffic_policies(&self) -> ListTrafficPoliciesFluentBuilder

Constructs a fluent builder for the ListTrafficPolicies operation. This operation supports pagination; See into_paginator().

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

    The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.

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

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

    
    
• On success, responds with ListTrafficPoliciesOutput with field(s):
  • traffic_policies(Option<Vec::<TrafficPolicy>>):

    The list of traffic policies.

  • next_token(Option<String>):

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

• On failure, responds with SdkError<ListTrafficPoliciesError>

impl Client

pub fn start_archive_export(&self) -> StartArchiveExportFluentBuilder

Constructs a fluent builder for the StartArchiveExport operation.

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

    The identifier of the archive to export emails from.

    
    
  • filters(ArchiveFilters) / set_filters(Option<ArchiveFilters>):
    required: false
    

    Criteria to filter which emails are included in the export.

    
    
  • from_timestamp(DateTime) / set_from_timestamp(Option<DateTime>):
    required: true
    

    The start of the timestamp range to include emails from.

    
    
  • to_timestamp(DateTime) / set_to_timestamp(Option<DateTime>):
    required: true
    

    The end of the timestamp range to include emails from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of email items to include in the export.

    
    
  • export_destination_configuration(ExportDestinationConfiguration) / set_export_destination_configuration(Option<ExportDestinationConfiguration>):
    required: true
    

    Details on where to deliver the exported email data.

    
    
• On success, responds with StartArchiveExportOutput with field(s):
  • export_id(Option<String>):

    The unique identifier for the initiated export job.

• On failure, responds with SdkError<StartArchiveExportError>

impl Client

pub fn start_archive_search(&self) -> StartArchiveSearchFluentBuilder

Constructs a fluent builder for the StartArchiveSearch operation.

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

    The identifier of the archive to search emails in.

    
    
  • filters(ArchiveFilters) / set_filters(Option<ArchiveFilters>):
    required: false
    

    Criteria to filter which emails are included in the search results.

    
    
  • from_timestamp(DateTime) / set_from_timestamp(Option<DateTime>):
    required: true
    

    The start timestamp of the range to search emails from.

    
    
  • to_timestamp(DateTime) / set_to_timestamp(Option<DateTime>):
    required: true
    

    The end timestamp of the range to search emails from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: true
    

    The maximum number of search results to return.

    
    
• On success, responds with StartArchiveSearchOutput with field(s):
  • search_id(Option<String>):

    The unique identifier for the initiated search job.

• On failure, responds with SdkError<StartArchiveSearchError>

impl Client

pub fn stop_archive_export(&self) -> StopArchiveExportFluentBuilder

Constructs a fluent builder for the StopArchiveExport operation.

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

    The identifier of the export job to stop.

    
    
• On success, responds with StopArchiveExportOutput
• On failure, responds with SdkError<StopArchiveExportError>

impl Client

pub fn stop_archive_search(&self) -> StopArchiveSearchFluentBuilder

Constructs a fluent builder for the StopArchiveSearch operation.

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

    The identifier of the search job to stop.

    
    
• On success, responds with StopArchiveSearchOutput
• On failure, responds with SdkError<StopArchiveSearchError>

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 that you want to tag.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The tags used to organize, track, or control access for the resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• 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 that you want to untag.

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

    The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.

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

impl Client

pub fn update_archive(&self) -> UpdateArchiveFluentBuilder

Constructs a fluent builder for the UpdateArchive operation.

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

    The identifier of the archive to update.

    
    
  • archive_name(impl Into<String>) / set_archive_name(Option<String>):
    required: false
    

    A new, unique name for the archive.

    
    
  • retention(ArchiveRetention) / set_retention(Option<ArchiveRetention>):
    required: false
    

    A new retention period for emails in the archive.

    
    
• On success, responds with UpdateArchiveOutput
• On failure, responds with SdkError<UpdateArchiveError>

impl Client

pub fn update_ingress_point(&self) -> UpdateIngressPointFluentBuilder

Constructs a fluent builder for the UpdateIngressPoint operation.

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

    The identifier for the ingress endpoint you want to update.

    
    
  • ingress_point_name(impl Into<String>) / set_ingress_point_name(Option<String>):
    required: false
    

    A user friendly name for the ingress endpoint resource.

    
    
  • status_to_update(IngressPointStatusToUpdate) / set_status_to_update(Option<IngressPointStatusToUpdate>):
    required: false
    

    The update status of an ingress endpoint.

    
    
  • rule_set_id(impl Into<String>) / set_rule_set_id(Option<String>):
    required: false
    

    The identifier of an existing rule set that you attach to an ingress endpoint resource.

    
    
  • traffic_policy_id(impl Into<String>) / set_traffic_policy_id(Option<String>):
    required: false
    

    The identifier of an existing traffic policy that you attach to an ingress endpoint resource.

    
    
  • ingress_point_configuration(IngressPointConfiguration) / set_ingress_point_configuration(Option<IngressPointConfiguration>):
    required: false
    

    If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.

    
    
• On success, responds with UpdateIngressPointOutput
• On failure, responds with SdkError<UpdateIngressPointError>

impl Client

pub fn update_relay(&self) -> UpdateRelayFluentBuilder

Constructs a fluent builder for the UpdateRelay operation.

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

    The unique relay identifier.

    
    
  • relay_name(impl Into<String>) / set_relay_name(Option<String>):
    required: false
    

    The name of the relay resource.

    
    
  • server_name(impl Into<String>) / set_server_name(Option<String>):
    required: false
    

    The destination relay server address.

    
    
  • server_port(i32) / set_server_port(Option<i32>):
    required: false
    

    The destination relay server port.

    
    
  • authentication(RelayAuthentication) / set_authentication(Option<RelayAuthentication>):
    required: false
    

    Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.

    
    
• On success, responds with UpdateRelayOutput
• On failure, responds with SdkError<UpdateRelayError>

impl Client

pub fn update_rule_set(&self) -> UpdateRuleSetFluentBuilder

Constructs a fluent builder for the UpdateRuleSet operation.

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

    The identifier of a rule set you want to update.

    
    
  • rule_set_name(impl Into<String>) / set_rule_set_name(Option<String>):
    required: false
    

    A user-friendly name for the rule set resource.

    
    
  • rules(Rule) / set_rules(Option<Vec::<Rule>>):
    required: false
    

    A new set of rules to replace the current rules of the rule set—these rules will override all the rules of the rule set.

    
    
• On success, responds with UpdateRuleSetOutput
• On failure, responds with SdkError<UpdateRuleSetError>

impl Client

pub fn update_traffic_policy(&self) -> UpdateTrafficPolicyFluentBuilder

Constructs a fluent builder for the UpdateTrafficPolicy operation.

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

    The identifier of the traffic policy that you want to update.

    
    
  • traffic_policy_name(impl Into<String>) / set_traffic_policy_name(Option<String>):
    required: false
    

    A user-friendly name for the traffic policy resource.

    
    
  • policy_statements(PolicyStatement) / set_policy_statements(Option<Vec::<PolicyStatement>>):
    required: false
    

    The list of conditions to be updated for filtering email traffic.

    
    
  • default_action(AcceptAction) / set_default_action(Option<AcceptAction>):
    required: false
    

    Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements

    
    
  • max_message_size_bytes(i32) / set_max_message_size_bytes(Option<i32>):
    required: false
    

    The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.

    
    
• On success, responds with UpdateTrafficPolicyOutput
• On failure, responds with SdkError<UpdateTrafficPolicyError>

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.