Outposts

import { Outposts } from "https://aws-api.deno.dev/v0.4/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 getConnection(params: GetConnectionRequest, opts?: client.RequestOptions): Promise<GetConnectionResponse>;

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 listAssets(params: ListAssetsInput, opts?: client.RequestOptions): Promise<ListAssetsOutput>;

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 startConnection(params: StartConnectionRequest, opts?: client.RequestOptions): Promise<StartConnectionResponse>;

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

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

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

[src]

Deletes the specified site.

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

[src]

Gets information about the specified catalog item.

getConnection(params: GetConnectionRequest, opts?: client.RequestOptions): Promise<GetConnectionResponse>

[src]

Note: 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.

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

[src]

Gets information about the specified order.

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

[src]

Gets information about the specified Outpost.

getOutpostInstanceTypes(params: GetOutpostInstanceTypesInput, opts?: client.RequestOptions): Promise<GetOutpostInstanceTypesOutput>

[src]

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

listAssets(params: ListAssetsInput, opts?: client.RequestOptions): Promise<ListAssetsOutput>

[src]

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.

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

[src]

Lists the items in the catalog.

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

[src]

Lists the Outpost orders for your Amazon Web Services account.

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

[src]

Lists the Outposts for your Amazon Web Services account.

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

[src]

Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists the tags for the specified resource.

startConnection(params: StartConnectionRequest, opts?: client.RequestOptions): Promise<StartConnectionResponse>

[src]

Note: Amazon Web Services uses this action to install Outpost servers.

Starts the connection required for Outpost server installation.

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

updateSiteAddress(params: UpdateSiteAddressInput, opts?: client.RequestOptions): Promise<UpdateSiteAddressOutput>

[src]

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.

updateSiteRackPhysicalProperties(params: UpdateSiteRackPhysicalPropertiesInput, opts?: client.RequestOptions): Promise<UpdateSiteRackPhysicalPropertiesOutput>

[src]

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

ApiMetadata: client.ApiMetadata

[src]