@aws-sdk/client-outposts 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/dist-types/Outposts.d.ts +27 -0
  2. package/dist-types/OutpostsClient.d.ts +24 -4
  3. package/dist-types/commands/CancelOrderCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateOrderCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateOutpostCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateSiteCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteOutpostCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteSiteCommand.d.ts +16 -0
  9. package/dist-types/commands/GetCatalogItemCommand.d.ts +16 -0
  10. package/dist-types/commands/GetConnectionCommand.d.ts +16 -0
  11. package/dist-types/commands/GetOrderCommand.d.ts +16 -0
  12. package/dist-types/commands/GetOutpostCommand.d.ts +16 -0
  13. package/dist-types/commands/GetOutpostInstanceTypesCommand.d.ts +16 -0
  14. package/dist-types/commands/GetSiteAddressCommand.d.ts +16 -0
  15. package/dist-types/commands/GetSiteCommand.d.ts +16 -0
  16. package/dist-types/commands/ListAssetsCommand.d.ts +16 -0
  17. package/dist-types/commands/ListCatalogItemsCommand.d.ts +16 -0
  18. package/dist-types/commands/ListOrdersCommand.d.ts +16 -0
  19. package/dist-types/commands/ListOutpostsCommand.d.ts +16 -0
  20. package/dist-types/commands/ListSitesCommand.d.ts +16 -0
  21. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  22. package/dist-types/commands/StartConnectionCommand.d.ts +16 -0
  23. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  24. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  25. package/dist-types/commands/UpdateOutpostCommand.d.ts +16 -0
  26. package/dist-types/commands/UpdateSiteAddressCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdateSiteCommand.d.ts +16 -0
  28. package/dist-types/commands/UpdateSiteRackPhysicalPropertiesCommand.d.ts +16 -0
  29. package/dist-types/models/OutpostsServiceException.d.ts +2 -0
  30. package/dist-types/models/models_0.d.ts +251 -0
  31. package/dist-types/pagination/GetOutpostInstanceTypesPaginator.d.ts +3 -0
  32. package/dist-types/pagination/Interfaces.d.ts +3 -0
  33. package/dist-types/pagination/ListAssetsPaginator.d.ts +3 -0
  34. package/dist-types/pagination/ListCatalogItemsPaginator.d.ts +3 -0
  35. package/dist-types/pagination/ListOrdersPaginator.d.ts +3 -0
  36. package/dist-types/pagination/ListOutpostsPaginator.d.ts +3 -0
  37. package/dist-types/pagination/ListSitesPaginator.d.ts +3 -0
  38. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
5
5
  import { OutpostsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OutpostsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds tags to the specified resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
34
+ * @returns {@link TagResourceCommandOutput}
28
35
  * @see {@link TagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link OutpostsClientResolvedConfig | config} for OutpostsClient's `config` shape.
@@ -43,11 +50,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
43
50
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, OutpostsClientResolvedConfig> {
44
51
  readonly input: TagResourceCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: TagResourceCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OutpostsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
5
5
  import { OutpostsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OutpostsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes tags from the specified resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link OutpostsClientResolvedConfig | config} for OutpostsClient's `config` shape.
@@ -43,11 +50,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
43
50
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, OutpostsClientResolvedConfig> {
44
51
  readonly input: UntagResourceCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: UntagResourceCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OutpostsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateOutpostInput, UpdateOutpostOutput } from "../models/models_0";
5
5
  import { OutpostsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OutpostsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateOutpostCommand}.
8
10
  */
9
11
  export interface UpdateOutpostCommandInput extends UpdateOutpostInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateOutpostCommand}.
13
17
  */
14
18
  export interface UpdateOutpostCommandOutput extends UpdateOutpostOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Updates an Outpost. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateOutpostCommandOutput extends UpdateOutpostOutput, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateOutpostCommandInput - {@link UpdateOutpostCommandInput}
34
+ * @returns {@link UpdateOutpostCommandOutput}
28
35
  * @see {@link UpdateOutpostCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateOutpostCommandOutput} for command's `response` shape.
30
37
  * @see {@link OutpostsClientResolvedConfig | config} for OutpostsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UpdateOutpostCommandOutput extends UpdateOutpostOutput, __Metad
49
56
  export declare class UpdateOutpostCommand extends $Command<UpdateOutpostCommandInput, UpdateOutpostCommandOutput, OutpostsClientResolvedConfig> {
50
57
  readonly input: UpdateOutpostCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: UpdateOutpostCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OutpostsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateOutpostCommandInput, UpdateOutpostCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateSiteAddressInput, UpdateSiteAddressOutput } from "../models/models_0";
5
5
  import { OutpostsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OutpostsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateSiteAddressCommand}.
8
10
  */
9
11
  export interface UpdateSiteAddressCommandInput extends UpdateSiteAddressInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateSiteAddressCommand}.
13
17
  */
14
18
  export interface UpdateSiteAddressCommandOutput extends UpdateSiteAddressOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the address of the specified site.</p>
18
23
  * <p>You can't update a site address if there is an order in progress. You must wait for the
19
24
  * order to complete or cancel the order.</p>
@@ -29,6 +34,8 @@ export interface UpdateSiteAddressCommandOutput extends UpdateSiteAddressOutput,
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param UpdateSiteAddressCommandInput - {@link UpdateSiteAddressCommandInput}
38
+ * @returns {@link UpdateSiteAddressCommandOutput}
32
39
  * @see {@link UpdateSiteAddressCommandInput} for command's `input` shape.
33
40
  * @see {@link UpdateSiteAddressCommandOutput} for command's `response` shape.
34
41
  * @see {@link OutpostsClientResolvedConfig | config} for OutpostsClient's `config` shape.
@@ -53,11 +60,20 @@ export interface UpdateSiteAddressCommandOutput extends UpdateSiteAddressOutput,
53
60
  export declare class UpdateSiteAddressCommand extends $Command<UpdateSiteAddressCommandInput, UpdateSiteAddressCommandOutput, OutpostsClientResolvedConfig> {
54
61
  readonly input: UpdateSiteAddressCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: UpdateSiteAddressCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OutpostsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateSiteAddressCommandInput, UpdateSiteAddressCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateSiteInput, UpdateSiteOutput } from "../models/models_0";
5
5
  import { OutpostsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OutpostsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateSiteCommand}.
8
10
  */
9
11
  export interface UpdateSiteCommandInput extends UpdateSiteInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateSiteCommand}.
13
17
  */
14
18
  export interface UpdateSiteCommandOutput extends UpdateSiteOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the specified site.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateSiteCommandOutput extends UpdateSiteOutput, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateSiteCommandInput - {@link UpdateSiteCommandInput}
34
+ * @returns {@link UpdateSiteCommandOutput}
28
35
  * @see {@link UpdateSiteCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateSiteCommandOutput} for command's `response` shape.
30
37
  * @see {@link OutpostsClientResolvedConfig | config} for OutpostsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UpdateSiteCommandOutput extends UpdateSiteOutput, __MetadataBea
49
56
  export declare class UpdateSiteCommand extends $Command<UpdateSiteCommandInput, UpdateSiteCommandOutput, OutpostsClientResolvedConfig> {
50
57
  readonly input: UpdateSiteCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: UpdateSiteCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OutpostsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateSiteCommandInput, UpdateSiteCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateSiteRackPhysicalPropertiesInput, UpdateSiteRackPhysicalPropertiesOutput } from "../models/models_0";
5
5
  import { OutpostsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OutpostsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateSiteRackPhysicalPropertiesCommand}.
8
10
  */
9
11
  export interface UpdateSiteRackPhysicalPropertiesCommandInput extends UpdateSiteRackPhysicalPropertiesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateSiteRackPhysicalPropertiesCommand}.
13
17
  */
14
18
  export interface UpdateSiteRackPhysicalPropertiesCommandOutput extends UpdateSiteRackPhysicalPropertiesOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Update the physical and logistical details for a rack at a site. For more information
18
23
  * about hardware requirements for racks, see <a href="https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist">Network
19
24
  * readiness checklist</a> in the Amazon Web Services Outposts User Guide.
@@ -30,6 +35,8 @@ export interface UpdateSiteRackPhysicalPropertiesCommandOutput extends UpdateSit
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param UpdateSiteRackPhysicalPropertiesCommandInput - {@link UpdateSiteRackPhysicalPropertiesCommandInput}
39
+ * @returns {@link UpdateSiteRackPhysicalPropertiesCommandOutput}
33
40
  * @see {@link UpdateSiteRackPhysicalPropertiesCommandInput} for command's `input` shape.
34
41
  * @see {@link UpdateSiteRackPhysicalPropertiesCommandOutput} for command's `response` shape.
35
42
  * @see {@link OutpostsClientResolvedConfig | config} for OutpostsClient's `config` shape.
@@ -54,11 +61,20 @@ export interface UpdateSiteRackPhysicalPropertiesCommandOutput extends UpdateSit
54
61
  export declare class UpdateSiteRackPhysicalPropertiesCommand extends $Command<UpdateSiteRackPhysicalPropertiesCommandInput, UpdateSiteRackPhysicalPropertiesCommandOutput, OutpostsClientResolvedConfig> {
55
62
  readonly input: UpdateSiteRackPhysicalPropertiesCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: UpdateSiteRackPhysicalPropertiesCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OutpostsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateSiteRackPhysicalPropertiesCommandInput, UpdateSiteRackPhysicalPropertiesCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from Outposts service.
4
6
  */
5
7
  export declare class OutpostsServiceException extends __ServiceException {