Struct aws_sdk_outposts::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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_outposts::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_outposts::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_outposts::Client::from_conf(config);

Implementations§

source §

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source §

impl Client

source

pub fn cancel_order(&self) -> CancelOrder

Constructs a fluent builder for the CancelOrder operation.

The fluent builder is configurable:
- order_id(impl Into<String>) / set_order_id(Option<String>):
 The ID of the order.
On success, responds with CancelOrderOutput
On failure, responds with SdkError<CancelOrderError>

source

pub fn create_order(&self) -> CreateOrder

Constructs a fluent builder for the CreateOrder operation.

The fluent builder is configurable:
- outpost_identifier(impl Into<String>) / set_outpost_identifier(Option<String>):
 The ID or the Amazon Resource Name (ARN) of the Outpost.
- line_items(Vec<LineItemRequest>) / set_line_items(Option<Vec<LineItemRequest>>):
 The line items that make up the order.
- payment_option(PaymentOption) / set_payment_option(Option<PaymentOption>):
 The payment option.
- payment_term(PaymentTerm) / set_payment_term(Option<PaymentTerm>):
 The payment terms.
On success, responds with CreateOrderOutput with field(s):
- order(Option<Order>):
 Information about this order.
On failure, responds with SdkError<CreateOrderError>

source

pub fn create_outpost(&self) -> CreateOutpost

Constructs a fluent builder for the CreateOutpost operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the Outpost.
- description(impl Into<String>) / set_description(Option<String>):
 The description of the Outpost.
- site_id(impl Into<String>) / set_site_id(Option<String>):
 The ID or the Amazon Resource Name (ARN) of the site.
- availability_zone(impl Into<String>) / set_availability_zone(Option<String>):
 The Availability Zone.
- availability_zone_id(impl Into<String>) / set_availability_zone_id(Option<String>):
 The ID of the Availability Zone.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 The tags to apply to the Outpost.
- supported_hardware_type(SupportedHardwareType) / set_supported_hardware_type(Option<SupportedHardwareType>):
 The 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

pub fn create_site(&self) -> CreateSite

Constructs a fluent builder for the CreateSite operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the site.
- description(impl Into<String>) / set_description(Option<String>):
 The description of the site.
- notes(impl Into<String>) / set_notes(Option<String>):
 Additional 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(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 The tags to apply to a site.
- operating_address(Address) / set_operating_address(Option<Address>):
 The 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>):
 The location to ship the hardware. This address might be different from the operating address.
- rack_physical_properties(RackPhysicalProperties) / set_rack_physical_properties(Option<RackPhysicalProperties>):
 Information 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

pub fn delete_outpost(&self) -> DeleteOutpost

Constructs a fluent builder for the DeleteOutpost operation.

The fluent builder is configurable:
- outpost_id(impl Into<String>) / set_outpost_id(Option<String>):
 The ID or the Amazon Resource Name (ARN) of the Outpost.
On success, responds with DeleteOutpostOutput
On failure, responds with SdkError<DeleteOutpostError>

source

pub fn delete_site(&self) -> DeleteSite

Constructs a fluent builder for the DeleteSite operation.

The fluent builder is configurable:
- site_id(impl Into<String>) / set_site_id(Option<String>):
 The ID or the Amazon Resource Name (ARN) of the site.
On success, responds with DeleteSiteOutput
On failure, responds with SdkError<DeleteSiteError>

source

pub fn get_catalog_item(&self) -> GetCatalogItem

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>):
 The 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

pub fn get_connection(&self) -> GetConnection

Constructs a fluent builder for the GetConnection operation.

The fluent builder is configurable:
- connection_id(impl Into<String>) / set_connection_id(Option<String>):
 The 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

pub fn get_order(&self) -> GetOrder

Constructs a fluent builder for the GetOrder operation.

The fluent builder is configurable:
- order_id(impl Into<String>) / set_order_id(Option<String>):
 The 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

pub fn get_outpost(&self) -> GetOutpost

Constructs a fluent builder for the GetOutpost operation.

The fluent builder is configurable:
- outpost_id(impl Into<String>) / set_outpost_id(Option<String>):
 The ID or the Amazon Resource Name (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

pub fn get_outpost_instance_types(&self) -> GetOutpostInstanceTypes

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>):
 The ID or the Amazon Resource Name (ARN) of the Outpost.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The pagination token.
- max_results(i32) / set_max_results(Option<i32>):
 The 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

pub fn get_site(&self) -> GetSite

Constructs a fluent builder for the GetSite operation.

The fluent builder is configurable:
- site_id(impl Into<String>) / set_site_id(Option<String>):
 The 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

pub fn get_site_address(&self) -> GetSiteAddress

Constructs a fluent builder for the GetSiteAddress operation.

The fluent builder is configurable:
- site_id(impl Into<String>) / set_site_id(Option<String>):
 The ID or the Amazon Resource Name (ARN) of the site.
- address_type(AddressType) / set_address_type(Option<AddressType>):
 The 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

pub fn list_assets(&self) -> ListAssets

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>):
 The ID or the Amazon Resource Name (ARN) of the Outpost.
- host_id_filter(Vec<String>) / set_host_id_filter(Option<Vec<String>>):
 Filters the results by the host ID of a Dedicated Host.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum page size.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The pagination token.
- status_filter(Vec<AssetState>) / set_status_filter(Option<Vec<AssetState>>):
 Filters 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

pub fn list_catalog_items(&self) -> ListCatalogItems

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>):
 The pagination token.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum page size.
- item_class_filter(Vec<CatalogItemClass>) / set_item_class_filter(Option<Vec<CatalogItemClass>>):
 Filters the results by item class.
- supported_storage_filter(Vec<SupportedStorageEnum>) / set_supported_storage_filter(Option<Vec<SupportedStorageEnum>>):
 Filters the results by storage option.
- ec2_family_filter(Vec<String>) / set_ec2_family_filter(Option<Vec<String>>):
 Filters 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

pub fn list_orders(&self) -> ListOrders

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>):
 The ID or the Amazon Resource Name (ARN) of the Outpost.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The pagination token.
- max_results(i32) / set_max_results(Option<i32>):
 The 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

pub fn list_outposts(&self) -> ListOutposts

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>):
 The pagination token.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum page size.
- life_cycle_status_filter(Vec<String>) / set_life_cycle_status_filter(Option<Vec<String>>):
 Filters the results by the lifecycle status.
- availability_zone_filter(Vec<String>) / set_availability_zone_filter(Option<Vec<String>>):
 Filters the results by Availability Zone (for example, us-east-1a).
- availability_zone_id_filter(Vec<String>) / set_availability_zone_id_filter(Option<Vec<String>>):
 Filters 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

pub fn list_sites(&self) -> ListSites

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>):
 The pagination token.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum page size.
- operating_address_country_code_filter(Vec<String>) / set_operating_address_country_code_filter(Option<Vec<String>>):
 Filters the results by country code.
- operating_address_state_or_region_filter(Vec<String>) / set_operating_address_state_or_region_filter(Option<Vec<String>>):
 Filters the results by state or region.
- operating_address_city_filter(Vec<String>) / set_operating_address_city_filter(Option<Vec<String>>):
 Filters 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

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The 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

pub fn start_connection(&self) -> StartConnection

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>):
 The serial number of the dongle.
- asset_id(impl Into<String>) / set_asset_id(Option<String>):
 The ID of the Outpost server.
- client_public_key(impl Into<String>) / set_client_public_key(Option<String>):
 The public key of the client.
- network_interface_device_index(i32) / set_network_interface_device_index(i32):
 The 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

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The Amazon Resource Name (ARN) of the resource.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 The tags to add to the resource.
On success, responds with TagResourceOutput
On failure, responds with SdkError<TagResourceError>

source

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The Amazon Resource Name (ARN) of the resource.
- tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):
 The tag keys.
On success, responds with UntagResourceOutput
On failure, responds with SdkError<UntagResourceError>

source

pub fn update_outpost(&self) -> UpdateOutpost

Constructs a fluent builder for the UpdateOutpost operation.

The fluent builder is configurable:
- outpost_id(impl Into<String>) / set_outpost_id(Option<String>):
 The ID or the Amazon Resource Name (ARN) of the Outpost.
- name(impl Into<String>) / set_name(Option<String>):
 The name of the Outpost.
- description(impl Into<String>) / set_description(Option<String>):
 The description of the Outpost.
- supported_hardware_type(SupportedHardwareType) / set_supported_hardware_type(Option<SupportedHardwareType>):
 The 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

pub fn update_site(&self) -> UpdateSite

Constructs a fluent builder for the UpdateSite operation.

The fluent builder is configurable:
- site_id(impl Into<String>) / set_site_id(Option<String>):
 The ID or the Amazon Resource Name (ARN) of the site.
- name(impl Into<String>) / set_name(Option<String>):
 The name of the site.
- description(impl Into<String>) / set_description(Option<String>):
 The description of the site.
- notes(impl Into<String>) / set_notes(Option<String>):
 Notes 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

pub fn update_site_address(&self) -> UpdateSiteAddress

Constructs a fluent builder for the UpdateSiteAddress operation.

The fluent builder is configurable:
- site_id(impl Into<String>) / set_site_id(Option<String>):
 The ID or the Amazon Resource Name (ARN) of the site.
- address_type(AddressType) / set_address_type(Option<AddressType>):
 The type of the address.
- address(Address) / set_address(Option<Address>):
 The 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

pub fn update_site_rack_physical_properties(
&self
) -> UpdateSiteRackPhysicalProperties

Constructs a fluent builder for the UpdateSiteRackPhysicalProperties operation.

The fluent builder is configurable:
- site_id(impl Into<String>) / set_site_id(Option<String>):
 The ID or the Amazon Resource Name (ARN) of the site.
- power_draw_kva(PowerDrawKva) / set_power_draw_kva(Option<PowerDrawKva>):
 The power draw, in kVA, available at the hardware placement position for the rack.
- power_phase(PowerPhase) / set_power_phase(Option<PowerPhase>):
 The 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>):
 The power connector that Amazon Web Services should plan to provide for connections to the hardware. Note the correlation between PowerPhase and PowerConnector.
 - 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>):
 Indicates whether the power feed comes above or below the rack.
- uplink_gbps(UplinkGbps) / set_uplink_gbps(Option<UplinkGbps>):
 The uplink speed the rack should support for the connection to the Region.
- uplink_count(UplinkCount) / set_uplink_count(Option<UplinkCount>):
 Racks 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 and UplinkCount.
 - 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>):
 The type of fiber that you will use to attach the Outpost to your network.
- optical_standard(OpticalStandard) / set_optical_standard(Option<OpticalStandard>):
 The 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>):
 The 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

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.

source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic if the conf 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 conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.