@aws-sdk/client-arc-zonal-shift 3.295.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.
@@ -7,6 +7,7 @@ import { ListZonalShiftsCommandInput, ListZonalShiftsCommandOutput } from "./com
7
7
  import { StartZonalShiftCommandInput, StartZonalShiftCommandOutput } from "./commands/StartZonalShiftCommand";
8
8
  import { UpdateZonalShiftCommandInput, UpdateZonalShiftCommandOutput } from "./commands/UpdateZonalShiftCommand";
9
9
  /**
10
+ * @public
10
11
  * <p>This is the API Reference Guide for the zonal shift feature of Amazon Route 53 Application Recovery Controller. This guide is for developers who need detailed information about
11
12
  * zonal shift API actions, data types, and errors.</p>
12
13
  * <p>Zonal shift is in preview release for Amazon Route 53 Application Recovery Controller and is subject to change.</p>
@@ -25,12 +26,14 @@ import { UpdateZonalShiftCommandInput, UpdateZonalShiftCommandOutput } from "./c
25
26
  */
26
27
  export declare class ARCZonalShift extends ARCZonalShiftClient {
27
28
  /**
29
+ * @public
28
30
  * <p>Cancel a zonal shift in Amazon Route 53 Application Recovery Controller that you've started for a resource in your AWS account in an AWS Region. </p>
29
31
  */
30
32
  cancelZonalShift(args: CancelZonalShiftCommandInput, options?: __HttpHandlerOptions): Promise<CancelZonalShiftCommandOutput>;
31
33
  cancelZonalShift(args: CancelZonalShiftCommandInput, cb: (err: any, data?: CancelZonalShiftCommandOutput) => void): void;
32
34
  cancelZonalShift(args: CancelZonalShiftCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelZonalShiftCommandOutput) => void): void;
33
35
  /**
36
+ * @public
34
37
  * <p>Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this AWS Region. Resources that are registered for
35
38
  * zonal shifts are managed resources in Route 53 ARC.</p>
36
39
  * <p>At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
@@ -39,6 +42,7 @@ export declare class ARCZonalShift extends ARCZonalShiftClient {
39
42
  getManagedResource(args: GetManagedResourceCommandInput, cb: (err: any, data?: GetManagedResourceCommandOutput) => void): void;
40
43
  getManagedResource(args: GetManagedResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetManagedResourceCommandOutput) => void): void;
41
44
  /**
45
+ * @public
42
46
  * <p>Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information
43
47
  * about them. The information includes their Amazon Resource Names (ARNs), the Availability Zones the resources are deployed in, and
44
48
  * the resource name.</p>
@@ -47,12 +51,14 @@ export declare class ARCZonalShift extends ARCZonalShiftClient {
47
51
  listManagedResources(args: ListManagedResourcesCommandInput, cb: (err: any, data?: ListManagedResourcesCommandOutput) => void): void;
48
52
  listManagedResources(args: ListManagedResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListManagedResourcesCommandOutput) => void): void;
49
53
  /**
54
+ * @public
50
55
  * <p>Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.</p>
51
56
  */
52
57
  listZonalShifts(args: ListZonalShiftsCommandInput, options?: __HttpHandlerOptions): Promise<ListZonalShiftsCommandOutput>;
53
58
  listZonalShifts(args: ListZonalShiftsCommandInput, cb: (err: any, data?: ListZonalShiftsCommandOutput) => void): void;
54
59
  listZonalShifts(args: ListZonalShiftsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListZonalShiftsCommandOutput) => void): void;
55
60
  /**
61
+ * @public
56
62
  * <p>You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region,
57
63
  * to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS
58
64
  * infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed
@@ -68,6 +74,7 @@ export declare class ARCZonalShift extends ARCZonalShiftClient {
68
74
  startZonalShift(args: StartZonalShiftCommandInput, cb: (err: any, data?: StartZonalShiftCommandOutput) => void): void;
69
75
  startZonalShift(args: StartZonalShiftCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartZonalShiftCommandOutput) => void): void;
70
76
  /**
77
+ * @public
71
78
  * <p>Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS account. You can update a zonal shift to set a new expiration, or
72
79
  * edit or replace the comment for the zonal shift. </p>
73
80
  */
@@ -14,15 +14,24 @@ import { ListZonalShiftsCommandInput, ListZonalShiftsCommandOutput } from "./com
14
14
  import { StartZonalShiftCommandInput, StartZonalShiftCommandOutput } from "./commands/StartZonalShiftCommand";
15
15
  import { UpdateZonalShiftCommandInput, UpdateZonalShiftCommandOutput } from "./commands/UpdateZonalShiftCommand";
16
16
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
17
+ /**
18
+ * @public
19
+ */
17
20
  export type ServiceInputTypes = CancelZonalShiftCommandInput | GetManagedResourceCommandInput | ListManagedResourcesCommandInput | ListZonalShiftsCommandInput | StartZonalShiftCommandInput | UpdateZonalShiftCommandInput;
21
+ /**
22
+ * @public
23
+ */
18
24
  export type ServiceOutputTypes = CancelZonalShiftCommandOutput | GetManagedResourceCommandOutput | ListManagedResourcesCommandOutput | ListZonalShiftsCommandOutput | StartZonalShiftCommandOutput | UpdateZonalShiftCommandOutput;
25
+ /**
26
+ * @public
27
+ */
19
28
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
20
29
  /**
21
30
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
22
31
  */
23
32
  requestHandler?: __HttpHandler;
24
33
  /**
25
- * A constructor for a class implementing the {@link __Checksum} interface
34
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
26
35
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
27
36
  * @internal
28
37
  */
@@ -112,23 +121,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
112
121
  */
113
122
  logger?: __Logger;
114
123
  /**
115
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
124
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
116
125
  */
117
126
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
118
127
  }
128
+ /**
129
+ * @public
130
+ */
119
131
  type ARCZonalShiftClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
120
132
  /**
121
- * The configuration interface of ARCZonalShiftClient class constructor that set the region, credentials and other options.
133
+ * @public
134
+ *
135
+ * The configuration interface of ARCZonalShiftClient class constructor that set the region, credentials and other options.
122
136
  */
123
137
  export interface ARCZonalShiftClientConfig extends ARCZonalShiftClientConfigType {
124
138
  }
139
+ /**
140
+ * @public
141
+ */
125
142
  type ARCZonalShiftClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
126
143
  /**
127
- * The resolved configuration interface of ARCZonalShiftClient class. This is resolved and normalized from the {@link ARCZonalShiftClientConfig | constructor configuration interface}.
144
+ * @public
145
+ *
146
+ * The resolved configuration interface of ARCZonalShiftClient class. This is resolved and normalized from the {@link ARCZonalShiftClientConfig | constructor configuration interface}.
128
147
  */
129
148
  export interface ARCZonalShiftClientResolvedConfig extends ARCZonalShiftClientResolvedConfigType {
130
149
  }
131
150
  /**
151
+ * @public
132
152
  * <p>This is the API Reference Guide for the zonal shift feature of Amazon Route 53 Application Recovery Controller. This guide is for developers who need detailed information about
133
153
  * zonal shift API actions, data types, and errors.</p>
134
154
  * <p>Zonal shift is in preview release for Amazon Route 53 Application Recovery Controller and is subject to change.</p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
5
5
  import { CancelZonalShiftRequest, ZonalShift } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CancelZonalShiftCommand}.
8
10
  */
9
11
  export interface CancelZonalShiftCommandInput extends CancelZonalShiftRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CancelZonalShiftCommand}.
13
17
  */
14
18
  export interface CancelZonalShiftCommandOutput extends ZonalShift, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Cancel a zonal shift in Amazon Route 53 Application Recovery Controller that you've started for a resource in your AWS account in an AWS Region. </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 CancelZonalShiftCommandOutput extends ZonalShift, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CancelZonalShiftCommandInput - {@link CancelZonalShiftCommandInput}
34
+ * @returns {@link CancelZonalShiftCommandOutput}
28
35
  * @see {@link CancelZonalShiftCommandInput} for command's `input` shape.
29
36
  * @see {@link CancelZonalShiftCommandOutput} for command's `response` shape.
30
37
  * @see {@link ARCZonalShiftClientResolvedConfig | config} for ARCZonalShiftClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CancelZonalShiftCommandOutput extends ZonalShift, __MetadataBea
52
59
  export declare class CancelZonalShiftCommand extends $Command<CancelZonalShiftCommandInput, CancelZonalShiftCommandOutput, ARCZonalShiftClientResolvedConfig> {
53
60
  readonly input: CancelZonalShiftCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: CancelZonalShiftCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ARCZonalShiftClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelZonalShiftCommandInput, CancelZonalShiftCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
5
5
  import { GetManagedResourceRequest, GetManagedResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetManagedResourceCommand}.
8
10
  */
9
11
  export interface GetManagedResourceCommandInput extends GetManagedResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetManagedResourceCommand}.
13
17
  */
14
18
  export interface GetManagedResourceCommandOutput extends GetManagedResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this AWS Region. Resources that are registered for
18
23
  * zonal shifts are managed resources in Route 53 ARC.</p>
19
24
  * <p>At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
@@ -27,6 +32,8 @@ export interface GetManagedResourceCommandOutput extends GetManagedResourceRespo
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetManagedResourceCommandInput - {@link GetManagedResourceCommandInput}
36
+ * @returns {@link GetManagedResourceCommandOutput}
30
37
  * @see {@link GetManagedResourceCommandInput} for command's `input` shape.
31
38
  * @see {@link GetManagedResourceCommandOutput} for command's `response` shape.
32
39
  * @see {@link ARCZonalShiftClientResolvedConfig | config} for ARCZonalShiftClient's `config` shape.
@@ -51,11 +58,20 @@ export interface GetManagedResourceCommandOutput extends GetManagedResourceRespo
51
58
  export declare class GetManagedResourceCommand extends $Command<GetManagedResourceCommandInput, GetManagedResourceCommandOutput, ARCZonalShiftClientResolvedConfig> {
52
59
  readonly input: GetManagedResourceCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: GetManagedResourceCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ARCZonalShiftClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetManagedResourceCommandInput, GetManagedResourceCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
5
5
  import { ListManagedResourcesRequest, ListManagedResourcesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListManagedResourcesCommand}.
8
10
  */
9
11
  export interface ListManagedResourcesCommandInput extends ListManagedResourcesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListManagedResourcesCommand}.
13
17
  */
14
18
  export interface ListManagedResourcesCommandOutput extends ListManagedResourcesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information
18
23
  * about them. The information includes their Amazon Resource Names (ARNs), the Availability Zones the resources are deployed in, and
19
24
  * the resource name.</p>
@@ -27,6 +32,8 @@ export interface ListManagedResourcesCommandOutput extends ListManagedResourcesR
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListManagedResourcesCommandInput - {@link ListManagedResourcesCommandInput}
36
+ * @returns {@link ListManagedResourcesCommandOutput}
30
37
  * @see {@link ListManagedResourcesCommandInput} for command's `input` shape.
31
38
  * @see {@link ListManagedResourcesCommandOutput} for command's `response` shape.
32
39
  * @see {@link ARCZonalShiftClientResolvedConfig | config} for ARCZonalShiftClient's `config` shape.
@@ -48,11 +55,20 @@ export interface ListManagedResourcesCommandOutput extends ListManagedResourcesR
48
55
  export declare class ListManagedResourcesCommand extends $Command<ListManagedResourcesCommandInput, ListManagedResourcesCommandOutput, ARCZonalShiftClientResolvedConfig> {
49
56
  readonly input: ListManagedResourcesCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: ListManagedResourcesCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ARCZonalShiftClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListManagedResourcesCommandInput, ListManagedResourcesCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
5
5
  import { ListZonalShiftsRequest, ListZonalShiftsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListZonalShiftsCommand}.
8
10
  */
9
11
  export interface ListZonalShiftsCommandInput extends ListZonalShiftsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListZonalShiftsCommand}.
13
17
  */
14
18
  export interface ListZonalShiftsCommandOutput extends ListZonalShiftsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.</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 ListZonalShiftsCommandOutput extends ListZonalShiftsResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListZonalShiftsCommandInput - {@link ListZonalShiftsCommandInput}
34
+ * @returns {@link ListZonalShiftsCommandOutput}
28
35
  * @see {@link ListZonalShiftsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListZonalShiftsCommandOutput} for command's `response` shape.
30
37
  * @see {@link ARCZonalShiftClientResolvedConfig | config} for ARCZonalShiftClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListZonalShiftsCommandOutput extends ListZonalShiftsResponse, _
46
53
  export declare class ListZonalShiftsCommand extends $Command<ListZonalShiftsCommandInput, ListZonalShiftsCommandOutput, ARCZonalShiftClientResolvedConfig> {
47
54
  readonly input: ListZonalShiftsCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListZonalShiftsCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ARCZonalShiftClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListZonalShiftsCommandInput, ListZonalShiftsCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
5
5
  import { StartZonalShiftRequest, ZonalShift } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartZonalShiftCommand}.
8
10
  */
9
11
  export interface StartZonalShiftCommandInput extends StartZonalShiftRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartZonalShiftCommand}.
13
17
  */
14
18
  export interface StartZonalShiftCommandOutput extends ZonalShift, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region,
18
23
  * to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS
19
24
  * infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed
@@ -34,6 +39,8 @@ export interface StartZonalShiftCommandOutput extends ZonalShift, __MetadataBear
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param StartZonalShiftCommandInput - {@link StartZonalShiftCommandInput}
43
+ * @returns {@link StartZonalShiftCommandOutput}
37
44
  * @see {@link StartZonalShiftCommandInput} for command's `input` shape.
38
45
  * @see {@link StartZonalShiftCommandOutput} for command's `response` shape.
39
46
  * @see {@link ARCZonalShiftClientResolvedConfig | config} for ARCZonalShiftClient's `config` shape.
@@ -61,11 +68,20 @@ export interface StartZonalShiftCommandOutput extends ZonalShift, __MetadataBear
61
68
  export declare class StartZonalShiftCommand extends $Command<StartZonalShiftCommandInput, StartZonalShiftCommandOutput, ARCZonalShiftClientResolvedConfig> {
62
69
  readonly input: StartZonalShiftCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: StartZonalShiftCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ARCZonalShiftClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartZonalShiftCommandInput, StartZonalShiftCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
5
5
  import { UpdateZonalShiftRequest, ZonalShift } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateZonalShiftCommand}.
8
10
  */
9
11
  export interface UpdateZonalShiftCommandInput extends UpdateZonalShiftRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateZonalShiftCommand}.
13
17
  */
14
18
  export interface UpdateZonalShiftCommandOutput extends ZonalShift, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS account. You can update a zonal shift to set a new expiration, or
18
23
  * edit or replace the comment for the zonal shift. </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UpdateZonalShiftCommandOutput extends ZonalShift, __MetadataBea
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UpdateZonalShiftCommandInput - {@link UpdateZonalShiftCommandInput}
35
+ * @returns {@link UpdateZonalShiftCommandOutput}
29
36
  * @see {@link UpdateZonalShiftCommandInput} for command's `input` shape.
30
37
  * @see {@link UpdateZonalShiftCommandOutput} for command's `response` shape.
31
38
  * @see {@link ARCZonalShiftClientResolvedConfig | config} for ARCZonalShiftClient's `config` shape.
@@ -53,11 +60,20 @@ export interface UpdateZonalShiftCommandOutput extends ZonalShift, __MetadataBea
53
60
  export declare class UpdateZonalShiftCommand extends $Command<UpdateZonalShiftCommandInput, UpdateZonalShiftCommandOutput, ARCZonalShiftClientResolvedConfig> {
54
61
  readonly input: UpdateZonalShiftCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: UpdateZonalShiftCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ARCZonalShiftClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateZonalShiftCommandInput, UpdateZonalShiftCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -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 ARCZonalShift service.
4
6
  */
5
7
  export declare class ARCZonalShiftServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { ARCZonalShiftServiceException as __BaseException } from "./ARCZonalShiftServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>You do not have sufficient access to perform this action.</p>
5
6
  */
6
7
  export declare class AccessDeniedException extends __BaseException {
@@ -11,22 +12,32 @@ export declare class AccessDeniedException extends __BaseException {
11
12
  */
12
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
13
14
  }
15
+ /**
16
+ * @public
17
+ */
14
18
  export declare enum AppliedStatus {
15
19
  APPLIED = "APPLIED",
16
20
  NOT_APPLIED = "NOT_APPLIED"
17
21
  }
22
+ /**
23
+ * @public
24
+ */
18
25
  export interface CancelZonalShiftRequest {
19
26
  /**
20
27
  * <p>The internally-generated identifier of a zonal shift.</p>
21
28
  */
22
29
  zonalShiftId: string | undefined;
23
30
  }
31
+ /**
32
+ * @public
33
+ */
24
34
  export declare enum ConflictExceptionReason {
25
35
  SIMULTANEOUS_ZONAL_SHIFTS_CONFLICT = "SimultaneousZonalShiftsConflict",
26
36
  ZONAL_SHIFT_ALREADY_EXISTS = "ZonalShiftAlreadyExists",
27
37
  ZONAL_SHIFT_STATUS_NOT_ACTIVE = "ZonalShiftStatusNotActive"
28
38
  }
29
39
  /**
40
+ * @public
30
41
  * <p>The request could not be processed because of conflict in the current state of the resource.</p>
31
42
  */
32
43
  export declare class ConflictException extends __BaseException {
@@ -46,6 +57,7 @@ export declare class ConflictException extends __BaseException {
46
57
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
47
58
  }
48
59
  /**
60
+ * @public
49
61
  * <p>There was an internal server error.</p>
50
62
  */
51
63
  export declare class InternalServerException extends __BaseException {
@@ -57,6 +69,7 @@ export declare class InternalServerException extends __BaseException {
57
69
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
58
70
  }
59
71
  /**
72
+ * @public
60
73
  * <p>The input requested a resource that was not found.</p>
61
74
  */
62
75
  export declare class ResourceNotFoundException extends __BaseException {
@@ -68,6 +81,7 @@ export declare class ResourceNotFoundException extends __BaseException {
68
81
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
69
82
  }
70
83
  /**
84
+ * @public
71
85
  * <p>The request was denied due to request throttling.</p>
72
86
  */
73
87
  export declare class ThrottlingException extends __BaseException {
@@ -78,6 +92,9 @@ export declare class ThrottlingException extends __BaseException {
78
92
  */
79
93
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
80
94
  }
95
+ /**
96
+ * @public
97
+ */
81
98
  export declare enum ValidationExceptionReason {
82
99
  INVALID_AZ = "InvalidAz",
83
100
  INVALID_EXPIRES_IN = "InvalidExpiresIn",
@@ -88,6 +105,7 @@ export declare enum ValidationExceptionReason {
88
105
  UNSUPPORTED_AZ = "UnsupportedAz"
89
106
  }
90
107
  /**
108
+ * @public
91
109
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
92
110
  */
93
111
  export declare class ValidationException extends __BaseException {
@@ -102,11 +120,17 @@ export declare class ValidationException extends __BaseException {
102
120
  */
103
121
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
104
122
  }
123
+ /**
124
+ * @public
125
+ */
105
126
  export declare enum ZonalShiftStatus {
106
127
  ACTIVE = "ACTIVE",
107
128
  CANCELED = "CANCELED",
108
129
  EXPIRED = "EXPIRED"
109
130
  }
131
+ /**
132
+ * @public
133
+ */
110
134
  export interface ZonalShift {
111
135
  /**
112
136
  * <p>The identifier of a zonal shift.</p>
@@ -160,6 +184,9 @@ export interface ZonalShift {
160
184
  */
161
185
  comment: string | undefined;
162
186
  }
187
+ /**
188
+ * @public
189
+ */
163
190
  export interface GetManagedResourceRequest {
164
191
  /**
165
192
  * <p>The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
@@ -168,6 +195,7 @@ export interface GetManagedResourceRequest {
168
195
  resourceIdentifier: string | undefined;
169
196
  }
170
197
  /**
198
+ * @public
171
199
  * <p>A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.</p>
172
200
  */
173
201
  export interface ZonalShiftInResource {
@@ -209,6 +237,9 @@ export interface ZonalShiftInResource {
209
237
  */
210
238
  comment: string | undefined;
211
239
  }
240
+ /**
241
+ * @public
242
+ */
212
243
  export interface GetManagedResourceResponse {
213
244
  /**
214
245
  * <p>The Amazon Resource Name (ARN) for the resource.</p>
@@ -228,6 +259,9 @@ export interface GetManagedResourceResponse {
228
259
  */
229
260
  zonalShifts: ZonalShiftInResource[] | undefined;
230
261
  }
262
+ /**
263
+ * @public
264
+ */
231
265
  export interface ListManagedResourcesRequest {
232
266
  /**
233
267
  * <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the
@@ -241,6 +275,7 @@ export interface ListManagedResourcesRequest {
241
275
  maxResults?: number;
242
276
  }
243
277
  /**
278
+ * @public
244
279
  * <p>A complex structure for a managed resource in an account.</p>
245
280
  * <p>A managed resource is a Network Load Balancer or Application Load Balancer that has been registered with Route 53 ARC by Elastic Load Balancing. You can start a
246
281
  * zonal shift in Route 53 ARC for a managed resource to temporarily move traffic for the resource away from an Availability Zone in an AWS Region.</p>
@@ -262,6 +297,9 @@ export interface ManagedResourceSummary {
262
297
  */
263
298
  availabilityZones: string[] | undefined;
264
299
  }
300
+ /**
301
+ * @public
302
+ */
265
303
  export interface ListManagedResourcesResponse {
266
304
  /**
267
305
  * <p>The items in the response list.</p>
@@ -274,6 +312,9 @@ export interface ListManagedResourcesResponse {
274
312
  */
275
313
  nextToken?: string;
276
314
  }
315
+ /**
316
+ * @public
317
+ */
277
318
  export interface ListZonalShiftsRequest {
278
319
  /**
279
320
  * <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the
@@ -306,6 +347,7 @@ export interface ListZonalShiftsRequest {
306
347
  maxResults?: number;
307
348
  }
308
349
  /**
350
+ * @public
309
351
  * <p>You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region.
310
352
  * A zonal shift helps your application recover immediately, for example, from a developer's bad code deployment or from an AWS
311
353
  * infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed
@@ -368,6 +410,9 @@ export interface ZonalShiftSummary {
368
410
  */
369
411
  comment: string | undefined;
370
412
  }
413
+ /**
414
+ * @public
415
+ */
371
416
  export interface ListZonalShiftsResponse {
372
417
  /**
373
418
  * <p>The items in the response list.</p>
@@ -380,6 +425,9 @@ export interface ListZonalShiftsResponse {
380
425
  */
381
426
  nextToken?: string;
382
427
  }
428
+ /**
429
+ * @public
430
+ */
383
431
  export interface UpdateZonalShiftRequest {
384
432
  /**
385
433
  * <p>The identifier of a zonal shift.</p>
@@ -411,6 +459,9 @@ export interface UpdateZonalShiftRequest {
411
459
  */
412
460
  expiresIn?: string;
413
461
  }
462
+ /**
463
+ * @public
464
+ */
414
465
  export interface StartZonalShiftRequest {
415
466
  /**
416
467
  * <p>The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
@@ -1,5 +1,8 @@
1
1
  import { PaginationConfiguration } from "@aws-sdk/types";
2
2
  import { ARCZonalShiftClient } from "../ARCZonalShiftClient";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface ARCZonalShiftPaginationConfiguration extends PaginationConfiguration {
4
7
  client: ARCZonalShiftClient;
5
8
  }
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListManagedResourcesCommandInput, ListManagedResourcesCommandOutput } from "../commands/ListManagedResourcesCommand";
3
3
  import { ARCZonalShiftPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListManagedResources(config: ARCZonalShiftPaginationConfiguration, input: ListManagedResourcesCommandInput, ...additionalArguments: any): Paginator<ListManagedResourcesCommandOutput>;
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListZonalShiftsCommandInput, ListZonalShiftsCommandOutput } from "../commands/ListZonalShiftsCommand";
3
3
  import { ARCZonalShiftPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListZonalShifts(config: ARCZonalShiftPaginationConfiguration, input: ListZonalShiftsCommandInput, ...additionalArguments: any): Paginator<ListZonalShiftsCommandOutput>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-arc-zonal-shift",
3
3
  "description": "AWS SDK for JavaScript Arc Zonal Shift Client for Node.js, Browser and React Native",
4
- "version": "3.295.0",
4
+ "version": "3.297.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.295.0",
24
- "@aws-sdk/config-resolver": "3.295.0",
25
- "@aws-sdk/credential-provider-node": "3.295.0",
26
- "@aws-sdk/fetch-http-handler": "3.295.0",
27
- "@aws-sdk/hash-node": "3.295.0",
28
- "@aws-sdk/invalid-dependency": "3.295.0",
29
- "@aws-sdk/middleware-content-length": "3.295.0",
30
- "@aws-sdk/middleware-endpoint": "3.295.0",
31
- "@aws-sdk/middleware-host-header": "3.295.0",
32
- "@aws-sdk/middleware-logger": "3.295.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.295.0",
34
- "@aws-sdk/middleware-retry": "3.295.0",
35
- "@aws-sdk/middleware-serde": "3.295.0",
36
- "@aws-sdk/middleware-signing": "3.295.0",
37
- "@aws-sdk/middleware-stack": "3.295.0",
38
- "@aws-sdk/middleware-user-agent": "3.295.0",
39
- "@aws-sdk/node-config-provider": "3.295.0",
40
- "@aws-sdk/node-http-handler": "3.295.0",
41
- "@aws-sdk/protocol-http": "3.295.0",
42
- "@aws-sdk/smithy-client": "3.295.0",
43
- "@aws-sdk/types": "3.295.0",
44
- "@aws-sdk/url-parser": "3.295.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
+ "@aws-sdk/config-resolver": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
+ "@aws-sdk/fetch-http-handler": "3.296.0",
27
+ "@aws-sdk/hash-node": "3.296.0",
28
+ "@aws-sdk/invalid-dependency": "3.296.0",
29
+ "@aws-sdk/middleware-content-length": "3.296.0",
30
+ "@aws-sdk/middleware-endpoint": "3.296.0",
31
+ "@aws-sdk/middleware-host-header": "3.296.0",
32
+ "@aws-sdk/middleware-logger": "3.296.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.296.0",
34
+ "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-serde": "3.296.0",
36
+ "@aws-sdk/middleware-signing": "3.296.0",
37
+ "@aws-sdk/middleware-stack": "3.296.0",
38
+ "@aws-sdk/middleware-user-agent": "3.296.0",
39
+ "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-http-handler": "3.296.0",
41
+ "@aws-sdk/protocol-http": "3.296.0",
42
+ "@aws-sdk/smithy-client": "3.296.0",
43
+ "@aws-sdk/types": "3.296.0",
44
+ "@aws-sdk/url-parser": "3.296.0",
45
45
  "@aws-sdk/util-base64": "3.295.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.295.0",
47
47
  "@aws-sdk/util-body-length-node": "3.295.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.295.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.295.0",
50
- "@aws-sdk/util-endpoints": "3.295.0",
51
- "@aws-sdk/util-retry": "3.295.0",
52
- "@aws-sdk/util-user-agent-browser": "3.295.0",
53
- "@aws-sdk/util-user-agent-node": "3.295.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.296.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.296.0",
50
+ "@aws-sdk/util-endpoints": "3.296.0",
51
+ "@aws-sdk/util-retry": "3.296.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.296.0",
53
+ "@aws-sdk/util-user-agent-node": "3.296.0",
54
54
  "@aws-sdk/util-utf8": "3.295.0",
55
55
  "tslib": "^2.5.0"
56
56
  },