Struct Client 

pub struct Client { /* private fields */ }

Client for Route 53 Profiles

Client for invoking operations on Route 53 Profiles. Each operation on Route 53 Profiles 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_route53profiles::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 Builder 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_route53profiles::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 AssociateProfile operation has a Client::associate_profile, 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.associate_profile()
    .profile_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 associate_profile(&self) -> AssociateProfileFluentBuilder

Constructs a fluent builder for the AssociateProfile operation.

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

    ID of the Profile.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The ID of the VPC.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A name for the association.

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

    A list of the tag keys and values that you want to identify the Profile association.

    
    
• On success, responds with AssociateProfileOutput with field(s):
  • profile_association(Option<ProfileAssociation>):

    The association that you just created. The association has an ID that you can use to identify it in other requests, like update and delete.

• On failure, responds with SdkError<AssociateProfileError>

impl Client

pub fn associate_resource_to_profile( &self, ) -> AssociateResourceToProfileFluentBuilder

Constructs a fluent builder for the AssociateResourceToProfile operation.

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

    ID of the Profile.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    Amazon resource number, ARN, of the DNS resource.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Name for the resource association.

    
    
  • resource_properties(impl Into<String>) / set_resource_properties(Option<String>):
    required: false
    

    If you are adding a DNS Firewall rule group, include also a priority. The priority indicates the processing order for the rule groups, starting with the priority assinged the lowest value.

    The allowed values for priority are between 100 and 9900.

    
    
• On success, responds with AssociateResourceToProfileOutput with field(s):
  • profile_resource_association(Option<ProfileResourceAssociation>):

    Infromation about the AssociateResourceToProfile, including a status message.

• On failure, responds with SdkError<AssociateResourceToProfileError>

impl Client

pub fn create_profile(&self) -> CreateProfileFluentBuilder

Constructs a fluent builder for the CreateProfile operation.

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

    A name for the Profile.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    ClientToken is an idempotency token that ensures a call to CreateProfile completes only once. You choose the value to pass. For example, an issue might prevent you from getting a response from CreateProfile. In this case, safely retry your call to CreateProfile by using the same CreateProfile parameter value.

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

    A list of the tag keys and values that you want to associate with the Route 53 Profile.

    
    
• On success, responds with CreateProfileOutput with field(s):
  • profile(Option<Profile>):

    The Profile that you just created.

• On failure, responds with SdkError<CreateProfileError>

impl Client

pub fn delete_profile(&self) -> DeleteProfileFluentBuilder

Constructs a fluent builder for the DeleteProfile operation.

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

    The ID of the Profile that you want to delete.

    
    
• On success, responds with DeleteProfileOutput with field(s):
  • profile(Option<Profile>):

    Information about the DeleteProfile request, including the status of the request.

• On failure, responds with SdkError<DeleteProfileError>

impl Client

pub fn disassociate_profile(&self) -> DisassociateProfileFluentBuilder

Constructs a fluent builder for the DisassociateProfile operation.

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

    ID of the Profile.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The ID of the VPC.

    
    
• On success, responds with DisassociateProfileOutput with field(s):
  • profile_association(Option<ProfileAssociation>):

    Information about the DisassociateProfile request.

• On failure, responds with SdkError<DisassociateProfileError>

impl Client

pub fn disassociate_resource_from_profile( &self, ) -> DisassociateResourceFromProfileFluentBuilder

Constructs a fluent builder for the DisassociateResourceFromProfile operation.

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

    The ID of the Profile.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
• On success, responds with DisassociateResourceFromProfileOutput with field(s):
  • profile_resource_association(Option<ProfileResourceAssociation>):

    Information about the DisassociateResourceFromProfile request, including the status of the request.

• On failure, responds with SdkError<DisassociateResourceFromProfileError>

impl Client

pub fn get_profile(&self) -> GetProfileFluentBuilder

Constructs a fluent builder for the GetProfile operation.

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

    ID of the Profile.

    
    
• On success, responds with GetProfileOutput with field(s):
  • profile(Option<Profile>):

    Information about the Profile, including the status of the Profile.

• On failure, responds with SdkError<GetProfileError>

impl Client

pub fn get_profile_association(&self) -> GetProfileAssociationFluentBuilder

Constructs a fluent builder for the GetProfileAssociation operation.

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

    The identifier of the association you want to get information about.

    
    
• On success, responds with GetProfileAssociationOutput with field(s):
  • profile_association(Option<ProfileAssociation>):

    Information about the Profile association that you specified in a GetProfileAssociation request.

• On failure, responds with SdkError<GetProfileAssociationError>

impl Client

pub fn get_profile_resource_association( &self, ) -> GetProfileResourceAssociationFluentBuilder

Constructs a fluent builder for the GetProfileResourceAssociation operation.

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

    The ID of the profile resource association that you want to get information about.

    
    
• On success, responds with GetProfileResourceAssociationOutput with field(s):
  • profile_resource_association(Option<ProfileResourceAssociation>):

    Information about the Profile resource association that you specified in a GetProfileResourceAssociation request.

• On failure, responds with SdkError<GetProfileResourceAssociationError>

impl Client

pub fn list_profile_associations(&self) -> ListProfileAssociationsFluentBuilder

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

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

    ID of the VPC.

    
    
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: false
    

    ID of the Profile.

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

    The maximum number of objects that you want to return for this request. If more objects are available, in the response, a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided.

    If you don’t specify a value for MaxResults, up to 100 objects are returned.

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

    For the first call to this list request, omit this value.

    When you request a list of objects, at most the number of objects specified by MaxResults is returned. If more objects are available for retrieval, a NextToken value is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

    
    
• On success, responds with ListProfileAssociationsOutput with field(s):
  • profile_associations(Option<Vec::<ProfileAssociation>>):

    A complex type that containts settings information about the profile’s VPC associations.

  • next_token(Option<String>):

    If more than MaxResults profile associations match the specified criteria, you can submit another ListProfileAssociations request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

• On failure, responds with SdkError<ListProfileAssociationsError>

impl Client

pub fn list_profile_resource_associations( &self, ) -> ListProfileResourceAssociationsFluentBuilder

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

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

    The ID of the Profile.

    
    
  • resource_type(impl Into<String>) / set_resource_type(Option<String>):
    required: false
    

    ID of a resource if you want information on only one type.

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

    The maximum number of objects that you want to return for this request. If more objects are available, in the response, a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided.

    If you don’t specify a value for MaxResults, up to 100 objects are returned.

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

    For the first call to this list request, omit this value.

    When you request a list of objects, at most the number of objects specified by MaxResults is returned. If more objects are available for retrieval, a NextToken value is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

    
    
• On success, responds with ListProfileResourceAssociationsOutput with field(s):
  • profile_resource_associations(Option<Vec::<ProfileResourceAssociation>>):

    Information about the profile resource association that you specified in a GetProfileResourceAssociation request.

  • next_token(Option<String>):

    If more than MaxResults resource associations match the specified criteria, you can submit another ListProfileResourceAssociations request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

• On failure, responds with SdkError<ListProfileResourceAssociationsError>

impl Client

pub fn list_profiles(&self) -> ListProfilesFluentBuilder

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

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

    The maximum number of objects that you want to return for this request. If more objects are available, in the response, a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided.

    If you don’t specify a value for MaxResults, up to 100 objects are returned.

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

    For the first call to this list request, omit this value.

    When you request a list of objects, at most the number of objects specified by MaxResults is returned. If more objects are available for retrieval, a NextToken value is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

    
    
• On success, responds with ListProfilesOutput with field(s):
  • profile_summaries(Option<Vec::<ProfileSummary>>):

    Summary information about the Profiles.

  • next_token(Option<String>):

    If more than MaxResults resource associations match the specified criteria, you can submit another ListProfiles request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

• On failure, responds with SdkError<ListProfilesError>

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) for the resource that you want to list the tags for.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(HashMap::<String, String>):

    The tags that are associated with the resource that you specified in the ListTagsForResource request.

• On failure, responds with SdkError<ListTagsForResourceError>

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) for the resource that you want to add tags to.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags that you want to add to the specified resource.

    
    
• 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) for the resource that you want to remove tags from.

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

    The tags that you want to remove to the specified resource.

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

impl Client

pub fn update_profile_resource_association( &self, ) -> UpdateProfileResourceAssociationFluentBuilder

Constructs a fluent builder for the UpdateProfileResourceAssociation operation.

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

    ID of the resource association.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    Name of the resource association.

    
    
  • resource_properties(impl Into<String>) / set_resource_properties(Option<String>):
    required: false
    

    If you are adding a DNS Firewall rule group, include also a priority. The priority indicates the processing order for the rule groups, starting with the priority assinged the lowest value.

    The allowed values for priority are between 100 and 9900.

    
    
• On success, responds with UpdateProfileResourceAssociationOutput with field(s):
  • profile_resource_association(Option<ProfileResourceAssociation>):

    Information about the UpdateProfileResourceAssociation request, including a status message.

• On failure, responds with SdkError<UpdateProfileResourceAssociationError>

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 duplicate 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.