-
Notifications
You must be signed in to change notification settings - Fork 546
/
GetMultiRegionAccessPointRoutesCommand.ts
133 lines (130 loc) · 5.03 KB
/
GetMultiRegionAccessPointRoutesCommand.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
// smithy-typescript generated code
import { getProcessArnablesPlugin } from "@aws-sdk/middleware-sdk-s3-control";
import { getApplyMd5BodyChecksumPlugin } from "@smithy/middleware-apply-body-checksum";
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
import { getSerdePlugin } from "@smithy/middleware-serde";
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { commonParams } from "../endpoint/EndpointParameters";
import { GetMultiRegionAccessPointRoutesRequest, GetMultiRegionAccessPointRoutesResult } from "../models/models_0";
import {
de_GetMultiRegionAccessPointRoutesCommand,
se_GetMultiRegionAccessPointRoutesCommand,
} from "../protocols/Aws_restXml";
import { S3ControlClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3ControlClient";
/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
* The input for {@link GetMultiRegionAccessPointRoutesCommand}.
*/
export interface GetMultiRegionAccessPointRoutesCommandInput extends GetMultiRegionAccessPointRoutesRequest {}
/**
* @public
*
* The output of {@link GetMultiRegionAccessPointRoutesCommand}.
*/
export interface GetMultiRegionAccessPointRoutesCommandOutput
extends GetMultiRegionAccessPointRoutesResult,
__MetadataBearer {}
/**
* <note>
* <p>This operation is not supported by directory buckets.</p>
* </note>
* <p>Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or
* passive.</p>
* <p>To obtain routing control changes and failover requests, use the Amazon S3 failover control
* infrastructure endpoints in these five Amazon Web Services Regions:</p>
* <ul>
* <li>
* <p>
* <code>us-east-1</code>
* </p>
* </li>
* <li>
* <p>
* <code>us-west-2</code>
* </p>
* </li>
* <li>
* <p>
* <code>ap-southeast-2</code>
* </p>
* </li>
* <li>
* <p>
* <code>ap-northeast-1</code>
* </p>
* </li>
* <li>
* <p>
* <code>eu-west-1</code>
* </p>
* </li>
* </ul>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { S3ControlClient, GetMultiRegionAccessPointRoutesCommand } from "@aws-sdk/client-s3-control"; // ES Modules import
* // const { S3ControlClient, GetMultiRegionAccessPointRoutesCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import
* const client = new S3ControlClient(config);
* const input = { // GetMultiRegionAccessPointRoutesRequest
* AccountId: "STRING_VALUE",
* Mrap: "STRING_VALUE", // required
* };
* const command = new GetMultiRegionAccessPointRoutesCommand(input);
* const response = await client.send(command);
* // { // GetMultiRegionAccessPointRoutesResult
* // Mrap: "STRING_VALUE",
* // Routes: [ // RouteList
* // { // MultiRegionAccessPointRoute
* // Bucket: "STRING_VALUE",
* // Region: "STRING_VALUE",
* // TrafficDialPercentage: Number("int"), // required
* // },
* // ],
* // };
*
* ```
*
* @param GetMultiRegionAccessPointRoutesCommandInput - {@link GetMultiRegionAccessPointRoutesCommandInput}
* @returns {@link GetMultiRegionAccessPointRoutesCommandOutput}
* @see {@link GetMultiRegionAccessPointRoutesCommandInput} for command's `input` shape.
* @see {@link GetMultiRegionAccessPointRoutesCommandOutput} for command's `response` shape.
* @see {@link S3ControlClientResolvedConfig | config} for S3ControlClient's `config` shape.
*
* @throws {@link S3ControlServiceException}
* <p>Base exception class for all service exceptions from S3Control service.</p>
*
* @public
*/
export class GetMultiRegionAccessPointRoutesCommand extends $Command
.classBuilder<
GetMultiRegionAccessPointRoutesCommandInput,
GetMultiRegionAccessPointRoutesCommandOutput,
S3ControlClientResolvedConfig,
ServiceInputTypes,
ServiceOutputTypes
>()
.ep({
...commonParams,
RequiresAccountId: { type: "staticContextParams", value: true },
AccountId: { type: "contextParams", name: "AccountId" },
})
.m(function (this: any, Command: any, cs: any, config: S3ControlClientResolvedConfig, o: any) {
return [
getSerdePlugin(config, this.serialize, this.deserialize),
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
getProcessArnablesPlugin(config),
getApplyMd5BodyChecksumPlugin(config),
];
})
.s("AWSS3ControlServiceV20180820", "GetMultiRegionAccessPointRoutes", {})
.n("S3ControlClient", "GetMultiRegionAccessPointRoutesCommand")
.f(void 0, void 0)
.ser(se_GetMultiRegionAccessPointRoutesCommand)
.de(de_GetMultiRegionAccessPointRoutesCommand)
.build() {}