Outposts
This page documents function available when using the Outposts
module, created with @service Outposts
.
Index
Main.Outposts.create_order
Main.Outposts.create_outpost
Main.Outposts.delete_outpost
Main.Outposts.delete_site
Main.Outposts.get_outpost
Main.Outposts.get_outpost_instance_types
Main.Outposts.list_outposts
Main.Outposts.list_sites
Main.Outposts.list_tags_for_resource
Main.Outposts.tag_resource
Main.Outposts.untag_resource
Documentation
Main.Outposts.create_order
— Methodcreate_order(line_items, outpost_identifier, payment_option)
create_order(line_items, outpost_identifier, payment_option, params::Dict{String,<:Any})
Creates an order for an Outpost.
Arguments
line_items
: The line items that make up the order.outpost_identifier
: The ID or the Amazon Resource Name (ARN) of the Outpost.payment_option
: The payment option for the order.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"PaymentTerm"
: The payment terms for the order.
Main.Outposts.create_outpost
— Methodcreate_outpost(name, site_id)
create_outpost(name, site_id, params::Dict{String,<:Any})
Creates an Outpost. You can specify AvailabilityZone or AvailabilityZoneId.
Arguments
name
:site_id
:
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AvailabilityZone"
:"AvailabilityZoneId"
:"Description"
:"Tags"
: The tags to apply to the Outpost.
Main.Outposts.delete_outpost
— Methoddelete_outpost(outpost_id)
delete_outpost(outpost_id, params::Dict{String,<:Any})
Deletes the Outpost.
Arguments
outpost_id
: The ID of the Outpost.
Main.Outposts.delete_site
— Methoddelete_site(site_id)
delete_site(site_id, params::Dict{String,<:Any})
Deletes the site.
Arguments
site_id
:
Main.Outposts.get_outpost
— Methodget_outpost(outpost_id)
get_outpost(outpost_id, params::Dict{String,<:Any})
Gets information about the specified Outpost.
Arguments
outpost_id
: The ID of the Outpost.
Main.Outposts.get_outpost_instance_types
— Methodget_outpost_instance_types(outpost_id)
get_outpost_instance_types(outpost_id, params::Dict{String,<:Any})
Lists the instance types for the specified Outpost.
Arguments
outpost_id
: The ID of the Outpost.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"MaxResults"
:"NextToken"
:
Main.Outposts.list_outposts
— Methodlist_outposts()
list_outposts(params::Dict{String,<:Any})
Create a list of the Outposts for your AWS account. Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availibility 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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AvailabilityZoneFilter"
: A filter for the Availibility Zone (us-east-1a) of the Outpost. Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values."AvailabilityZoneIdFilter"
: A filter for the AZ IDs (use1-az1) of the Outpost. Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values."LifeCycleStatusFilter"
: A filter for the lifecycle status of the Outpost. Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values."MaxResults"
:"NextToken"
:
Main.Outposts.list_sites
— Methodlist_sites()
list_sites(params::Dict{String,<:Any})
Lists the sites for the specified AWS account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"MaxResults"
:"NextToken"
:
Main.Outposts.list_tags_for_resource
— Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags for the specified resource.
Arguments
resource_arn
: The Amazon Resource Name (ARN) of the resource.
Main.Outposts.tag_resource
— Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds tags to the specified resource.
Arguments
resource_arn
: The Amazon Resource Name (ARN) of the resource.tags
: The tags to add to the resource.
Main.Outposts.untag_resource
— Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from the specified resource.
Arguments
resource_arn
: The Amazon Resource Name (ARN) of the resource.tag_keys
: The tag keys.