Struct aws_sdk_route53::client::Client

source ·
pub struct Client { /* private fields */ }
Expand description

Client for Amazon Route 53

Client for invoking operations on Amazon Route 53. Each operation on Amazon Route 53 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_route53::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_route53::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 ActivateKeySigningKey operation has a Client::activate_key_signing_key, 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.activate_key_signing_key()
    .hosted_zone_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.

§Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations§

source§

impl Client

source

pub fn activate_key_signing_key(&self) -> ActivateKeySigningKeyFluentBuilder

Constructs a fluent builder for the ActivateKeySigningKey operation.

source§

impl Client

source

pub fn associate_vpc_with_hosted_zone( &self ) -> AssociateVPCWithHostedZoneFluentBuilder

Constructs a fluent builder for the AssociateVPCWithHostedZone operation.

source§

impl Client

source

pub fn change_cidr_collection(&self) -> ChangeCidrCollectionFluentBuilder

Constructs a fluent builder for the ChangeCidrCollection operation.

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

      The UUID of the CIDR collection to update.


    • collection_version(i64) / set_collection_version(Option<i64>):
      required: false

      A sequential counter that Amazon Route 53 sets to 1 when you create a collection and increments it by 1 each time you update the collection.

      We recommend that you use ListCidrCollection to get the current value of CollectionVersion for the collection that you want to update, and then include that value with the change request. This prevents Route 53 from overwriting an intervening update:

      • If the value in the request matches the value of CollectionVersion in the collection, Route 53 updates the collection.

      • If the value of CollectionVersion in the collection is greater than the value in the request, the collection was changed after you got the version number. Route 53 does not update the collection, and it returns a CidrCollectionVersionMismatch error.


    • changes(CidrCollectionChange) / set_changes(Option<Vec::<CidrCollectionChange>>):
      required: true

      Information about changes to a CIDR collection.


  • On success, responds with ChangeCidrCollectionOutput with field(s):
    • id(String):

      The ID that is returned by ChangeCidrCollection. You can use it as input to GetChange to see if a CIDR collection change has propagated or not.

  • On failure, responds with SdkError<ChangeCidrCollectionError>
source§

impl Client

source

pub fn change_resource_record_sets( &self ) -> ChangeResourceRecordSetsFluentBuilder

Constructs a fluent builder for the ChangeResourceRecordSets operation.

source§

impl Client

source

pub fn change_tags_for_resource(&self) -> ChangeTagsForResourceFluentBuilder

Constructs a fluent builder for the ChangeTagsForResource operation.

source§

impl Client

source

pub fn create_cidr_collection(&self) -> CreateCidrCollectionFluentBuilder

Constructs a fluent builder for the CreateCidrCollection operation.

source§

impl Client

source

pub fn create_health_check(&self) -> CreateHealthCheckFluentBuilder

Constructs a fluent builder for the CreateHealthCheck operation.

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

      A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks:

      • If you send a CreateHealthCheck request with the same CallerReference and settings as a previous request, and if the health check doesn’t exist, Amazon Route 53 creates the health check. If the health check does exist, Route 53 returns the settings for the existing health check.

      • If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists error.

      • If you send a CreateHealthCheck request with the same CallerReference as an existing health check but with different settings, Route 53 returns a HealthCheckAlreadyExists error.

      • If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Route 53 creates the health check.

      Route 53 does not store the CallerReference for a deleted health check indefinitely. The CallerReference for a deleted health check will be deleted after a number of days.


    • health_check_config(HealthCheckConfig) / set_health_check_config(Option<HealthCheckConfig>):
      required: true

      A complex type that contains settings for a new health check.


  • On success, responds with CreateHealthCheckOutput with field(s):
  • On failure, responds with SdkError<CreateHealthCheckError>
source§

impl Client

source

pub fn create_hosted_zone(&self) -> CreateHostedZoneFluentBuilder

Constructs a fluent builder for the CreateHostedZone operation.

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

      The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

      If you’re creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet.


    • vpc(Vpc) / set_vpc(Option<Vpc>):
      required: false

      (Private hosted zones only) A complex type that contains information about the Amazon VPC that you’re associating with this hosted zone.

      You can specify only one Amazon VPC when you create a private hosted zone. If you are associating a VPC with a hosted zone with this request, the paramaters VPCId and VPCRegion are also required.

      To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.


    • caller_reference(impl Into<String>) / set_caller_reference(Option<String>):
      required: true

      A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateHostedZone request. CallerReference can be any unique string, for example, a date/time stamp.


    • hosted_zone_config(HostedZoneConfig) / set_hosted_zone_config(Option<HostedZoneConfig>):
      required: false

      (Optional) A complex type that contains the following optional values:

      • For public and private hosted zones, an optional comment

      • For private hosted zones, an optional PrivateZone element

      If you don’t specify a comment or the PrivateZone element, omit HostedZoneConfig and the other elements.


    • delegation_set_id(impl Into<String>) / set_delegation_set_id(Option<String>):
      required: false

      If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see CreateReusableDelegationSet.

      If you are using a reusable delegation set to create a public hosted zone for a subdomain, make sure that the parent hosted zone doesn’t use one or more of the same name servers. If you have overlapping nameservers, the operation will cause a ConflictingDomainsExist error.


  • On success, responds with CreateHostedZoneOutput with field(s):
  • On failure, responds with SdkError<CreateHostedZoneError>
source§

impl Client

source

pub fn create_key_signing_key(&self) -> CreateKeySigningKeyFluentBuilder

Constructs a fluent builder for the CreateKeySigningKey operation.

source§

impl Client

source

pub fn create_query_logging_config( &self ) -> CreateQueryLoggingConfigFluentBuilder

Constructs a fluent builder for the CreateQueryLoggingConfig operation.

source§

impl Client

source

pub fn create_reusable_delegation_set( &self ) -> CreateReusableDelegationSetFluentBuilder

Constructs a fluent builder for the CreateReusableDelegationSet operation.

source§

impl Client

source

pub fn create_traffic_policy(&self) -> CreateTrafficPolicyFluentBuilder

Constructs a fluent builder for the CreateTrafficPolicy operation.

source§

impl Client

source

pub fn create_traffic_policy_instance( &self ) -> CreateTrafficPolicyInstanceFluentBuilder

Constructs a fluent builder for the CreateTrafficPolicyInstance operation.

source§

impl Client

source

pub fn create_traffic_policy_version( &self ) -> CreateTrafficPolicyVersionFluentBuilder

Constructs a fluent builder for the CreateTrafficPolicyVersion operation.

source§

impl Client

source

pub fn create_vpc_association_authorization( &self ) -> CreateVPCAssociationAuthorizationFluentBuilder

Constructs a fluent builder for the CreateVPCAssociationAuthorization operation.

source§

impl Client

source

pub fn deactivate_key_signing_key(&self) -> DeactivateKeySigningKeyFluentBuilder

Constructs a fluent builder for the DeactivateKeySigningKey operation.

source§

impl Client

source

pub fn delete_cidr_collection(&self) -> DeleteCidrCollectionFluentBuilder

Constructs a fluent builder for the DeleteCidrCollection operation.

source§

impl Client

source

pub fn delete_health_check(&self) -> DeleteHealthCheckFluentBuilder

Constructs a fluent builder for the DeleteHealthCheck operation.

source§

impl Client

source

pub fn delete_hosted_zone(&self) -> DeleteHostedZoneFluentBuilder

Constructs a fluent builder for the DeleteHostedZone operation.

source§

impl Client

source

pub fn delete_key_signing_key(&self) -> DeleteKeySigningKeyFluentBuilder

Constructs a fluent builder for the DeleteKeySigningKey operation.

source§

impl Client

source

pub fn delete_query_logging_config( &self ) -> DeleteQueryLoggingConfigFluentBuilder

Constructs a fluent builder for the DeleteQueryLoggingConfig operation.

source§

impl Client

source

pub fn delete_reusable_delegation_set( &self ) -> DeleteReusableDelegationSetFluentBuilder

Constructs a fluent builder for the DeleteReusableDelegationSet operation.

source§

impl Client

source

pub fn delete_traffic_policy(&self) -> DeleteTrafficPolicyFluentBuilder

Constructs a fluent builder for the DeleteTrafficPolicy operation.

source§

impl Client

source

pub fn delete_traffic_policy_instance( &self ) -> DeleteTrafficPolicyInstanceFluentBuilder

Constructs a fluent builder for the DeleteTrafficPolicyInstance operation.

source§

impl Client

source

pub fn delete_vpc_association_authorization( &self ) -> DeleteVPCAssociationAuthorizationFluentBuilder

Constructs a fluent builder for the DeleteVPCAssociationAuthorization operation.

source§

impl Client

source

pub fn disable_hosted_zone_dnssec(&self) -> DisableHostedZoneDNSSECFluentBuilder

Constructs a fluent builder for the DisableHostedZoneDNSSEC operation.

source§

impl Client

source

pub fn disassociate_vpc_from_hosted_zone( &self ) -> DisassociateVPCFromHostedZoneFluentBuilder

Constructs a fluent builder for the DisassociateVPCFromHostedZone operation.

source§

impl Client

source

pub fn enable_hosted_zone_dnssec(&self) -> EnableHostedZoneDNSSECFluentBuilder

Constructs a fluent builder for the EnableHostedZoneDNSSEC operation.

source§

impl Client

source

pub fn get_account_limit(&self) -> GetAccountLimitFluentBuilder

Constructs a fluent builder for the GetAccountLimit operation.

  • The fluent builder is configurable:
    • r#type(AccountLimitType) / set_type(Option<AccountLimitType>):
      required: true

      The limit that you want to get. Valid values include the following:

      • MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using the current account.

      • MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create using the current account.

      • MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets that you can create using the current account.

      • MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create using the current account.

      • MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.)


  • On success, responds with GetAccountLimitOutput with field(s):
    • limit(Option<AccountLimit>):

      The current setting for the specified limit. For example, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the request, the value of Limit is the maximum number of health checks that you can create using the current account.

    • count(i64):

      The current number of entities that you have created of the specified type. For example, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the request, the value of Count is the current number of health checks that you have created using the current account.

  • On failure, responds with SdkError<GetAccountLimitError>
source§

impl Client

source

pub fn get_change(&self) -> GetChangeFluentBuilder

Constructs a fluent builder for the GetChange operation.

source§

impl Client

source

pub fn get_checker_ip_ranges(&self) -> GetCheckerIpRangesFluentBuilder

Constructs a fluent builder for the GetCheckerIpRanges operation.

source§

impl Client

source

pub fn get_dnssec(&self) -> GetDNSSECFluentBuilder

Constructs a fluent builder for the GetDNSSEC operation.

source§

impl Client

source

pub fn get_geo_location(&self) -> GetGeoLocationFluentBuilder

Constructs a fluent builder for the GetGeoLocation operation.

source§

impl Client

source

pub fn get_health_check(&self) -> GetHealthCheckFluentBuilder

Constructs a fluent builder for the GetHealthCheck operation.

source§

impl Client

source

pub fn get_health_check_count(&self) -> GetHealthCheckCountFluentBuilder

Constructs a fluent builder for the GetHealthCheckCount operation.

source§

impl Client

source

pub fn get_health_check_last_failure_reason( &self ) -> GetHealthCheckLastFailureReasonFluentBuilder

Constructs a fluent builder for the GetHealthCheckLastFailureReason operation.

source§

impl Client

source

pub fn get_health_check_status(&self) -> GetHealthCheckStatusFluentBuilder

Constructs a fluent builder for the GetHealthCheckStatus operation.

source§

impl Client

source

pub fn get_hosted_zone(&self) -> GetHostedZoneFluentBuilder

Constructs a fluent builder for the GetHostedZone operation.

source§

impl Client

source

pub fn get_hosted_zone_count(&self) -> GetHostedZoneCountFluentBuilder

Constructs a fluent builder for the GetHostedZoneCount operation.

source§

impl Client

source

pub fn get_hosted_zone_limit(&self) -> GetHostedZoneLimitFluentBuilder

Constructs a fluent builder for the GetHostedZoneLimit operation.

  • The fluent builder is configurable:
  • On success, responds with GetHostedZoneLimitOutput with field(s):
    • limit(Option<HostedZoneLimit>):

      The current setting for the specified limit. For example, if you specified MAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Limit is the maximum number of records that you can create in the specified hosted zone.

    • count(i64):

      The current number of entities that you have created of the specified type. For example, if you specified MAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Count is the current number of records that you have created in the specified hosted zone.

  • On failure, responds with SdkError<GetHostedZoneLimitError>
source§

impl Client

source

pub fn get_query_logging_config(&self) -> GetQueryLoggingConfigFluentBuilder

Constructs a fluent builder for the GetQueryLoggingConfig operation.

source§

impl Client

source

pub fn get_reusable_delegation_set( &self ) -> GetReusableDelegationSetFluentBuilder

Constructs a fluent builder for the GetReusableDelegationSet operation.

source§

impl Client

source

pub fn get_reusable_delegation_set_limit( &self ) -> GetReusableDelegationSetLimitFluentBuilder

Constructs a fluent builder for the GetReusableDelegationSetLimit operation.

source§

impl Client

source

pub fn get_traffic_policy(&self) -> GetTrafficPolicyFluentBuilder

Constructs a fluent builder for the GetTrafficPolicy operation.

source§

impl Client

source

pub fn get_traffic_policy_instance( &self ) -> GetTrafficPolicyInstanceFluentBuilder

Constructs a fluent builder for the GetTrafficPolicyInstance operation.

source§

impl Client

source

pub fn get_traffic_policy_instance_count( &self ) -> GetTrafficPolicyInstanceCountFluentBuilder

Constructs a fluent builder for the GetTrafficPolicyInstanceCount operation.

source§

impl Client

source

pub fn list_cidr_blocks(&self) -> ListCidrBlocksFluentBuilder

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

source§

impl Client

source

pub fn list_cidr_collections(&self) -> ListCidrCollectionsFluentBuilder

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

source§

impl Client

source

pub fn list_cidr_locations(&self) -> ListCidrLocationsFluentBuilder

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

source§

impl Client

source

pub fn list_geo_locations(&self) -> ListGeoLocationsFluentBuilder

Constructs a fluent builder for the ListGeoLocations operation.

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

      The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextContinentCode from the previous response has a value, enter that value in startcontinentcode to return the next page of results.

      Include startcontinentcode only if you want to list continents. Don’t include startcontinentcode when you’re listing countries or countries with their subdivisions.


    • start_country_code(impl Into<String>) / set_start_country_code(Option<String>):
      required: false

      The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextCountryCode from the previous response has a value, enter that value in startcountrycode to return the next page of results.


    • start_subdivision_code(impl Into<String>) / set_start_subdivision_code(Option<String>):
      required: false

      The code for the state of the United States with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextSubdivisionCode from the previous response has a value, enter that value in startsubdivisioncode to return the next page of results.

      To list subdivisions (U.S. states), you must include both startcountrycode and startsubdivisioncode.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      (Optional) The maximum number of geolocations to be included in the response body for this request. If more than maxitems geolocations remain to be listed, then the value of the IsTruncated element in the response is true.


  • On success, responds with ListGeoLocationsOutput with field(s):
    • geo_location_details_list(Vec::<GeoLocationDetails>):

      A complex type that contains one GeoLocationDetails element for each location that Amazon Route 53 supports for geolocation.

    • is_truncated(bool):

      A value that indicates whether more locations remain to be listed after the last location in this response. If so, the value of IsTruncated is true. To get more values, submit another request and include the values of NextContinentCode, NextCountryCode, and NextSubdivisionCode in the startcontinentcode, startcountrycode, and startsubdivisioncode, as applicable.

    • next_continent_code(Option<String>):

      If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextContinentCode in the startcontinentcode parameter in another ListGeoLocations request.

    • next_country_code(Option<String>):

      If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextCountryCode in the startcountrycode parameter in another ListGeoLocations request.

    • next_subdivision_code(Option<String>):

      If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextSubdivisionCode in the startsubdivisioncode parameter in another ListGeoLocations request.

    • max_items(i32):

      The value that you specified for MaxItems in the request.

  • On failure, responds with SdkError<ListGeoLocationsError>
source§

impl Client

source

pub fn list_health_checks(&self) -> ListHealthChecksFluentBuilder

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

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

      If the value of IsTruncated in the previous response was true, you have more health checks. To get another group, submit another ListHealthChecks request.

      For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first health check that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more health checks to get.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      The maximum number of health checks that you want ListHealthChecks to return in response to the current request. Amazon Route 53 returns a maximum of 1000 items. If you set MaxItems to a value greater than 1000, Route 53 returns only the first 1000 health checks.


  • On success, responds with ListHealthChecksOutput with field(s):
    • health_checks(Vec::<HealthCheck>):

      A complex type that contains one HealthCheck element for each health check that is associated with the current Amazon Web Services account.

    • marker(String):

      For the second and subsequent calls to ListHealthChecks, Marker is the value that you specified for the marker parameter in the previous request.

    • is_truncated(bool):

      A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can get the next group of health checks by submitting another ListHealthChecks request and specifying the value of NextMarker in the marker parameter.

    • next_marker(Option<String>):

      If IsTruncated is true, the value of NextMarker identifies the first health check that Amazon Route 53 returns if you submit another ListHealthChecks request and specify the value of NextMarker in the marker parameter.

    • max_items(i32):

      The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the current response.

  • On failure, responds with SdkError<ListHealthChecksError>
source§

impl Client

source

pub fn list_hosted_zones(&self) -> ListHostedZonesFluentBuilder

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

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

      If the value of IsTruncated in the previous response was true, you have more hosted zones. To get more hosted zones, submit another ListHostedZones request.

      For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more hosted zones to get.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      (Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than maxitems hosted zones, the value of IsTruncated in the response is true, and the value of NextMarker is the hosted zone ID of the first hosted zone that Route 53 will return if you submit another request.


    • delegation_set_id(impl Into<String>) / set_delegation_set_id(Option<String>):
      required: false

      If you’re using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set.


    • hosted_zone_type(HostedZoneType) / set_hosted_zone_type(Option<HostedZoneType>):
      required: false

      (Optional) Specifies if the hosted zone is private.


  • On success, responds with ListHostedZonesOutput with field(s):
    • hosted_zones(Vec::<HostedZone>):

      A complex type that contains general information about the hosted zone.

    • marker(String):

      For the second and subsequent calls to ListHostedZones, Marker is the value that you specified for the marker parameter in the request that produced the current response.

    • is_truncated(bool):

      A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones by submitting another ListHostedZones request and specifying the value of NextMarker in the marker parameter.

    • next_marker(Option<String>):

      If IsTruncated is true, the value of NextMarker identifies the first hosted zone in the next group of hosted zones. Submit another ListHostedZones request, and specify the value of NextMarker from the response in the marker parameter.

      This element is present only if IsTruncated is true.

    • max_items(i32):

      The value that you specified for the maxitems parameter in the call to ListHostedZones that produced the current response.

  • On failure, responds with SdkError<ListHostedZonesError>
source§

impl Client

source

pub fn list_hosted_zones_by_name(&self) -> ListHostedZonesByNameFluentBuilder

Constructs a fluent builder for the ListHostedZonesByName operation.

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

      (Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to specify the name of the first hosted zone in the response. If you don’t include the dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.


    • hosted_zone_id(impl Into<String>) / set_hosted_zone_id(Option<String>):
      required: false

      (Optional) For your first request to ListHostedZonesByName, do not include the hostedzoneid parameter.

      If you have more hosted zones than the value of maxitems, ListHostedZonesByName returns only the first maxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to ListHostedZonesByName and include both dnsname and hostedzoneid parameters. For the value of hostedzoneid, specify the value of the NextHostedZoneId element from the previous response.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and NextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.


  • On success, responds with ListHostedZonesByNameOutput with field(s):
    • hosted_zones(Vec::<HostedZone>):

      A complex type that contains general information about the hosted zone.

    • dns_name(Option<String>):

      For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the dnsname parameter in the request that produced the current response.

    • hosted_zone_id(Option<String>):

      The ID that Amazon Route 53 assigned to the hosted zone when you created it.

    • is_truncated(bool):

      A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of maxitems hosted zones by calling ListHostedZonesByName again and specifying the values of NextDNSName and NextHostedZoneId elements in the dnsname and hostedzoneid parameters.

    • next_dns_name(Option<String>):

      If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

      This element is present only if IsTruncated is true.

    • next_hosted_zone_id(Option<String>):

      If IsTruncated is true, the value of NextHostedZoneId identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

      This element is present only if IsTruncated is true.

    • max_items(i32):

      The value that you specified for the maxitems parameter in the call to ListHostedZonesByName that produced the current response.

  • On failure, responds with SdkError<ListHostedZonesByNameError>
source§

impl Client

source

pub fn list_hosted_zones_by_vpc(&self) -> ListHostedZonesByVPCFluentBuilder

Constructs a fluent builder for the ListHostedZonesByVPC operation.

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

      The ID of the Amazon VPC that you want to list hosted zones for.


    • vpc_region(VpcRegion) / set_vpc_region(Option<VpcRegion>):
      required: true

      For the Amazon VPC that you specified for VPCId, the Amazon Web Services Region that you created the VPC in.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      (Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If the specified VPC is associated with more than MaxItems hosted zones, the response includes a NextToken element. NextToken contains an encrypted token that identifies the first hosted zone that Route 53 will return if you submit another request.


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

      If the previous response included a NextToken element, the specified VPC is associated with more hosted zones. To get more hosted zones, submit another ListHostedZonesByVPC request.

      For the value of NextToken, specify the value of NextToken from the previous response.

      If the previous response didn’t include a NextToken element, there are no more hosted zones to get.


  • On success, responds with ListHostedZonesByVpcOutput with field(s):
    • hosted_zone_summaries(Vec::<HostedZoneSummary>):

      A list that contains one HostedZoneSummary element for each hosted zone that the specified Amazon VPC is associated with. Each HostedZoneSummary element contains the hosted zone name and ID, and information about who owns the hosted zone.

    • max_items(i32):

      The value that you specified for MaxItems in the most recent ListHostedZonesByVPC request.

    • next_token(Option<String>):

      The value that you will use for NextToken in the next ListHostedZonesByVPC request.

  • On failure, responds with SdkError<ListHostedZonesByVPCError>
source§

impl Client

source

pub fn list_query_logging_configs(&self) -> ListQueryLoggingConfigsFluentBuilder

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

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

      (Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in HostedZoneId.

      If you don’t specify a hosted zone ID, ListQueryLoggingConfigs returns all of the configurations that are associated with the current Amazon Web Services account.


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

      (Optional) If the current Amazon Web Services account has more than MaxResults query logging configurations, use NextToken to get the second and subsequent pages of results.

      For the first ListQueryLoggingConfigs request, omit this value.

      For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.


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

      (Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response to the current request. If the current Amazon Web Services account has more than MaxResults configurations, use the value of NextToken in the response to get the next page of results.

      If you don’t specify a value for MaxResults, Route 53 returns up to 100 configurations.


  • On success, responds with ListQueryLoggingConfigsOutput with field(s):
    • query_logging_configs(Vec::<QueryLoggingConfig>):

      An array that contains one QueryLoggingConfig element for each configuration for DNS query logging that is associated with the current Amazon Web Services account.

    • next_token(Option<String>):

      If a response includes the last of the query logging configurations that are associated with the current Amazon Web Services account, NextToken doesn’t appear in the response.

      If a response doesn’t include the last of the configurations, you can get more configurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.

  • On failure, responds with SdkError<ListQueryLoggingConfigsError>
source§

impl Client

source

pub fn list_resource_record_sets(&self) -> ListResourceRecordSetsFluentBuilder

Constructs a fluent builder for the ListResourceRecordSets operation.

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

      The ID of the hosted zone that contains the resource record sets that you want to list.


    • start_record_name(impl Into<String>) / set_start_record_name(Option<String>):
      required: false

      The first name in the lexicographic ordering of resource record sets that you want to list. If the specified record name doesn’t exist, the results begin with the first resource record set that has a name greater than the value of name.


    • start_record_type(RrType) / set_start_record_type(Option<RrType>):
      required: false

      The type of resource record set to begin the record listing from.

      Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

      Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT

      Values for alias resource record sets:

      • API Gateway custom regional API or edge-optimized API: A

      • CloudFront distribution: A or AAAA

      • Elastic Beanstalk environment that has a regionalized subdomain: A

      • Elastic Load Balancing load balancer: A | AAAA

      • S3 bucket: A

      • VPC interface VPC endpoint: A

      • Another resource record set in this hosted zone: The type of the resource record set that the alias references.

      Constraint: Specifying type without specifying name returns an InvalidInput error.


    • start_record_identifier(impl Into<String>) / set_start_record_identifier(Option<String>):
      required: false

      Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      (Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than maxitems resource record sets, the value of the IsTruncated element in the response is true, and the values of the NextRecordName and NextRecordType elements in the response identify the first resource record set in the next group of maxitems resource record sets.


  • On success, responds with ListResourceRecordSetsOutput with field(s):
    • resource_record_sets(Vec::<ResourceRecordSet>):

      Information about multiple resource record sets.

    • is_truncated(bool):

      A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a follow-up pagination request by using the NextRecordName element.

    • next_record_name(Option<String>):

      If the results were truncated, the name of the next record in the list.

      This element is present only if IsTruncated is true.

    • next_record_type(Option<RrType>):

      If the results were truncated, the type of the next record in the list.

      This element is present only if IsTruncated is true.

    • next_record_identifier(Option<String>):

      Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.

      For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

    • max_items(i32):

      The maximum number of records you requested.

  • On failure, responds with SdkError<ListResourceRecordSetsError>
source§

impl Client

source

pub fn list_reusable_delegation_sets( &self ) -> ListReusableDelegationSetsFluentBuilder

Constructs a fluent builder for the ListReusableDelegationSets operation.

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

      If the value of IsTruncated in the previous response was true, you have more reusable delegation sets. To get another group, submit another ListReusableDelegationSets request.

      For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first reusable delegation set that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more reusable delegation sets to get.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      The number of reusable delegation sets that you want Amazon Route 53 to return in the response to this request. If you specify a value greater than 100, Route 53 returns only the first 100 reusable delegation sets.


  • On success, responds with ListReusableDelegationSetsOutput with field(s):
    • delegation_sets(Vec::<DelegationSet>):

      A complex type that contains one DelegationSet element for each reusable delegation set that was created by the current Amazon Web Services account.

    • marker(String):

      For the second and subsequent calls to ListReusableDelegationSets, Marker is the value that you specified for the marker parameter in the request that produced the current response.

    • is_truncated(bool):

      A flag that indicates whether there are more reusable delegation sets to be listed.

    • next_marker(Option<String>):

      If IsTruncated is true, the value of NextMarker identifies the next reusable delegation set that Amazon Route 53 will return if you submit another ListReusableDelegationSets request and specify the value of NextMarker in the marker parameter.

    • max_items(i32):

      The value that you specified for the maxitems parameter in the call to ListReusableDelegationSets that produced the current response.

  • On failure, responds with SdkError<ListReusableDelegationSetsError>
source§

impl Client

source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

source§

impl Client

source

pub fn list_tags_for_resources(&self) -> ListTagsForResourcesFluentBuilder

Constructs a fluent builder for the ListTagsForResources operation.

source§

impl Client

source

pub fn list_traffic_policies(&self) -> ListTrafficPoliciesFluentBuilder

Constructs a fluent builder for the ListTrafficPolicies operation.

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

      (Conditional) For your first request to ListTrafficPolicies, don’t include the TrafficPolicyIdMarker parameter.

      If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of TrafficPolicyIdMarker that was returned in the previous response.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      (Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than MaxItems traffic policies, the value of IsTruncated in the response is true, and the value of TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will return if you submit another request.


  • On success, responds with ListTrafficPoliciesOutput with field(s):
    • traffic_policy_summaries(Vec::<TrafficPolicySummary>):

      A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current Amazon Web Services account.

    • is_truncated(bool):

      A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicies request and specifying the value of TrafficPolicyIdMarker in the TrafficPolicyIdMarker request parameter.

    • traffic_policy_id_marker(String):

      If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies.

    • max_items(i32):

      The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced the current response.

  • On failure, responds with SdkError<ListTrafficPoliciesError>
source§

impl Client

source

pub fn list_traffic_policy_instances( &self ) -> ListTrafficPolicyInstancesFluentBuilder

Constructs a fluent builder for the ListTrafficPolicyInstances operation.

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

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneId, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of traffic policy instances.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.


    • traffic_policy_instance_name_marker(impl Into<String>) / set_traffic_policy_instance_name_marker(Option<String>):
      required: false

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.


    • traffic_policy_instance_type_marker(RrType) / set_traffic_policy_instance_type_marker(Option<RrType>):
      required: false

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a ListTrafficPolicyInstances request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.


  • On success, responds with ListTrafficPolicyInstancesOutput with field(s):
    • traffic_policy_instances(Vec::<TrafficPolicyInstance>):

      A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

    • hosted_zone_id_marker(Option<String>):

      If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

    • traffic_policy_instance_name_marker(Option<String>):

      If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

    • traffic_policy_instance_type_marker(Option<RrType>):

      If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance that Amazon Route 53 will return if you submit another ListTrafficPolicyInstances request.

    • is_truncated(bool):

      A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.

    • max_items(i32):

      The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response.

  • On failure, responds with SdkError<ListTrafficPolicyInstancesError>
source§

impl Client

source

pub fn list_traffic_policy_instances_by_hosted_zone( &self ) -> ListTrafficPolicyInstancesByHostedZoneFluentBuilder

Constructs a fluent builder for the ListTrafficPolicyInstancesByHostedZone operation.

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

      The ID of the hosted zone that you want to list traffic policy instances for.


    • traffic_policy_instance_name_marker(impl Into<String>) / set_traffic_policy_instance_name_marker(Option<String>):
      required: false

      If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.


    • traffic_policy_instance_type_marker(RrType) / set_traffic_policy_instance_type_marker(Option<RrType>):
      required: false

      If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.


  • On success, responds with ListTrafficPolicyInstancesByHostedZoneOutput with field(s):
    • traffic_policy_instances(Vec::<TrafficPolicyInstance>):

      A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

    • traffic_policy_instance_name_marker(Option<String>):

      If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of traffic policy instances.

    • traffic_policy_instance_type_marker(Option<RrType>):

      If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of traffic policy instances.

    • is_truncated(bool):

      A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by submitting another ListTrafficPolicyInstancesByHostedZone request and specifying the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.

    • max_items(i32):

      The value that you specified for the MaxItems parameter in the ListTrafficPolicyInstancesByHostedZone request that produced the current response.

  • On failure, responds with SdkError<ListTrafficPolicyInstancesByHostedZoneError>
source§

impl Client

source

pub fn list_traffic_policy_instances_by_policy( &self ) -> ListTrafficPolicyInstancesByPolicyFluentBuilder

Constructs a fluent builder for the ListTrafficPolicyInstancesByPolicy operation.

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

      The ID of the traffic policy for which you want to list traffic policy instances.


    • traffic_policy_version(i32) / set_traffic_policy_version(Option<i32>):
      required: true

      The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.


    • hosted_zone_id_marker(impl Into<String>) / set_hosted_zone_id_marker(Option<String>):
      required: false

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

      For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.


    • traffic_policy_instance_name_marker(impl Into<String>) / set_traffic_policy_instance_name_marker(Option<String>):
      required: false

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

      For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.


    • traffic_policy_instance_type_marker(RrType) / set_traffic_policy_instance_type_marker(Option<RrType>):
      required: false

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

      For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.


  • On success, responds with ListTrafficPolicyInstancesByPolicyOutput with field(s):
    • traffic_policy_instances(Vec::<TrafficPolicyInstance>):

      A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

    • hosted_zone_id_marker(Option<String>):

      If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of traffic policy instances.

    • traffic_policy_instance_name_marker(Option<String>):

      If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

    • traffic_policy_instance_type_marker(Option<RrType>):

      If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

    • is_truncated(bool):

      A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by calling ListTrafficPolicyInstancesByPolicy again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

    • max_items(i32):

      The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced the current response.

  • On failure, responds with SdkError<ListTrafficPolicyInstancesByPolicyError>
source§

impl Client

source

pub fn list_traffic_policy_versions( &self ) -> ListTrafficPolicyVersionsFluentBuilder

Constructs a fluent builder for the ListTrafficPolicyVersions operation.

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

      Specify the value of Id of the traffic policy for which you want to list all versions.


    • traffic_policy_version_marker(impl Into<String>) / set_traffic_policy_version_marker(Option<String>):
      required: false

      For your first request to ListTrafficPolicyVersions, don’t include the TrafficPolicyVersionMarker parameter.

      If you have more traffic policy versions than the value of MaxItems, ListTrafficPolicyVersions returns only the first group of MaxItems versions. To get more traffic policy versions, submit another ListTrafficPolicyVersions request. For the value of TrafficPolicyVersionMarker, specify the value of TrafficPolicyVersionMarker in the previous response.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than MaxItems versions, the value of IsTruncated in the response is true, and the value of the TrafficPolicyVersionMarker element is the ID of the first version that Route 53 will return if you submit another request.


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

      A list that contains one TrafficPolicy element for each traffic policy version that is associated with the specified traffic policy.

    • is_truncated(bool):

      A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicyVersions request and specifying the value of NextMarker in the marker parameter.

    • traffic_policy_version_marker(String):

      If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy that Amazon Route 53 will return if you submit another request. Call ListTrafficPolicyVersions again and specify the value of TrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.

      This element is present only if IsTruncated is true.

    • max_items(i32):

      The value that you specified for the maxitems parameter in the ListTrafficPolicyVersions request that produced the current response.

  • On failure, responds with SdkError<ListTrafficPolicyVersionsError>
source§

impl Client

source

pub fn list_vpc_association_authorizations( &self ) -> ListVPCAssociationAuthorizationsFluentBuilder

Constructs a fluent builder for the ListVPCAssociationAuthorizations operation.

source§

impl Client

source

pub fn test_dns_answer(&self) -> TestDNSAnswerFluentBuilder

Constructs a fluent builder for the TestDNSAnswer operation.

source§

impl Client

source

pub fn update_health_check(&self) -> UpdateHealthCheckFluentBuilder

Constructs a fluent builder for the UpdateHealthCheck operation.

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

      The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.


    • health_check_version(i64) / set_health_check_version(Option<i64>):
      required: false

      A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check.

      We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update:

      • If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Route 53 updates the health check with the new settings.

      • If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.


    • ip_address(impl Into<String>) / set_ip_address(Option<String>):
      required: false

      The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don’t specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.

      Use one of the following formats for the value of IPAddress:

      • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

      • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

      If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

      If a health check already has a value for IPAddress, you can change the value. However, you can’t update an existing health check to add or remove the value of IPAddress.

      For more information, see FullyQualifiedDomainName.

      Constraints: Route 53 can’t check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can’t create health checks, see the following documents:


    • port(i32) / set_port(Option<i32>):
      required: false

      The port on the endpoint that you want Amazon Route 53 to perform health checks on.

      Don’t specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.


    • resource_path(impl Into<String>) / set_resource_path(Option<String>):
      required: false

      The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

      Specify this value only if you want to change it.


    • fully_qualified_domain_name(impl Into<String>) / set_fully_qualified_domain_name(Option<String>):
      required: false

      Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

      If a health check already has a value for IPAddress, you can change the value. However, you can’t update an existing health check to add or remove the value of IPAddress.

      If you specify a value for IPAddress:

      Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

      When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

      • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

      • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

      • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

      If you don’t specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

      If you don’t specify a value for IPAddress:

      If you don’t specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.

      If you don’t specify a value for IPAddress, you can’t update the health check to remove the FullyQualifiedDomainName; if you don’t specify a value for IPAddress on creation, a FullyQualifiedDomainName is required.

      If you don’t specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there’s no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a “DNS resolution failed” error.

      If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

      In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

      In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn’t pass a Host header.


    • search_string(impl Into<String>) / set_search_string(Option<String>):
      required: false

      If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can’t change the value of Type when you update a health check.)


    • failure_threshold(i32) / set_failure_threshold(Option<i32>):
      required: false

      The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

      If you don’t specify a value for FailureThreshold, the default value is three health checks.


    • inverted(bool) / set_inverted(Option<bool>):
      required: false

      Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.


    • disabled(bool) / set_disabled(Option<bool>):
      required: false

      Stops Route 53 from performing health checks. When you disable a health check, here’s what happens:

      • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

      • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

      • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

      After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

      Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.


    • health_threshold(i32) / set_health_threshold(Option<i32>):
      required: false

      The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements.

      Note the following:

      • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

      • If you specify 0, Route 53 always considers this health check to be healthy.


    • child_health_checks(impl Into<String>) / set_child_health_checks(Option<Vec::<String>>):
      required: false

      A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.


    • enable_sni(bool) / set_enable_sni(Option<bool>):
      required: false

      Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

      Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don’t enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you’re still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

      The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.


    • regions(HealthCheckRegion) / set_regions(Option<Vec::<HealthCheckRegion>>):
      required: false

      A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.


    • alarm_identifier(AlarmIdentifier) / set_alarm_identifier(Option<AlarmIdentifier>):
      required: false

      A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.


    • insufficient_data_health_status(InsufficientDataHealthStatus) / set_insufficient_data_health_status(Option<InsufficientDataHealthStatus>):
      required: false

      When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

      • Healthy: Route 53 considers the health check to be healthy.

      • Unhealthy: Route 53 considers the health check to be unhealthy.

      • LastKnownStatus: By default, Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the status for the health check is healthy.


    • reset_elements(ResettableElementName) / set_reset_elements(Option<Vec::<ResettableElementName>>):
      required: false

      A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:


  • On success, responds with UpdateHealthCheckOutput with field(s):
  • On failure, responds with SdkError<UpdateHealthCheckError>
source§

impl Client

source

pub fn update_hosted_zone_comment(&self) -> UpdateHostedZoneCommentFluentBuilder

Constructs a fluent builder for the UpdateHostedZoneComment operation.

source§

impl Client

source

pub fn update_traffic_policy_comment( &self ) -> UpdateTrafficPolicyCommentFluentBuilder

Constructs a fluent builder for the UpdateTrafficPolicyComment operation.

source§

impl Client

source

pub fn update_traffic_policy_instance( &self ) -> UpdateTrafficPolicyInstanceFluentBuilder

Constructs a fluent builder for the UpdateTrafficPolicyInstance operation.

source§

impl Client

source

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.

source

pub fn config(&self) -> &Config

Returns the client’s configuration.

source§

impl Client

source

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§

source§

impl Clone for Client

source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Client

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Waiters for Client

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more