Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Elastic Compute Cloud

Client for invoking operations on Amazon Elastic Compute Cloud. Each operation on Amazon Elastic Compute Cloud 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_ec2::Client::new(&config);

Occasionally, SDKs may have additional service-specific 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_ec2::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 AcceptAddressTransfer operation has a [Client::accept_address_transfer], 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.accept_address_transfer()
    .address("example")
    .send()
    .await;

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

Implementations

impl Client

pub fn create_vpc_endpoint(&self) -> CreateVpcEndpointFluentBuilder

Constructs a fluent builder for the CreateVpcEndpoint operation.

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

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    
    
  • vpc_endpoint_type(VpcEndpointType) / set_vpc_endpoint_type(Option<VpcEndpointType>):
    required: false
    

    The type of endpoint.

    Default: Gateway

    
    
  • vpc_id(impl Into<String>) / set_vpc_id(Option<String>):
    required: true
    

    The ID of the VPC.

    
    
  • service_name(impl Into<String>) / set_service_name(Option<String>):
    required: true
    

    The name of the endpoint service.

    
    
  • policy_document(impl Into<String>) / set_policy_document(Option<String>):
    required: false
    

    (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

    
    
  • route_table_ids(impl Into<String>) / set_route_table_ids(Option<Vec::<String>>):
    required: false
    

    (Gateway endpoint) The route table IDs.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: false
    

    (Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: false
    

    (Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.

    
    
  • ip_address_type(IpAddressType) / set_ip_address_type(Option<IpAddressType>):
    required: false
    

    The IP address type for the endpoint.

    
    
  • dns_options(DnsOptionsSpecification) / set_dns_options(Option<DnsOptionsSpecification>):
    required: false
    

    The DNS options for the endpoint.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

    
    
  • private_dns_enabled(bool) / set_private_dns_enabled(Option<bool>):
    required: false
    

    (Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

    To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.

    Default: true

    
    
  • tag_specifications(TagSpecification) / set_tag_specifications(Option<Vec::<TagSpecification>>):
    required: false
    

    The tags to associate with the endpoint.

    
    
  • subnet_configurations(SubnetConfiguration) / set_subnet_configurations(Option<Vec::<SubnetConfiguration>>):
    required: false
    

    The subnet configurations for the endpoint.

    
    
• On success, responds with CreateVpcEndpointOutput with field(s):
  • vpc_endpoint(Option<VpcEndpoint>):

    Information about the endpoint.

  • client_token(Option<String>):

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• On failure, responds with SdkError<CreateVpcEndpointError>

impl Client

pub fn delete_vpc_endpoints(&self) -> DeleteVpcEndpointsFluentBuilder

Constructs a fluent builder for the DeleteVpcEndpoints operation.

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

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    
    
  • vpc_endpoint_ids(impl Into<String>) / set_vpc_endpoint_ids(Option<Vec::<String>>):
    required: true
    

    The IDs of the VPC endpoints.

    
    
• On success, responds with DeleteVpcEndpointsOutput with field(s):
  • unsuccessful(Option<Vec::<UnsuccessfulItem>>):

    Information about the VPC endpoints that were not successfully deleted.

• On failure, responds with SdkError<DeleteVpcEndpointsError>

impl Client

pub fn describe_subnets(&self) -> DescribeSubnetsFluentBuilder

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

• The fluent builder is configurable:
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    The filters.

    • availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.

    • availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

    • available-ip-address-count - The number of IPv4 addresses in the subnet that are available.

    • cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet’s CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.

    • customer-owned-ipv4-pool - The customer-owned IPv4 address pool associated with the subnet.

    • default-for-az - Indicates whether this is the default subnet for the Availability Zone (true | false). You can also use defaultForAz as the filter name.

    • enable-dns64 - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

    • enable-lni-at-device-index - Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).

    • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

    • ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

    • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

    • ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).

    • map-customer-owned-ip-on-launch - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.

    • map-public-ip-on-launch - Indicates whether instances launched in this subnet receive a public IPv4 address.

    • outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

    • owner-id - The ID of the Amazon Web Services account that owns the subnet.

    • private-dns-name-options-on-launch.hostname-type - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).

    • private-dns-name-options-on-launch.enable-resource-name-dns-a-record - Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

    • private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

    • state - The state of the subnet (pending | available).

    • subnet-arn - The Amazon Resource Name (ARN) of the subnet.

    • subnet-id - The ID of the subnet.

    • tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    • vpc-id - The ID of the VPC for the subnet.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: false
    

    The IDs of the subnets.

    Default: Describes all your subnets.

    
    
  • dry_run(bool) / set_dry_run(Option<bool>):
    required: false
    

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

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

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

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

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

    
    
• On success, responds with DescribeSubnetsOutput with field(s):
  • subnets(Option<Vec::<Subnet>>):

    Information about one or more subnets.

  • next_token(Option<String>):

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.

• On failure, responds with SdkError<DescribeSubnetsError>

impl Client

pub fn describe_vpc_endpoint_services( &self, ) -> DescribeVpcEndpointServicesFluentBuilder

Constructs a fluent builder for the DescribeVpcEndpointServices operation.

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

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    
    
  • service_names(impl Into<String>) / set_service_names(Option<Vec::<String>>):
    required: false
    

    The service names.

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

    The filters.

    • owner - The ID or alias of the Amazon Web Services account that owns the service.

    • service-name - The name of the service.

    • service-type - The type of service (Interface | Gateway | GatewayLoadBalancer).

    • supported-ip-address-types - The IP address type (ipv4 | ipv6).

    • tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

    The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

    Constraint: If the value is greater than 1,000, we return only 1,000 items.

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

    The token for the next set of items to return. (You received this token from a prior call.)

    
    
• On success, responds with DescribeVpcEndpointServicesOutput with field(s):
  • service_names(Option<Vec::<String>>):

    The supported services.

  • service_details(Option<Vec::<ServiceDetail>>):

    Information about the service.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeVpcEndpointServicesError>

impl Client

pub fn describe_vpc_endpoints(&self) -> DescribeVpcEndpointsFluentBuilder

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

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

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    
    
  • vpc_endpoint_ids(impl Into<String>) / set_vpc_endpoint_ids(Option<Vec::<String>>):
    required: false
    

    The IDs of the VPC endpoints.

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

    The filters.

    • ip-address-type - The IP address type (ipv4 | ipv6).

    • service-name - The name of the service.

    • tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    • vpc-id - The ID of the VPC in which the endpoint resides.

    • vpc-endpoint-id - The ID of the endpoint.

    • vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).

    • vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).

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

    The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

    Constraint: If the value is greater than 1,000, we return only 1,000 items.

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

    The token for the next set of items to return. (You received this token from a prior call.)

    
    
• On success, responds with DescribeVpcEndpointsOutput with field(s):
  • vpc_endpoints(Option<Vec::<VpcEndpoint>>):

    Information about the endpoints.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeVpcEndpointsError>

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.