aws-elixir v0.10.1

AWS.Outposts (aws-elixir v0.10.1) View Source

Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to customer premises.

By providing local access to Amazon Web Services managed infrastructure, Amazon Web Services Outposts enables customers to build and run applications on premises using the same programming interfaces as in Amazon Web Services Regions, while using local compute and storage resources for lower latency and local data processing needs.

Link to this section Summary

Functions

cancel_order(client, order_id, input, options \\ [])

Cancels an order for an Outpost.

create_order(client, input, options \\ [])

Creates an order for an Outpost.

create_outpost(client, input, options \\ [])

Creates an Outpost.

create_site(client, input, options \\ [])

Creates a site for an Outpost.

delete_outpost(client, outpost_id, input, options \\ [])

Deletes the Outpost.

delete_site(client, site_id, input, options \\ [])

Deletes the site.

get_catalog_item(client, catalog_item_id, options \\ [])

Gets information about a catalog item.

get_order(client, order_id, options \\ [])

Gets an order.

get_outpost(client, outpost_id, options \\ [])

Gets information about the specified Outpost.

get_outpost_instance_types( client, outpost_id, max_results \\ nil, next_token \\ nil, options \\ [] )

Lists the instance types for the specified Outpost.

get_site(client, site_id, options \\ [])

Gets information about the specified Outpost site.

get_site_address(client, site_id, address_type, options \\ [])

Gets the site address.

list_catalog_items( client, ec2_family_filter \\ nil, item_class_filter \\ nil, max_results \\ nil, next_token \\ nil, supported_storage_filter \\ nil, options \\ [] )

Use to create a list of every item in the catalog.

list_orders( client, max_results \\ nil, next_token \\ nil, outpost_identifier_filter \\ nil, options \\ [] )

Create a list of the Outpost orders for your Amazon Web Services account.

list_outposts( client, availability_zone_filter \\ nil, availability_zone_id_filter \\ nil, life_cycle_status_filter \\ nil, max_results \\ nil, next_token \\ nil, options \\ [] )

Create a list of the Outposts for your Amazon Web Services account.

list_sites(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the sites for your Amazon Web Services account.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags for the specified resource.

metadata()
tag_resource(client, resource_arn, input, options \\ [])

Adds tags to the specified resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes tags from the specified resource.

update_site(client, site_id, input, options \\ [])

Updates the site.

update_site_address(client, site_id, input, options \\ [])

Updates the site address.

update_site_rack_physical_properties(client, site_id, input, options \\ [])

Update the physical and logistical details for a rack at a site.

Link to this section Functions

Link to this function

cancel_order(client, order_id, input, options \\ [])

View Source

Cancels an order for an Outpost.

Link to this function

create_order(client, input, options \\ [])

View Source

Creates an order for an Outpost.

Link to this function

create_outpost(client, input, options \\ [])

View Source

Creates an Outpost.

You can specify AvailabilityZone or AvailabilityZoneId.

Link to this function

create_site(client, input, options \\ [])

View Source

Creates a site for an Outpost.

Link to this function

delete_outpost(client, outpost_id, input, options \\ [])

View Source

Deletes the Outpost.

Link to this function

delete_site(client, site_id, input, options \\ [])

View Source

Deletes the site.

Link to this function

get_catalog_item(client, catalog_item_id, options \\ [])

View Source

Gets information about a catalog item.

Link to this function

get_order(client, order_id, options \\ [])

View Source

Gets an order.

Link to this function

get_outpost(client, outpost_id, options \\ [])

View Source

Gets information about the specified Outpost.

Link to this function

get_outpost_instance_types( client, outpost_id, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

Lists the instance types for the specified Outpost.

Link to this function

get_site(client, site_id, options \\ [])

View Source

Gets information about the specified Outpost site.

Link to this function

get_site_address(client, site_id, address_type, options \\ [])

View Source

Gets the site address.

Link to this function

list_catalog_items( client, ec2_family_filter \\ nil, item_class_filter \\ nil, max_results \\ nil, next_token \\ nil, supported_storage_filter \\ nil, options \\ [] )

View Source

Use to create a list of every item in the catalog.

Add filters to your request to return a more specific list of results. Use filters to match an item class, storage option, or EC2 family.

If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

Link to this function

list_orders( client, max_results \\ nil, next_token \\ nil, outpost_identifier_filter \\ nil, options \\ [] )

View Source

Create a list of the Outpost orders for your Amazon Web Services account.

You can filter your request by Outpost to return a more specific list of results.

Link to this function

list_outposts( client, availability_zone_filter \\ nil, availability_zone_id_filter \\ nil, life_cycle_status_filter \\ nil, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

Create a list of the Outposts for your Amazon Web Services account.

Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availability Zone (us-east-1a), and AZ ID (use1-az1).

If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

Link to this function

list_sites(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the sites for your Amazon Web Services account.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags for the specified resource.

Link to this function

metadata()

View Source
Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds tags to the specified resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes tags from the specified resource.

Link to this function

update_site(client, site_id, input, options \\ [])

View Source

Updates the site.

Link to this function

update_site_address(client, site_id, input, options \\ [])

View Source

Updates the site address.

To update a site address with an order IN_PROGRESS, you must wait for the order to complete or cancel the order.

You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.

Link to this function

update_site_rack_physical_properties(client, site_id, input, options \\ [])

View Source

Update the physical and logistical details for a rack at a site.

For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.

To update a rack at a site with an order of IN_PROGRESS, you must wait for the order to complete or cancel the order.