Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Outposts

import { Outposts } from "https://aws-api.deno.dev/v0.3/services/outposts.ts?docs=full";
class Outposts {
constructor(apiFactory: client.ApiFactory);
async cancelOrder(params: CancelOrderInput, opts?: client.RequestOptions): Promise<void>;
async createOrder(params: CreateOrderInput, opts?: client.RequestOptions): Promise<CreateOrderOutput>;
async createOutpost(params: CreateOutpostInput, opts?: client.RequestOptions): Promise<CreateOutpostOutput>;
async createSite(params: CreateSiteInput, opts?: client.RequestOptions): Promise<CreateSiteOutput>;
async deleteOutpost(params: DeleteOutpostInput, opts?: client.RequestOptions): Promise<void>;
async deleteSite(params: DeleteSiteInput, opts?: client.RequestOptions): Promise<void>;
async getCatalogItem(params: GetCatalogItemInput, opts?: client.RequestOptions): Promise<GetCatalogItemOutput>;
async getOrder(params: GetOrderInput, opts?: client.RequestOptions): Promise<GetOrderOutput>;
async getOutpost(params: GetOutpostInput, opts?: client.RequestOptions): Promise<GetOutpostOutput>;
async getOutpostInstanceTypes(params: GetOutpostInstanceTypesInput, opts?: client.RequestOptions): Promise<GetOutpostInstanceTypesOutput>;
async getSite(params: GetSiteInput, opts?: client.RequestOptions): Promise<GetSiteOutput>;
async getSiteAddress(params: GetSiteAddressInput, opts?: client.RequestOptions): Promise<GetSiteAddressOutput>;
async listCatalogItems(params?: ListCatalogItemsInput, opts?: client.RequestOptions): Promise<ListCatalogItemsOutput>;
async listOrders(params?: ListOrdersInput, opts?: client.RequestOptions): Promise<ListOrdersOutput>;
async listOutposts(params?: ListOutpostsInput, opts?: client.RequestOptions): Promise<ListOutpostsOutput>;
async listSites(params?: ListSitesInput, opts?: client.RequestOptions): Promise<ListSitesOutput>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateOutpost(params: UpdateOutpostInput, opts?: client.RequestOptions): Promise<UpdateOutpostOutput>;
async updateSite(params: UpdateSiteInput, opts?: client.RequestOptions): Promise<UpdateSiteOutput>;
async updateSiteAddress(params: UpdateSiteAddressInput, opts?: client.RequestOptions): Promise<UpdateSiteAddressOutput>;
async updateSiteRackPhysicalProperties(params: UpdateSiteRackPhysicalPropertiesInput, opts?: client.RequestOptions): Promise<UpdateSiteRackPhysicalPropertiesOutput>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new Outposts(apiFactory: client.ApiFactory)
[src]

§Methods

§
cancelOrder(params: CancelOrderInput, opts?: client.RequestOptions): Promise<void>
[src]

Cancels an order for an Outpost.

§
createOrder(params: CreateOrderInput, opts?: client.RequestOptions): Promise<CreateOrderOutput>
[src]

Creates an order for an Outpost.

§
createOutpost(params: CreateOutpostInput, opts?: client.RequestOptions): Promise<CreateOutpostOutput>
[src]

Creates an Outpost.

You can specify AvailabilityZone or AvailabilityZoneId.

§
createSite(params: CreateSiteInput, opts?: client.RequestOptions): Promise<CreateSiteOutput>
[src]

Creates a site for an Outpost.

§
deleteOutpost(params: DeleteOutpostInput, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the Outpost.

§
deleteSite(params: DeleteSiteInput, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the site.

§
getCatalogItem(params: GetCatalogItemInput, opts?: client.RequestOptions): Promise<GetCatalogItemOutput>
[src]

Gets information about a catalog item.

§
getOrder(params: GetOrderInput, opts?: client.RequestOptions): Promise<GetOrderOutput>
[src]

Gets an order.

§
getOutpost(params: GetOutpostInput, opts?: client.RequestOptions): Promise<GetOutpostOutput>
[src]

Gets information about the specified Outpost.

§

Lists the instance types for the specified Outpost.

§
getSite(params: GetSiteInput, opts?: client.RequestOptions): Promise<GetSiteOutput>
[src]

Gets information about the specified Outpost site.

§
getSiteAddress(params: GetSiteAddressInput, opts?: client.RequestOptions): Promise<GetSiteAddressOutput>
[src]

Gets the site address.

§
listCatalogItems(params?: ListCatalogItemsInput, opts?: client.RequestOptions): Promise<ListCatalogItemsOutput>
[src]

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.

§
listOrders(params?: ListOrdersInput, opts?: client.RequestOptions): Promise<ListOrdersOutput>
[src]

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.

§
listOutposts(params?: ListOutpostsInput, opts?: client.RequestOptions): Promise<ListOutpostsOutput>
[src]

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.

§
listSites(params?: ListSitesInput, opts?: client.RequestOptions): Promise<ListSitesOutput>
[src]

Lists the sites for your Amazon Web Services account.

§

Lists the tags for the specified resource.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Adds tags to the specified resource.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes tags from the specified resource.

§
updateOutpost(params: UpdateOutpostInput, opts?: client.RequestOptions): Promise<UpdateOutpostOutput>
[src]

Updates an Outpost.

§
updateSite(params: UpdateSiteInput, opts?: client.RequestOptions): Promise<UpdateSiteOutput>
[src]

Updates the site.

§

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.

§

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.

§Static Properties