Skip to content

Commit 435b5de

Browse files
author
awstools
committed
feat(client-outposts): This release adds the Asset state information to the ListAssets response. The ListAssets request supports filtering on Asset state.
1 parent caa6cba commit 435b5de

20 files changed

+847
-776
lines changed

clients/client-outposts/src/Outposts.ts

Lines changed: 32 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,7 @@ import { OutpostsClient } from "./OutpostsClient";
9494
*/
9595
export class Outposts extends OutpostsClient {
9696
/**
97-
* <p>
98-
* Cancels an order for an Outpost.
99-
* </p>
97+
* <p>Cancels the specified order for an Outpost.</p>
10098
*/
10199
public cancelOrder(args: CancelOrderCommandInput, options?: __HttpHandlerOptions): Promise<CancelOrderCommandOutput>;
102100
public cancelOrder(args: CancelOrderCommandInput, cb: (err: any, data?: CancelOrderCommandOutput) => void): void;
@@ -149,7 +147,7 @@ export class Outposts extends OutpostsClient {
149147

150148
/**
151149
* <p>Creates an Outpost.</p>
152-
* <p>You can specify <code>AvailabilityZone</code> or <code>AvailabilityZoneId</code>.</p>
150+
* <p>You can specify either an Availability one or an AZ ID.</p>
153151
*/
154152
public createOutpost(
155153
args: CreateOutpostCommandInput,
@@ -209,7 +207,7 @@ export class Outposts extends OutpostsClient {
209207
}
210208

211209
/**
212-
* <p>Deletes the Outpost.</p>
210+
* <p>Deletes the specified Outpost.</p>
213211
*/
214212
public deleteOutpost(
215213
args: DeleteOutpostCommandInput,
@@ -241,7 +239,7 @@ export class Outposts extends OutpostsClient {
241239
}
242240

243241
/**
244-
* <p>Deletes the site.</p>
242+
* <p>Deletes the specified site.</p>
245243
*/
246244
public deleteSite(args: DeleteSiteCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSiteCommandOutput>;
247245
public deleteSite(args: DeleteSiteCommandInput, cb: (err: any, data?: DeleteSiteCommandOutput) => void): void;
@@ -267,7 +265,7 @@ export class Outposts extends OutpostsClient {
267265
}
268266

269267
/**
270-
* <p>Gets information about a catalog item.</p>
268+
* <p>Gets information about the specified catalog item.</p>
271269
*/
272270
public getCatalogItem(
273271
args: GetCatalogItemCommandInput,
@@ -304,7 +302,7 @@ export class Outposts extends OutpostsClient {
304302
* Amazon Web Services uses this action to install Outpost servers.</p>
305303
* </note>
306304
* <p>
307-
* Gets information about a specified connection.
305+
* Gets information about the specified connection.
308306
* </p>
309307
* <p>
310308
* Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For
@@ -343,7 +341,7 @@ export class Outposts extends OutpostsClient {
343341
}
344342

345343
/**
346-
* <p>Gets an order.</p>
344+
* <p>Gets information about the specified order.</p>
347345
*/
348346
public getOrder(args: GetOrderCommandInput, options?: __HttpHandlerOptions): Promise<GetOrderCommandOutput>;
349347
public getOrder(args: GetOrderCommandInput, cb: (err: any, data?: GetOrderCommandOutput) => void): void;
@@ -427,9 +425,7 @@ export class Outposts extends OutpostsClient {
427425
}
428426

429427
/**
430-
* <p>
431-
* Gets information about the specified Outpost site.
432-
* </p>
428+
* <p>Gets information about the specified Outpost site.</p>
433429
*/
434430
public getSite(args: GetSiteCommandInput, options?: __HttpHandlerOptions): Promise<GetSiteCommandOutput>;
435431
public getSite(args: GetSiteCommandInput, cb: (err: any, data?: GetSiteCommandOutput) => void): void;
@@ -456,7 +452,7 @@ export class Outposts extends OutpostsClient {
456452

457453
/**
458454
* <p>
459-
* Gets the site address.
455+
* Gets the site address of the specified site.
460456
* </p>
461457
*/
462458
public getSiteAddress(
@@ -489,11 +485,10 @@ export class Outposts extends OutpostsClient {
489485
}
490486

491487
/**
492-
* <p>
493-
* Lists the hardware assets in an Outpost. If you are using Dedicated Hosts on
494-
* Amazon Web Services Outposts, you can filter your request by host ID to return a list of hardware
495-
* assets that allocate resources for Dedicated Hosts.
496-
* </p>
488+
* <p>Lists the hardware assets for the specified Outpost.</p>
489+
* <p>Use filters to return specific results. If you specify multiple filters, the results include only the resources that match
490+
* all of the specified filters. For a filter where you can specify multiple values, the results include
491+
* items that match any of the values that you specify for the filter.</p>
497492
*/
498493
public listAssets(args: ListAssetsCommandInput, options?: __HttpHandlerOptions): Promise<ListAssetsCommandOutput>;
499494
public listAssets(args: ListAssetsCommandInput, cb: (err: any, data?: ListAssetsCommandOutput) => void): void;
@@ -519,11 +514,10 @@ export class Outposts extends OutpostsClient {
519514
}
520515

521516
/**
522-
* <p>Lists the items in the catalog. Add filters to your request to return a
523-
* more specific list of results. Use filters to match an item class, storage
524-
* option, or EC2 family. </p>
525-
* <p>If you specify multiple filters, the filters are joined with an <code>AND</code>, and
526-
* the request returns only results that match all of the specified filters.</p>
517+
* <p>Lists the items in the catalog.</p>
518+
* <p>Use filters to return specific results. If you specify multiple filters, the results include only the resources that match
519+
* all of the specified filters. For a filter where you can specify multiple values, the results include
520+
* items that match any of the values that you specify for the filter.</p>
527521
*/
528522
public listCatalogItems(
529523
args: ListCatalogItemsCommandInput,
@@ -555,8 +549,7 @@ export class Outposts extends OutpostsClient {
555549
}
556550

557551
/**
558-
* <p>Lists the Outpost orders for your Amazon Web Services account. You can filter your request by Outpost to
559-
* return a more specific list of results. </p>
552+
* <p>Lists the Outpost orders for your Amazon Web Services account.</p>
560553
*/
561554
public listOrders(args: ListOrdersCommandInput, options?: __HttpHandlerOptions): Promise<ListOrdersCommandOutput>;
562555
public listOrders(args: ListOrdersCommandInput, cb: (err: any, data?: ListOrdersCommandOutput) => void): void;
@@ -582,12 +575,10 @@ export class Outposts extends OutpostsClient {
582575
}
583576

584577
/**
585-
* <p>Lists the Outposts for your Amazon Web Services account. Add filters to your request to return
586-
* a more specific list of results. Use filters to match an Outpost lifecycle status,
587-
* Availability Zone (<code>us-east-1a</code>), and AZ ID (<code>use1-az1</code>). </p>
588-
*
589-
* <p>If you specify multiple filters, the filters are joined with an <code>AND</code>, and the request returns only
590-
* results that match all of the specified filters.</p>
578+
* <p>Lists the Outposts for your Amazon Web Services account.</p>
579+
* <p>Use filters to return specific results. If you specify multiple filters, the results include only the resources that match
580+
* all of the specified filters. For a filter where you can specify multiple values, the results include
581+
* items that match any of the values that you specify for the filter.</p>
591582
*/
592583
public listOutposts(
593584
args: ListOutpostsCommandInput,
@@ -616,12 +607,10 @@ export class Outposts extends OutpostsClient {
616607
}
617608

618609
/**
619-
* <p>Lists the Outpost sites for your Amazon Web Services account. Add operating address filters to your request to
620-
* return a more specific list of results. Use filters to match site city, country code, or state/region of the
621-
* operating address. </p>
622-
*
623-
* <p>If you specify multiple filters, the filters are joined with an <code>AND</code>, and the request returns only
624-
* results that match all of the specified filters.</p>
610+
* <p>Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results.</p>
611+
* <p>Use filters to return specific results. If you specify multiple filters, the results include only the resources that match
612+
* all of the specified filters. For a filter where you can specify multiple values, the results include
613+
* items that match any of the values that you specify for the filter.</p>
625614
*/
626615
public listSites(args: ListSitesCommandInput, options?: __HttpHandlerOptions): Promise<ListSitesCommandOutput>;
627616
public listSites(args: ListSitesCommandInput, cb: (err: any, data?: ListSitesCommandOutput) => void): void;
@@ -815,9 +804,7 @@ export class Outposts extends OutpostsClient {
815804
}
816805

817806
/**
818-
* <p>
819-
* Updates the site.
820-
* </p>
807+
* <p>Updates the specified site.</p>
821808
*/
822809
public updateSite(args: UpdateSiteCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSiteCommandOutput>;
823810
public updateSite(args: UpdateSiteCommandInput, cb: (err: any, data?: UpdateSiteCommandOutput) => void): void;
@@ -843,18 +830,11 @@ export class Outposts extends OutpostsClient {
843830
}
844831

845832
/**
846-
* <p>
847-
* Updates the site address.
848-
* </p>
849-
* <p>
850-
* To update a site address
851-
* with an order <code>IN_PROGRESS</code>, you must wait for the order
852-
* to complete or cancel the order.
853-
* </p>
854-
* <p>You
855-
* can update the operating address before you place an order at the
856-
* site, or after all Outposts that belong to the site have been deactivated.
857-
* </p>
833+
* <p>Updates the address of the specified site.</p>
834+
* <p>You can't update a site address if there is an order in progress. You must wait for the order
835+
* to complete or cancel the order.</p>
836+
* <p>You can update the operating address before you place an order at the
837+
* site, or after all Outposts that belong to the site have been deactivated.</p>
858838
*/
859839
public updateSiteAddress(
860840
args: UpdateSiteAddressCommandInput,

clients/client-outposts/src/commands/CancelOrderCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface CancelOrderCommandInput extends CancelOrderInput {}
2828
export interface CancelOrderCommandOutput extends CancelOrderOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>
32-
* Cancels an order for an Outpost.
33-
* </p>
31+
* <p>Cancels the specified order for an Outpost.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript

clients/client-outposts/src/commands/CreateOutpostCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface CreateOutpostCommandOutput extends CreateOutpostOutput, __Metad
2929

3030
/**
3131
* <p>Creates an Outpost.</p>
32-
* <p>You can specify <code>AvailabilityZone</code> or <code>AvailabilityZoneId</code>.</p>
32+
* <p>You can specify either an Availability one or an AZ ID.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

clients/client-outposts/src/commands/DeleteOutpostCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DeleteOutpostCommandInput extends DeleteOutpostInput {}
2828
export interface DeleteOutpostCommandOutput extends DeleteOutpostOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes the Outpost.</p>
31+
* <p>Deletes the specified Outpost.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-outposts/src/commands/DeleteSiteCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DeleteSiteCommandInput extends DeleteSiteInput {}
2828
export interface DeleteSiteCommandOutput extends DeleteSiteOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes the site.</p>
31+
* <p>Deletes the specified site.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-outposts/src/commands/GetCatalogItemCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface GetCatalogItemCommandInput extends GetCatalogItemInput {}
2828
export interface GetCatalogItemCommandOutput extends GetCatalogItemOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets information about a catalog item.</p>
31+
* <p>Gets information about the specified catalog item.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-outposts/src/commands/GetConnectionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface GetConnectionCommandOutput extends GetConnectionResponse, __Met
3333
* Amazon Web Services uses this action to install Outpost servers.</p>
3434
* </note>
3535
* <p>
36-
* Gets information about a specified connection.
36+
* Gets information about the specified connection.
3737
* </p>
3838
* <p>
3939
* Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For

clients/client-outposts/src/commands/GetOrderCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface GetOrderCommandInput extends GetOrderInput {}
2828
export interface GetOrderCommandOutput extends GetOrderOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets an order.</p>
31+
* <p>Gets information about the specified order.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-outposts/src/commands/GetSiteAddressCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface GetSiteAddressCommandOutput extends GetSiteAddressOutput, __Met
2929

3030
/**
3131
* <p>
32-
* Gets the site address.
32+
* Gets the site address of the specified site.
3333
* </p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.

clients/client-outposts/src/commands/GetSiteCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface GetSiteCommandInput extends GetSiteInput {}
2828
export interface GetSiteCommandOutput extends GetSiteOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>
32-
* Gets information about the specified Outpost site.
33-
* </p>
31+
* <p>Gets information about the specified Outpost site.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript

clients/client-outposts/src/commands/ListAssetsCommand.ts

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,10 @@ export interface ListAssetsCommandInput extends ListAssetsInput {}
2828
export interface ListAssetsCommandOutput extends ListAssetsOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>
32-
* Lists the hardware assets in an Outpost. If you are using Dedicated Hosts on
33-
* Amazon Web Services Outposts, you can filter your request by host ID to return a list of hardware
34-
* assets that allocate resources for Dedicated Hosts.
35-
* </p>
31+
* <p>Lists the hardware assets for the specified Outpost.</p>
32+
* <p>Use filters to return specific results. If you specify multiple filters, the results include only the resources that match
33+
* all of the specified filters. For a filter where you can specify multiple values, the results include
34+
* items that match any of the values that you specify for the filter.</p>
3635
* @example
3736
* Use a bare-bones client and the command you need to make an API call.
3837
* ```javascript

clients/client-outposts/src/commands/ListCatalogItemsCommand.ts

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,10 @@ export interface ListCatalogItemsCommandInput extends ListCatalogItemsInput {}
2828
export interface ListCatalogItemsCommandOutput extends ListCatalogItemsOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Lists the items in the catalog. Add filters to your request to return a
32-
* more specific list of results. Use filters to match an item class, storage
33-
* option, or EC2 family. </p>
34-
* <p>If you specify multiple filters, the filters are joined with an <code>AND</code>, and
35-
* the request returns only results that match all of the specified filters.</p>
31+
* <p>Lists the items in the catalog.</p>
32+
* <p>Use filters to return specific results. If you specify multiple filters, the results include only the resources that match
33+
* all of the specified filters. For a filter where you can specify multiple values, the results include
34+
* items that match any of the values that you specify for the filter.</p>
3635
* @example
3736
* Use a bare-bones client and the command you need to make an API call.
3837
* ```javascript

clients/client-outposts/src/commands/ListOrdersCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface ListOrdersCommandInput extends ListOrdersInput {}
2828
export interface ListOrdersCommandOutput extends ListOrdersOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Lists the Outpost orders for your Amazon Web Services account. You can filter your request by Outpost to
32-
* return a more specific list of results. </p>
31+
* <p>Lists the Outpost orders for your Amazon Web Services account.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

clients/client-outposts/src/commands/ListOutpostsCommand.ts

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,10 @@ export interface ListOutpostsCommandInput extends ListOutpostsInput {}
2828
export interface ListOutpostsCommandOutput extends ListOutpostsOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Lists the Outposts for your Amazon Web Services account. Add filters to your request to return
32-
* a more specific list of results. Use filters to match an Outpost lifecycle status,
33-
* Availability Zone (<code>us-east-1a</code>), and AZ ID (<code>use1-az1</code>). </p>
34-
*
35-
* <p>If you specify multiple filters, the filters are joined with an <code>AND</code>, and the request returns only
36-
* results that match all of the specified filters.</p>
31+
* <p>Lists the Outposts for your Amazon Web Services account.</p>
32+
* <p>Use filters to return specific results. If you specify multiple filters, the results include only the resources that match
33+
* all of the specified filters. For a filter where you can specify multiple values, the results include
34+
* items that match any of the values that you specify for the filter.</p>
3735
* @example
3836
* Use a bare-bones client and the command you need to make an API call.
3937
* ```javascript

clients/client-outposts/src/commands/ListSitesCommand.ts

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,10 @@ export interface ListSitesCommandInput extends ListSitesInput {}
2828
export interface ListSitesCommandOutput extends ListSitesOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Lists the Outpost sites for your Amazon Web Services account. Add operating address filters to your request to
32-
* return a more specific list of results. Use filters to match site city, country code, or state/region of the
33-
* operating address. </p>
34-
*
35-
* <p>If you specify multiple filters, the filters are joined with an <code>AND</code>, and the request returns only
36-
* results that match all of the specified filters.</p>
31+
* <p>Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results.</p>
32+
* <p>Use filters to return specific results. If you specify multiple filters, the results include only the resources that match
33+
* all of the specified filters. For a filter where you can specify multiple values, the results include
34+
* items that match any of the values that you specify for the filter.</p>
3735
* @example
3836
* Use a bare-bones client and the command you need to make an API call.
3937
* ```javascript

clients/client-outposts/src/commands/UpdateSiteAddressCommand.ts

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,11 @@ export interface UpdateSiteAddressCommandInput extends UpdateSiteAddressInput {}
2828
export interface UpdateSiteAddressCommandOutput extends UpdateSiteAddressOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>
32-
* Updates the site address.
33-
* </p>
34-
* <p>
35-
* To update a site address
36-
* with an order <code>IN_PROGRESS</code>, you must wait for the order
37-
* to complete or cancel the order.
38-
* </p>
39-
* <p>You
40-
* can update the operating address before you place an order at the
41-
* site, or after all Outposts that belong to the site have been deactivated.
42-
* </p>
31+
* <p>Updates the address of the specified site.</p>
32+
* <p>You can't update a site address if there is an order in progress. You must wait for the order
33+
* to complete or cancel the order.</p>
34+
* <p>You can update the operating address before you place an order at the
35+
* site, or after all Outposts that belong to the site have been deactivated.</p>
4336
* @example
4437
* Use a bare-bones client and the command you need to make an API call.
4538
* ```javascript

clients/client-outposts/src/commands/UpdateSiteCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface UpdateSiteCommandInput extends UpdateSiteInput {}
2828
export interface UpdateSiteCommandOutput extends UpdateSiteOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>
32-
* Updates the site.
33-
* </p>
31+
* <p>Updates the specified site.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript

0 commit comments

Comments
 (0)