Struct aws_sdk_outposts::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS Outposts
Client for invoking operations on AWS Outposts. Each operation on AWS Outposts 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_outposts::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_outposts::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 CancelCapacityTask
operation has
a Client::cancel_capacity_task
, 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.cancel_capacity_task()
.capacity_task_id("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn cancel_capacity_task(&self) -> CancelCapacityTaskFluentBuilder
pub fn cancel_capacity_task(&self) -> CancelCapacityTaskFluentBuilder
Constructs a fluent builder for the CancelCapacityTask
operation.
- The fluent builder is configurable:
capacity_task_id(impl Into<String>)
/set_capacity_task_id(Option<String>)
:
required: trueID of the capacity task that you want to cancel.
outpost_identifier(impl Into<String>)
/set_outpost_identifier(Option<String>)
:
required: trueID or ARN of the Outpost associated with the capacity task that you want to cancel.
- On success, responds with
CancelCapacityTaskOutput
- On failure, responds with
SdkError<CancelCapacityTaskError>
source§impl Client
impl Client
sourcepub fn cancel_order(&self) -> CancelOrderFluentBuilder
pub fn cancel_order(&self) -> CancelOrderFluentBuilder
Constructs a fluent builder for the CancelOrder
operation.
- The fluent builder is configurable:
order_id(impl Into<String>)
/set_order_id(Option<String>)
:
required: trueThe ID of the order.
- On success, responds with
CancelOrderOutput
- On failure, responds with
SdkError<CancelOrderError>
source§impl Client
impl Client
sourcepub fn create_order(&self) -> CreateOrderFluentBuilder
pub fn create_order(&self) -> CreateOrderFluentBuilder
Constructs a fluent builder for the CreateOrder
operation.
- The fluent builder is configurable:
outpost_identifier(impl Into<String>)
/set_outpost_identifier(Option<String>)
:
required: trueThe ID or the Amazon Resource Name (ARN) of the Outpost.
line_items(LineItemRequest)
/set_line_items(Option<Vec::<LineItemRequest>>)
:
required: trueThe line items that make up the order.
payment_option(PaymentOption)
/set_payment_option(Option<PaymentOption>)
:
required: trueThe payment option.
payment_term(PaymentTerm)
/set_payment_term(Option<PaymentTerm>)
:
required: falseThe payment terms.
- On success, responds with
CreateOrderOutput
with field(s):order(Option<Order>)
:Information about this order.
- On failure, responds with
SdkError<CreateOrderError>
source§impl Client
impl Client
sourcepub fn create_outpost(&self) -> CreateOutpostFluentBuilder
pub fn create_outpost(&self) -> CreateOutpostFluentBuilder
Constructs a fluent builder for the CreateOutpost
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the Outpost.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the Outpost.
site_id(impl Into<String>)
/set_site_id(Option<String>)
:
required: trueThe ID or the Amazon Resource Name (ARN) of the site.
availability_zone(impl Into<String>)
/set_availability_zone(Option<String>)
:
required: falseThe Availability Zone.
availability_zone_id(impl Into<String>)
/set_availability_zone_id(Option<String>)
:
required: falseThe ID of the Availability Zone.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags to apply to the Outpost.
supported_hardware_type(SupportedHardwareType)
/set_supported_hardware_type(Option<SupportedHardwareType>)
:
required: falseThe type of hardware for this Outpost.
- On success, responds with
CreateOutpostOutput
with field(s):outpost(Option<Outpost>)
:Information about an Outpost.
- On failure, responds with
SdkError<CreateOutpostError>
source§impl Client
impl Client
sourcepub fn create_site(&self) -> CreateSiteFluentBuilder
pub fn create_site(&self) -> CreateSiteFluentBuilder
Constructs a fluent builder for the CreateSite
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the site.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the site.
notes(impl Into<String>)
/set_notes(Option<String>)
:
required: falseAdditional information that you provide about site access requirements, electrician scheduling, personal protective equipment, or regulation of equipment materials that could affect your installation process.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags to apply to a site.
operating_address(Address)
/set_operating_address(Option<Address>)
:
required: falseThe location to install and power on the hardware. This address might be different from the shipping address.
shipping_address(Address)
/set_shipping_address(Option<Address>)
:
required: falseThe location to ship the hardware. This address might be different from the operating address.
rack_physical_properties(RackPhysicalProperties)
/set_rack_physical_properties(Option<RackPhysicalProperties>)
:
required: falseInformation about the physical and logistical details for the rack at this site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.
- On success, responds with
CreateSiteOutput
with field(s):site(Option<Site>)
:Information about a site.
- On failure, responds with
SdkError<CreateSiteError>
source§impl Client
impl Client
sourcepub fn delete_outpost(&self) -> DeleteOutpostFluentBuilder
pub fn delete_outpost(&self) -> DeleteOutpostFluentBuilder
Constructs a fluent builder for the DeleteOutpost
operation.
- The fluent builder is configurable:
outpost_id(impl Into<String>)
/set_outpost_id(Option<String>)
:
required: trueThe ID or ARN of the Outpost.
- On success, responds with
DeleteOutpostOutput
- On failure, responds with
SdkError<DeleteOutpostError>
source§impl Client
impl Client
sourcepub fn delete_site(&self) -> DeleteSiteFluentBuilder
pub fn delete_site(&self) -> DeleteSiteFluentBuilder
Constructs a fluent builder for the DeleteSite
operation.
- The fluent builder is configurable:
site_id(impl Into<String>)
/set_site_id(Option<String>)
:
required: trueThe ID or the Amazon Resource Name (ARN) of the site.
- On success, responds with
DeleteSiteOutput
- On failure, responds with
SdkError<DeleteSiteError>
source§impl Client
impl Client
sourcepub fn get_capacity_task(&self) -> GetCapacityTaskFluentBuilder
pub fn get_capacity_task(&self) -> GetCapacityTaskFluentBuilder
Constructs a fluent builder for the GetCapacityTask
operation.
- The fluent builder is configurable:
capacity_task_id(impl Into<String>)
/set_capacity_task_id(Option<String>)
:
required: trueID of the capacity task.
outpost_identifier(impl Into<String>)
/set_outpost_identifier(Option<String>)
:
required: trueID or ARN of the Outpost associated with the specified capacity task.
- On success, responds with
GetCapacityTaskOutput
with field(s):capacity_task_id(Option<String>)
:ID of the capacity task.
outpost_id(Option<String>)
:ID of the Outpost associated with the specified capacity task.
order_id(Option<String>)
:ID of the Amazon Web Services Outposts order associated with the specified capacity task.
requested_instance_pools(Option<Vec::<InstanceTypeCapacity>>)
:List of instance pools requested in the capacity task.
dry_run(bool)
:Performs a dry run to determine if you are above or below instance capacity.
capacity_task_status(Option<CapacityTaskStatus>)
:Status of the capacity task.
A capacity task can have one of the following statuses:
-
REQUESTED
- The capacity task was created and is awaiting the next step by Amazon Web Services Outposts. -
IN_PROGRESS
- The capacity task is running and cannot be cancelled. -
WAITING_FOR_EVACUATION
- The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.
-
failed(Option<CapacityTaskFailure>)
:Reason why the capacity task failed.
creation_date(Option<DateTime>)
:The date the capacity task was created.
completion_date(Option<DateTime>)
:The date the capacity task ran successfully.
last_modified_date(Option<DateTime>)
:The date the capacity task was last modified.
- On failure, responds with
SdkError<GetCapacityTaskError>
source§impl Client
impl Client
sourcepub fn get_catalog_item(&self) -> GetCatalogItemFluentBuilder
pub fn get_catalog_item(&self) -> GetCatalogItemFluentBuilder
Constructs a fluent builder for the GetCatalogItem
operation.
- The fluent builder is configurable:
catalog_item_id(impl Into<String>)
/set_catalog_item_id(Option<String>)
:
required: trueThe ID of the catalog item.
- On success, responds with
GetCatalogItemOutput
with field(s):catalog_item(Option<CatalogItem>)
:Information about this catalog item.
- On failure, responds with
SdkError<GetCatalogItemError>
source§impl Client
impl Client
sourcepub fn get_connection(&self) -> GetConnectionFluentBuilder
pub fn get_connection(&self) -> GetConnectionFluentBuilder
Constructs a fluent builder for the GetConnection
operation.
- The fluent builder is configurable:
connection_id(impl Into<String>)
/set_connection_id(Option<String>)
:
required: trueThe ID of the connection.
- On success, responds with
GetConnectionOutput
with field(s):connection_id(Option<String>)
:The ID of the connection.
connection_details(Option<ConnectionDetails>)
:Information about the connection.
- On failure, responds with
SdkError<GetConnectionError>
source§impl Client
impl Client
sourcepub fn get_order(&self) -> GetOrderFluentBuilder
pub fn get_order(&self) -> GetOrderFluentBuilder
Constructs a fluent builder for the GetOrder
operation.
- The fluent builder is configurable:
order_id(impl Into<String>)
/set_order_id(Option<String>)
:
required: trueThe ID of the order.
- On success, responds with
GetOrderOutput
with field(s):order(Option<Order>)
:Information about an order.
- On failure, responds with
SdkError<GetOrderError>
source§impl Client
impl Client
sourcepub fn get_outpost(&self) -> GetOutpostFluentBuilder
pub fn get_outpost(&self) -> GetOutpostFluentBuilder
Constructs a fluent builder for the GetOutpost
operation.
- The fluent builder is configurable:
outpost_id(impl Into<String>)
/set_outpost_id(Option<String>)
:
required: trueThe ID or ARN of the Outpost.
- On success, responds with
GetOutpostOutput
with field(s):outpost(Option<Outpost>)
:Information about an Outpost.
- On failure, responds with
SdkError<GetOutpostError>
source§impl Client
impl Client
sourcepub fn get_outpost_instance_types(&self) -> GetOutpostInstanceTypesFluentBuilder
pub fn get_outpost_instance_types(&self) -> GetOutpostInstanceTypesFluentBuilder
Constructs a fluent builder for the GetOutpostInstanceTypes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
outpost_id(impl Into<String>)
/set_outpost_id(Option<String>)
:
required: trueThe ID or ARN of the Outpost.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum page size.
- On success, responds with
GetOutpostInstanceTypesOutput
with field(s):instance_types(Option<Vec::<InstanceTypeItem>>)
:Information about the instance types.
next_token(Option<String>)
:The pagination token.
outpost_id(Option<String>)
:The ID of the Outpost.
outpost_arn(Option<String>)
:The Amazon Resource Name (ARN) of the Outpost.
- On failure, responds with
SdkError<GetOutpostInstanceTypesError>
source§impl Client
impl Client
sourcepub fn get_outpost_supported_instance_types(
&self
) -> GetOutpostSupportedInstanceTypesFluentBuilder
pub fn get_outpost_supported_instance_types( &self ) -> GetOutpostSupportedInstanceTypesFluentBuilder
Constructs a fluent builder for the GetOutpostSupportedInstanceTypes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
outpost_identifier(impl Into<String>)
/set_outpost_identifier(Option<String>)
:
required: trueThe ID or ARN of the Outpost.
order_id(impl Into<String>)
/set_order_id(Option<String>)
:
required: trueThe ID for the Amazon Web Services Outposts order.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum page size.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
- On success, responds with
GetOutpostSupportedInstanceTypesOutput
with field(s):instance_types(Option<Vec::<InstanceTypeItem>>)
:Information about the instance types.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<GetOutpostSupportedInstanceTypesError>
source§impl Client
impl Client
sourcepub fn get_site(&self) -> GetSiteFluentBuilder
pub fn get_site(&self) -> GetSiteFluentBuilder
Constructs a fluent builder for the GetSite
operation.
- The fluent builder is configurable:
site_id(impl Into<String>)
/set_site_id(Option<String>)
:
required: trueThe ID or the Amazon Resource Name (ARN) of the site.
- On success, responds with
GetSiteOutput
with field(s):site(Option<Site>)
:Information about a site.
- On failure, responds with
SdkError<GetSiteError>
source§impl Client
impl Client
sourcepub fn get_site_address(&self) -> GetSiteAddressFluentBuilder
pub fn get_site_address(&self) -> GetSiteAddressFluentBuilder
Constructs a fluent builder for the GetSiteAddress
operation.
- The fluent builder is configurable:
site_id(impl Into<String>)
/set_site_id(Option<String>)
:
required: trueThe ID or the Amazon Resource Name (ARN) of the site.
address_type(AddressType)
/set_address_type(Option<AddressType>)
:
required: trueThe type of the address you request.
- On success, responds with
GetSiteAddressOutput
with field(s):site_id(Option<String>)
:The ID of the site.
address_type(Option<AddressType>)
:The type of the address you receive.
address(Option<Address>)
:Information about the address.
- On failure, responds with
SdkError<GetSiteAddressError>
source§impl Client
impl Client
sourcepub fn list_assets(&self) -> ListAssetsFluentBuilder
pub fn list_assets(&self) -> ListAssetsFluentBuilder
Constructs a fluent builder for the ListAssets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
outpost_identifier(impl Into<String>)
/set_outpost_identifier(Option<String>)
:
required: trueThe ID or the Amazon Resource Name (ARN) of the Outpost.
host_id_filter(impl Into<String>)
/set_host_id_filter(Option<Vec::<String>>)
:
required: falseFilters the results by the host ID of a Dedicated Host.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum page size.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
status_filter(AssetState)
/set_status_filter(Option<Vec::<AssetState>>)
:
required: falseFilters the results by state.
- On success, responds with
ListAssetsOutput
with field(s):assets(Option<Vec::<AssetInfo>>)
:Information about the hardware assets.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListAssetsError>
source§impl Client
impl Client
sourcepub fn list_capacity_tasks(&self) -> ListCapacityTasksFluentBuilder
pub fn list_capacity_tasks(&self) -> ListCapacityTasksFluentBuilder
Constructs a fluent builder for the ListCapacityTasks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
outpost_identifier_filter(impl Into<String>)
/set_outpost_identifier_filter(Option<String>)
:
required: falseFilters the results by an Outpost ID or an Outpost ARN.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum page size.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
capacity_task_status_filter(CapacityTaskStatus)
/set_capacity_task_status_filter(Option<Vec::<CapacityTaskStatus>>)
:
required: falseA list of statuses. For example,
REQUESTED
orWAITING_FOR_EVACUATION
.
- On success, responds with
ListCapacityTasksOutput
with field(s):capacity_tasks(Option<Vec::<CapacityTaskSummary>>)
:Lists all the capacity tasks.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListCapacityTasksError>
source§impl Client
impl Client
sourcepub fn list_catalog_items(&self) -> ListCatalogItemsFluentBuilder
pub fn list_catalog_items(&self) -> ListCatalogItemsFluentBuilder
Constructs a fluent builder for the ListCatalogItems
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum page size.
item_class_filter(CatalogItemClass)
/set_item_class_filter(Option<Vec::<CatalogItemClass>>)
:
required: falseFilters the results by item class.
supported_storage_filter(SupportedStorageEnum)
/set_supported_storage_filter(Option<Vec::<SupportedStorageEnum>>)
:
required: falseFilters the results by storage option.
ec2_family_filter(impl Into<String>)
/set_ec2_family_filter(Option<Vec::<String>>)
:
required: falseFilters the results by EC2 family (for example, M5).
- On success, responds with
ListCatalogItemsOutput
with field(s):catalog_items(Option<Vec::<CatalogItem>>)
:Information about the catalog items.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListCatalogItemsError>
source§impl Client
impl Client
sourcepub fn list_orders(&self) -> ListOrdersFluentBuilder
pub fn list_orders(&self) -> ListOrdersFluentBuilder
Constructs a fluent builder for the ListOrders
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
outpost_identifier_filter(impl Into<String>)
/set_outpost_identifier_filter(Option<String>)
:
required: falseThe ID or the Amazon Resource Name (ARN) of the Outpost.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum page size.
- On success, responds with
ListOrdersOutput
with field(s):orders(Option<Vec::<OrderSummary>>)
:Information about the orders.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListOrdersError>
source§impl Client
impl Client
sourcepub fn list_outposts(&self) -> ListOutpostsFluentBuilder
pub fn list_outposts(&self) -> ListOutpostsFluentBuilder
Constructs a fluent builder for the ListOutposts
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum page size.
life_cycle_status_filter(impl Into<String>)
/set_life_cycle_status_filter(Option<Vec::<String>>)
:
required: falseFilters the results by the lifecycle status.
availability_zone_filter(impl Into<String>)
/set_availability_zone_filter(Option<Vec::<String>>)
:
required: falseFilters the results by Availability Zone (for example,
us-east-1a
).availability_zone_id_filter(impl Into<String>)
/set_availability_zone_id_filter(Option<Vec::<String>>)
:
required: falseFilters the results by AZ ID (for example,
use1-az1
).
- On success, responds with
ListOutpostsOutput
with field(s):outposts(Option<Vec::<Outpost>>)
:Information about the Outposts.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListOutpostsError>
source§impl Client
impl Client
sourcepub fn list_sites(&self) -> ListSitesFluentBuilder
pub fn list_sites(&self) -> ListSitesFluentBuilder
Constructs a fluent builder for the ListSites
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum page size.
operating_address_country_code_filter(impl Into<String>)
/set_operating_address_country_code_filter(Option<Vec::<String>>)
:
required: falseFilters the results by country code.
operating_address_state_or_region_filter(impl Into<String>)
/set_operating_address_state_or_region_filter(Option<Vec::<String>>)
:
required: falseFilters the results by state or region.
operating_address_city_filter(impl Into<String>)
/set_operating_address_city_filter(Option<Vec::<String>>)
:
required: falseFilters the results by city.
- On success, responds with
ListSitesOutput
with field(s):sites(Option<Vec::<Site>>)
:Information about the sites.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListSitesError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:The resource tags.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn start_capacity_task(&self) -> StartCapacityTaskFluentBuilder
pub fn start_capacity_task(&self) -> StartCapacityTaskFluentBuilder
Constructs a fluent builder for the StartCapacityTask
operation.
- The fluent builder is configurable:
outpost_identifier(impl Into<String>)
/set_outpost_identifier(Option<String>)
:
required: trueThe ID or ARN of the Outposts associated with the specified capacity task.
order_id(impl Into<String>)
/set_order_id(Option<String>)
:
required: trueThe ID of the Amazon Web Services Outposts order associated with the specified capacity task.
instance_pools(InstanceTypeCapacity)
/set_instance_pools(Option<Vec::<InstanceTypeCapacity>>)
:
required: trueThe instance pools specified in the capacity task.
dry_run(bool)
/set_dry_run(Option<bool>)
:
required: falseYou can request a dry run to determine if the instance type and instance size changes is above or below available instance capacity. Requesting a dry run does not make any changes to your plan.
- On success, responds with
StartCapacityTaskOutput
with field(s):capacity_task_id(Option<String>)
:ID of the capacity task that you want to start.
outpost_id(Option<String>)
:ID of the Outpost associated with the capacity task.
order_id(Option<String>)
:ID of the Amazon Web Services Outposts order of the host associated with the capacity task.
requested_instance_pools(Option<Vec::<InstanceTypeCapacity>>)
:List of the instance pools requested in the specified capacity task.
dry_run(bool)
:Results of the dry run showing if the specified capacity task is above or below the available instance capacity.
capacity_task_status(Option<CapacityTaskStatus>)
:Status of the specified capacity task.
failed(Option<CapacityTaskFailure>)
:Reason that the specified capacity task failed.
creation_date(Option<DateTime>)
:Date that the specified capacity task was created.
completion_date(Option<DateTime>)
:Date that the specified capacity task ran successfully.
last_modified_date(Option<DateTime>)
:Date that the specified capacity task was last modified.
- On failure, responds with
SdkError<StartCapacityTaskError>
source§impl Client
impl Client
sourcepub fn start_connection(&self) -> StartConnectionFluentBuilder
pub fn start_connection(&self) -> StartConnectionFluentBuilder
Constructs a fluent builder for the StartConnection
operation.
- The fluent builder is configurable:
device_serial_number(impl Into<String>)
/set_device_serial_number(Option<String>)
:
required: falseThe serial number of the dongle.
asset_id(impl Into<String>)
/set_asset_id(Option<String>)
:
required: trueThe ID of the Outpost server.
client_public_key(impl Into<String>)
/set_client_public_key(Option<String>)
:
required: trueThe public key of the client.
network_interface_device_index(i32)
/set_network_interface_device_index(Option<i32>)
:
required: trueThe device index of the network interface on the Outpost server.
- On success, responds with
StartConnectionOutput
with field(s):connection_id(Option<String>)
:The ID of the connection.
underlay_ip_address(Option<String>)
:The underlay IP address.
- On failure, responds with
SdkError<StartConnectionError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueThe tags to add to the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe tag keys.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_outpost(&self) -> UpdateOutpostFluentBuilder
pub fn update_outpost(&self) -> UpdateOutpostFluentBuilder
Constructs a fluent builder for the UpdateOutpost
operation.
- The fluent builder is configurable:
outpost_id(impl Into<String>)
/set_outpost_id(Option<String>)
:
required: trueThe ID or ARN of the Outpost.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the Outpost.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the Outpost.
supported_hardware_type(SupportedHardwareType)
/set_supported_hardware_type(Option<SupportedHardwareType>)
:
required: falseThe type of hardware for this Outpost.
- On success, responds with
UpdateOutpostOutput
with field(s):outpost(Option<Outpost>)
:Information about an Outpost.
- On failure, responds with
SdkError<UpdateOutpostError>
source§impl Client
impl Client
sourcepub fn update_site(&self) -> UpdateSiteFluentBuilder
pub fn update_site(&self) -> UpdateSiteFluentBuilder
Constructs a fluent builder for the UpdateSite
operation.
- The fluent builder is configurable:
site_id(impl Into<String>)
/set_site_id(Option<String>)
:
required: trueThe ID or the Amazon Resource Name (ARN) of the site.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the site.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the site.
notes(impl Into<String>)
/set_notes(Option<String>)
:
required: falseNotes about a site.
- On success, responds with
UpdateSiteOutput
with field(s):site(Option<Site>)
:Information about a site.
- On failure, responds with
SdkError<UpdateSiteError>
source§impl Client
impl Client
sourcepub fn update_site_address(&self) -> UpdateSiteAddressFluentBuilder
pub fn update_site_address(&self) -> UpdateSiteAddressFluentBuilder
Constructs a fluent builder for the UpdateSiteAddress
operation.
- The fluent builder is configurable:
site_id(impl Into<String>)
/set_site_id(Option<String>)
:
required: trueThe ID or the Amazon Resource Name (ARN) of the site.
address_type(AddressType)
/set_address_type(Option<AddressType>)
:
required: trueThe type of the address.
address(Address)
/set_address(Option<Address>)
:
required: trueThe address for the site.
- On success, responds with
UpdateSiteAddressOutput
with field(s):address_type(Option<AddressType>)
:The type of the address.
address(Option<Address>)
:Information about an address.
- On failure, responds with
SdkError<UpdateSiteAddressError>
source§impl Client
impl Client
sourcepub fn update_site_rack_physical_properties(
&self
) -> UpdateSiteRackPhysicalPropertiesFluentBuilder
pub fn update_site_rack_physical_properties( &self ) -> UpdateSiteRackPhysicalPropertiesFluentBuilder
Constructs a fluent builder for the UpdateSiteRackPhysicalProperties
operation.
- The fluent builder is configurable:
site_id(impl Into<String>)
/set_site_id(Option<String>)
:
required: trueThe ID or the Amazon Resource Name (ARN) of the site.
power_draw_kva(PowerDrawKva)
/set_power_draw_kva(Option<PowerDrawKva>)
:
required: falseThe power draw, in kVA, available at the hardware placement position for the rack.
power_phase(PowerPhase)
/set_power_phase(Option<PowerPhase>)
:
required: falseThe power option that you can provide for hardware.
-
Single-phase AC feed: 200 V to 277 V, 50 Hz or 60 Hz
-
Three-phase AC feed: 346 V to 480 V, 50 Hz or 60 Hz
-
power_connector(PowerConnector)
/set_power_connector(Option<PowerConnector>)
:
required: falseThe power connector that Amazon Web Services should plan to provide for connections to the hardware. Note the correlation between
PowerPhase
andPowerConnector
.-
Single-phase AC feed
-
L6-30P – (common in US); 30A; single phase
-
IEC309 (blue) – P+N+E, 6hr; 32 A; single phase
-
-
Three-phase AC feed
-
AH530P7W (red) – 3P+N+E, 7hr; 30A; three phase
-
AH532P6W (red) – 3P+N+E, 6hr; 32A; three phase
-
-
power_feed_drop(PowerFeedDrop)
/set_power_feed_drop(Option<PowerFeedDrop>)
:
required: falseIndicates whether the power feed comes above or below the rack.
uplink_gbps(UplinkGbps)
/set_uplink_gbps(Option<UplinkGbps>)
:
required: falseThe uplink speed the rack should support for the connection to the Region.
uplink_count(UplinkCount)
/set_uplink_count(Option<UplinkCount>)
:
required: falseRacks come with two Outpost network devices. Depending on the supported uplink speed at the site, the Outpost network devices provide a variable number of uplinks. Specify the number of uplinks for each Outpost network device that you intend to use to connect the rack to your network. Note the correlation between
UplinkGbps
andUplinkCount
.-
1Gbps - Uplinks available: 1, 2, 4, 6, 8
-
10Gbps - Uplinks available: 1, 2, 4, 8, 12, 16
-
40 and 100 Gbps- Uplinks available: 1, 2, 4
-
fiber_optic_cable_type(FiberOpticCableType)
/set_fiber_optic_cable_type(Option<FiberOpticCableType>)
:
required: falseThe type of fiber that you will use to attach the Outpost to your network.
optical_standard(OpticalStandard)
/set_optical_standard(Option<OpticalStandard>)
:
required: falseThe type of optical standard that you will use to attach the Outpost to your network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.
-
OPTIC_10GBASE_SR
: 10GBASE-SR -
OPTIC_10GBASE_IR
: 10GBASE-IR -
OPTIC_10GBASE_LR
: 10GBASE-LR -
OPTIC_40GBASE_SR
: 40GBASE-SR -
OPTIC_40GBASE_ESR
: 40GBASE-ESR -
OPTIC_40GBASE_IR4_LR4L
: 40GBASE-IR (LR4L) -
OPTIC_40GBASE_LR4
: 40GBASE-LR4 -
OPTIC_100GBASE_SR4
: 100GBASE-SR4 -
OPTIC_100GBASE_CWDM4
: 100GBASE-CWDM4 -
OPTIC_100GBASE_LR4
: 100GBASE-LR4 -
OPTIC_100G_PSM4_MSA
: 100G PSM4 MSA -
OPTIC_1000BASE_LX
: 1000Base-LX -
OPTIC_1000BASE_SX
: 1000Base-SX
-
maximum_supported_weight_lbs(MaximumSupportedWeightLbs)
/set_maximum_supported_weight_lbs(Option<MaximumSupportedWeightLbs>)
:
required: falseThe maximum rack weight that this site can support.
NO_LIMIT
is over 2000lbs.
- On success, responds with
UpdateSiteRackPhysicalPropertiesOutput
with field(s):site(Option<Site>)
:Information about a site.
- On failure, responds with
SdkError<UpdateSiteRackPhysicalPropertiesError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
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
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
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 thesleep_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 thehttp_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, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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