aws-elixir

View Source AWS.Outposts (aws-elixir v1.0.4)

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_capacity_task(client, capacity_task_id, outpost_identifier, input, options \\ [])

Cancels the capacity task.

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

Cancels the specified 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 specified Outpost.

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

Deletes the specified site.

get_capacity_task(client, capacity_task_id, outpost_identifier, options \\ [])

Gets details of the specified capacity task.

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

Gets information about the specified catalog item.

get_connection(client, connection_id, options \\ [])

Amazon Web Services uses this action to install Outpost servers.

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

Gets information about the specified 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 \\ [])

Gets the instance types for the specified Outpost.

get_outpost_supported_instance_types(client, outpost_identifier, max_results \\ nil, next_token \\ nil, order_id \\ nil, options \\ [])

Gets the instance types that an Outpost can support in InstanceTypeCapacity.

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 of the specified site.

list_asset_instances(client, outpost_identifier, account_id_filter \\ nil, asset_id_filter \\ nil, aws_service_filter \\ nil, instance_type_filter \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

A list of Amazon EC2 instances, belonging to all accounts, running on the specified Outpost.

list_assets(client, outpost_identifier, host_id_filter \\ nil, max_results \\ nil, next_token \\ nil, status_filter \\ nil, options \\ [])

Lists the hardware assets for the specified Outpost.

list_blocking_instances_for_capacity_task(client, capacity_task_id, outpost_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

A list of Amazon EC2 instances running on the Outpost and belonging to the account that initiated the capacity task.

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

Lists the capacity tasks for your Amazon Web Services account.

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

Lists the items in the catalog.

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

Lists 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 \\ [])

Lists the Outposts for your Amazon Web Services account.

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

Lists the Outpost sites for your Amazon Web Services account.

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

Lists the tags for the specified resource.

metadata()
start_capacity_task(client, outpost_identifier, input, options \\ [])

Starts the specified capacity task.

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

Amazon Web Services uses this action to install Outpost servers.

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_outpost(client, outpost_id, input, options \\ [])

Updates an Outpost.

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

Updates the specified site.

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

Updates the address of the specified site.

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_capacity_task(client, capacity_task_id, outpost_identifier, input, options \\ [])

View Source

Cancels the capacity task.

Link to this function

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

View Source

Cancels the specified 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 either an Availability one or an AZ ID.

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 specified Outpost.

Link to this function

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

View Source

Deletes the specified site.

Link to this function

get_capacity_task(client, capacity_task_id, outpost_identifier, options \\ [])

View Source

Gets details of the specified capacity task.

Link to this function

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

View Source

Gets information about the specified catalog item.

Link to this function

get_connection(client, connection_id, options \\ [])

View Source

Amazon Web Services uses this action to install Outpost servers.

Gets information about the specified connection.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

Link to this function

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

View Source

Gets information about the specified 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

Gets the instance types for the specified Outpost.

Link to this function

get_outpost_supported_instance_types(client, outpost_identifier, max_results \\ nil, next_token \\ nil, order_id \\ nil, options \\ [])

View Source

Gets the instance types that an Outpost can support in InstanceTypeCapacity.

This will generally include instance types that are not currently configured and therefore cannot be launched with the current Outpost capacity configuration.

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 of the specified site.

Link to this function

list_asset_instances(client, outpost_identifier, account_id_filter \\ nil, asset_id_filter \\ nil, aws_service_filter \\ nil, instance_type_filter \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

A list of Amazon EC2 instances, belonging to all accounts, running on the specified Outpost.

Does not include Amazon EBS or Amazon S3 instances.

Link to this function

list_assets(client, outpost_identifier, host_id_filter \\ nil, max_results \\ nil, next_token \\ nil, status_filter \\ nil, options \\ [])

View Source

Lists the hardware assets for the specified Outpost.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

Link to this function

list_blocking_instances_for_capacity_task(client, capacity_task_id, outpost_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

A list of Amazon EC2 instances running on the Outpost and belonging to the account that initiated the capacity task.

Use this list to specify the instances you cannot stop to free up capacity to run the capacity task.

Link to this function

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

View Source

Lists the capacity tasks for your Amazon Web Services account.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

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

Lists the items in the catalog.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

Link to this function

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

View Source

Lists the Outpost orders for your Amazon Web Services account.

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

Lists the Outposts for your Amazon Web Services account.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

Link to this function

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

View Source

Lists the Outpost sites for your Amazon Web Services account.

Use filters to return specific results.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

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

start_capacity_task(client, outpost_identifier, input, options \\ [])

View Source

Starts the specified capacity task.

You can have one active capacity task per order or Outpost.

Link to this function

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

View Source

Amazon Web Services uses this action to install Outpost servers.

Starts the connection required for Outpost server installation.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

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_outpost(client, outpost_id, input, options \\ [])

View Source

Updates an Outpost.

Link to this function

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

View Source

Updates the specified site.

Link to this function

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

View Source

Updates the address of the specified site.

You can't update a site address if there is 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.