@aws-sdk/client-account 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.
@@ -10,10 +10,12 @@ import { ListRegionsCommandInput, ListRegionsCommandOutput } from "./commands/Li
10
10
  import { PutAlternateContactCommandInput, PutAlternateContactCommandOutput } from "./commands/PutAlternateContactCommand";
11
11
  import { PutContactInformationCommandInput, PutContactInformationCommandOutput } from "./commands/PutContactInformationCommand";
12
12
  /**
13
+ * @public
13
14
  * <p>Operations for Amazon Web Services Account Management</p>
14
15
  */
15
16
  export declare class Account extends AccountClient {
16
17
  /**
18
+ * @public
17
19
  * <p>Deletes the specified alternate contact from an Amazon Web Services account.</p>
18
20
  * <p>For complete details about how to use the alternate contact operations, see <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html">Access or
19
21
  * updating the alternate contacts</a>.</p>
@@ -28,18 +30,21 @@ export declare class Account extends AccountClient {
28
30
  deleteAlternateContact(args: DeleteAlternateContactCommandInput, cb: (err: any, data?: DeleteAlternateContactCommandOutput) => void): void;
29
31
  deleteAlternateContact(args: DeleteAlternateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAlternateContactCommandOutput) => void): void;
30
32
  /**
33
+ * @public
31
34
  * <p>Disables (opts-out) a particular Region for an account.</p>
32
35
  */
33
36
  disableRegion(args: DisableRegionCommandInput, options?: __HttpHandlerOptions): Promise<DisableRegionCommandOutput>;
34
37
  disableRegion(args: DisableRegionCommandInput, cb: (err: any, data?: DisableRegionCommandOutput) => void): void;
35
38
  disableRegion(args: DisableRegionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableRegionCommandOutput) => void): void;
36
39
  /**
40
+ * @public
37
41
  * <p>Enables (opts-in) a particular Region for an account.</p>
38
42
  */
39
43
  enableRegion(args: EnableRegionCommandInput, options?: __HttpHandlerOptions): Promise<EnableRegionCommandOutput>;
40
44
  enableRegion(args: EnableRegionCommandInput, cb: (err: any, data?: EnableRegionCommandOutput) => void): void;
41
45
  enableRegion(args: EnableRegionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableRegionCommandOutput) => void): void;
42
46
  /**
47
+ * @public
43
48
  * <p>Retrieves the specified alternate contact attached to an Amazon Web Services account.</p>
44
49
  * <p>For complete details about how to use the alternate contact operations, see <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html">Access or
45
50
  * updating the alternate contacts</a>.</p>
@@ -54,6 +59,7 @@ export declare class Account extends AccountClient {
54
59
  getAlternateContact(args: GetAlternateContactCommandInput, cb: (err: any, data?: GetAlternateContactCommandOutput) => void): void;
55
60
  getAlternateContact(args: GetAlternateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAlternateContactCommandOutput) => void): void;
56
61
  /**
62
+ * @public
57
63
  * <p>Retrieves the primary contact information of an Amazon Web Services account.</p>
58
64
  * <p>For complete details about how to use the primary contact operations, see <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html">Update
59
65
  * the primary and alternate contact information</a>.</p>
@@ -62,12 +68,14 @@ export declare class Account extends AccountClient {
62
68
  getContactInformation(args: GetContactInformationCommandInput, cb: (err: any, data?: GetContactInformationCommandOutput) => void): void;
63
69
  getContactInformation(args: GetContactInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactInformationCommandOutput) => void): void;
64
70
  /**
71
+ * @public
65
72
  * <p>Retrieves the opt-in status of a particular Region.</p>
66
73
  */
67
74
  getRegionOptStatus(args: GetRegionOptStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetRegionOptStatusCommandOutput>;
68
75
  getRegionOptStatus(args: GetRegionOptStatusCommandInput, cb: (err: any, data?: GetRegionOptStatusCommandOutput) => void): void;
69
76
  getRegionOptStatus(args: GetRegionOptStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegionOptStatusCommandOutput) => void): void;
70
77
  /**
78
+ * @public
71
79
  * <p>Lists all the Regions for a given account and their respective opt-in statuses.
72
80
  * Optionally, this list can be filtered by the <code>region-opt-status-contains</code>
73
81
  * parameter. </p>
@@ -76,6 +84,7 @@ export declare class Account extends AccountClient {
76
84
  listRegions(args: ListRegionsCommandInput, cb: (err: any, data?: ListRegionsCommandOutput) => void): void;
77
85
  listRegions(args: ListRegionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRegionsCommandOutput) => void): void;
78
86
  /**
87
+ * @public
79
88
  * <p>Modifies the specified alternate contact attached to an Amazon Web Services account.</p>
80
89
  * <p>For complete details about how to use the alternate contact operations, see <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html">Access or
81
90
  * updating the alternate contacts</a>.</p>
@@ -90,6 +99,7 @@ export declare class Account extends AccountClient {
90
99
  putAlternateContact(args: PutAlternateContactCommandInput, cb: (err: any, data?: PutAlternateContactCommandOutput) => void): void;
91
100
  putAlternateContact(args: PutAlternateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAlternateContactCommandOutput) => void): void;
92
101
  /**
102
+ * @public
93
103
  * <p>Updates the primary contact information of an Amazon Web Services account.</p>
94
104
  * <p>For complete details about how to use the primary contact operations, see <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html">Update
95
105
  * the primary and alternate contact information</a>.</p>
@@ -17,15 +17,24 @@ import { ListRegionsCommandInput, ListRegionsCommandOutput } from "./commands/Li
17
17
  import { PutAlternateContactCommandInput, PutAlternateContactCommandOutput } from "./commands/PutAlternateContactCommand";
18
18
  import { PutContactInformationCommandInput, PutContactInformationCommandOutput } from "./commands/PutContactInformationCommand";
19
19
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
20
+ /**
21
+ * @public
22
+ */
20
23
  export type ServiceInputTypes = DeleteAlternateContactCommandInput | DisableRegionCommandInput | EnableRegionCommandInput | GetAlternateContactCommandInput | GetContactInformationCommandInput | GetRegionOptStatusCommandInput | ListRegionsCommandInput | PutAlternateContactCommandInput | PutContactInformationCommandInput;
24
+ /**
25
+ * @public
26
+ */
21
27
  export type ServiceOutputTypes = DeleteAlternateContactCommandOutput | DisableRegionCommandOutput | EnableRegionCommandOutput | GetAlternateContactCommandOutput | GetContactInformationCommandOutput | GetRegionOptStatusCommandOutput | ListRegionsCommandOutput | PutAlternateContactCommandOutput | PutContactInformationCommandOutput;
28
+ /**
29
+ * @public
30
+ */
22
31
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
23
32
  /**
24
33
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
25
34
  */
26
35
  requestHandler?: __HttpHandler;
27
36
  /**
28
- * A constructor for a class implementing the {@link __Checksum} interface
37
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
29
38
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
30
39
  * @internal
31
40
  */
@@ -115,23 +124,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
115
124
  */
116
125
  logger?: __Logger;
117
126
  /**
118
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
127
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
119
128
  */
120
129
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
121
130
  }
131
+ /**
132
+ * @public
133
+ */
122
134
  type AccountClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
123
135
  /**
124
- * The configuration interface of AccountClient class constructor that set the region, credentials and other options.
136
+ * @public
137
+ *
138
+ * The configuration interface of AccountClient class constructor that set the region, credentials and other options.
125
139
  */
126
140
  export interface AccountClientConfig extends AccountClientConfigType {
127
141
  }
142
+ /**
143
+ * @public
144
+ */
128
145
  type AccountClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
129
146
  /**
130
- * The resolved configuration interface of AccountClient class. This is resolved and normalized from the {@link AccountClientConfig | constructor configuration interface}.
147
+ * @public
148
+ *
149
+ * The resolved configuration interface of AccountClient class. This is resolved and normalized from the {@link AccountClientConfig | constructor configuration interface}.
131
150
  */
132
151
  export interface AccountClientResolvedConfig extends AccountClientResolvedConfigType {
133
152
  }
134
153
  /**
154
+ * @public
135
155
  * <p>Operations for Amazon Web Services Account Management</p>
136
156
  */
137
157
  export declare class AccountClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, AccountClientResolvedConfig> {
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AccountClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccountClient";
5
5
  import { DeleteAlternateContactRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteAlternateContactCommand}.
8
10
  */
9
11
  export interface DeleteAlternateContactCommandInput extends DeleteAlternateContactRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteAlternateContactCommand}.
13
17
  */
14
18
  export interface DeleteAlternateContactCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified alternate contact from an Amazon Web Services account.</p>
18
23
  * <p>For complete details about how to use the alternate contact operations, see <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html">Access or
19
24
  * updating the alternate contacts</a>.</p>
@@ -33,6 +38,8 @@ export interface DeleteAlternateContactCommandOutput extends __MetadataBearer {
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param DeleteAlternateContactCommandInput - {@link DeleteAlternateContactCommandInput}
42
+ * @returns {@link DeleteAlternateContactCommandOutput}
36
43
  * @see {@link DeleteAlternateContactCommandInput} for command's `input` shape.
37
44
  * @see {@link DeleteAlternateContactCommandOutput} for command's `response` shape.
38
45
  * @see {@link AccountClientResolvedConfig | config} for AccountClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DeleteAlternateContactCommandOutput extends __MetadataBearer {
60
67
  export declare class DeleteAlternateContactCommand extends $Command<DeleteAlternateContactCommandInput, DeleteAlternateContactCommandOutput, AccountClientResolvedConfig> {
61
68
  readonly input: DeleteAlternateContactCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DeleteAlternateContactCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccountClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAlternateContactCommandInput, DeleteAlternateContactCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AccountClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccountClient";
5
5
  import { DisableRegionRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisableRegionCommand}.
8
10
  */
9
11
  export interface DisableRegionCommandInput extends DisableRegionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisableRegionCommand}.
13
17
  */
14
18
  export interface DisableRegionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disables (opts-out) a particular Region for an account.</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 DisableRegionCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DisableRegionCommandInput - {@link DisableRegionCommandInput}
34
+ * @returns {@link DisableRegionCommandOutput}
28
35
  * @see {@link DisableRegionCommandInput} for command's `input` shape.
29
36
  * @see {@link DisableRegionCommandOutput} for command's `response` shape.
30
37
  * @see {@link AccountClientResolvedConfig | config} for AccountClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DisableRegionCommandOutput extends __MetadataBearer {
54
61
  export declare class DisableRegionCommand extends $Command<DisableRegionCommandInput, DisableRegionCommandOutput, AccountClientResolvedConfig> {
55
62
  readonly input: DisableRegionCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DisableRegionCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccountClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableRegionCommandInput, DisableRegionCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AccountClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccountClient";
5
5
  import { EnableRegionRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link EnableRegionCommand}.
8
10
  */
9
11
  export interface EnableRegionCommandInput extends EnableRegionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link EnableRegionCommand}.
13
17
  */
14
18
  export interface EnableRegionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Enables (opts-in) a particular Region for an account.</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 EnableRegionCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param EnableRegionCommandInput - {@link EnableRegionCommandInput}
34
+ * @returns {@link EnableRegionCommandOutput}
28
35
  * @see {@link EnableRegionCommandInput} for command's `input` shape.
29
36
  * @see {@link EnableRegionCommandOutput} for command's `response` shape.
30
37
  * @see {@link AccountClientResolvedConfig | config} for AccountClient's `config` shape.
@@ -54,11 +61,20 @@ export interface EnableRegionCommandOutput extends __MetadataBearer {
54
61
  export declare class EnableRegionCommand extends $Command<EnableRegionCommandInput, EnableRegionCommandOutput, AccountClientResolvedConfig> {
55
62
  readonly input: EnableRegionCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: EnableRegionCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccountClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableRegionCommandInput, EnableRegionCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AccountClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccountClient";
5
5
  import { GetAlternateContactRequest, GetAlternateContactResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetAlternateContactCommand}.
8
10
  */
9
11
  export interface GetAlternateContactCommandInput extends GetAlternateContactRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetAlternateContactCommand}.
13
17
  */
14
18
  export interface GetAlternateContactCommandOutput extends GetAlternateContactResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the specified alternate contact attached to an Amazon Web Services account.</p>
18
23
  * <p>For complete details about how to use the alternate contact operations, see <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html">Access or
19
24
  * updating the alternate contacts</a>.</p>
@@ -33,6 +38,8 @@ export interface GetAlternateContactCommandOutput extends GetAlternateContactRes
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param GetAlternateContactCommandInput - {@link GetAlternateContactCommandInput}
42
+ * @returns {@link GetAlternateContactCommandOutput}
36
43
  * @see {@link GetAlternateContactCommandInput} for command's `input` shape.
37
44
  * @see {@link GetAlternateContactCommandOutput} for command's `response` shape.
38
45
  * @see {@link AccountClientResolvedConfig | config} for AccountClient's `config` shape.
@@ -60,11 +67,20 @@ export interface GetAlternateContactCommandOutput extends GetAlternateContactRes
60
67
  export declare class GetAlternateContactCommand extends $Command<GetAlternateContactCommandInput, GetAlternateContactCommandOutput, AccountClientResolvedConfig> {
61
68
  readonly input: GetAlternateContactCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: GetAlternateContactCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccountClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAlternateContactCommandInput, GetAlternateContactCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AccountClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccountClient";
5
5
  import { GetContactInformationRequest, GetContactInformationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetContactInformationCommand}.
8
10
  */
9
11
  export interface GetContactInformationCommandInput extends GetContactInformationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetContactInformationCommand}.
13
17
  */
14
18
  export interface GetContactInformationCommandOutput extends GetContactInformationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the primary contact information of an Amazon Web Services account.</p>
18
23
  * <p>For complete details about how to use the primary contact operations, see <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html">Update
19
24
  * the primary and alternate contact information</a>.</p>
@@ -27,6 +32,8 @@ export interface GetContactInformationCommandOutput extends GetContactInformatio
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetContactInformationCommandInput - {@link GetContactInformationCommandInput}
36
+ * @returns {@link GetContactInformationCommandOutput}
30
37
  * @see {@link GetContactInformationCommandInput} for command's `input` shape.
31
38
  * @see {@link GetContactInformationCommandOutput} for command's `response` shape.
32
39
  * @see {@link AccountClientResolvedConfig | config} for AccountClient's `config` shape.
@@ -54,11 +61,20 @@ export interface GetContactInformationCommandOutput extends GetContactInformatio
54
61
  export declare class GetContactInformationCommand extends $Command<GetContactInformationCommandInput, GetContactInformationCommandOutput, AccountClientResolvedConfig> {
55
62
  readonly input: GetContactInformationCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: GetContactInformationCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccountClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetContactInformationCommandInput, GetContactInformationCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AccountClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccountClient";
5
5
  import { GetRegionOptStatusRequest, GetRegionOptStatusResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetRegionOptStatusCommand}.
8
10
  */
9
11
  export interface GetRegionOptStatusCommandInput extends GetRegionOptStatusRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetRegionOptStatusCommand}.
13
17
  */
14
18
  export interface GetRegionOptStatusCommandOutput extends GetRegionOptStatusResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the opt-in status of a particular 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 GetRegionOptStatusCommandOutput extends GetRegionOptStatusRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetRegionOptStatusCommandInput - {@link GetRegionOptStatusCommandInput}
34
+ * @returns {@link GetRegionOptStatusCommandOutput}
28
35
  * @see {@link GetRegionOptStatusCommandInput} for command's `input` shape.
29
36
  * @see {@link GetRegionOptStatusCommandOutput} for command's `response` shape.
30
37
  * @see {@link AccountClientResolvedConfig | config} for AccountClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetRegionOptStatusCommandOutput extends GetRegionOptStatusRespo
49
56
  export declare class GetRegionOptStatusCommand extends $Command<GetRegionOptStatusCommandInput, GetRegionOptStatusCommandOutput, AccountClientResolvedConfig> {
50
57
  readonly input: GetRegionOptStatusCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetRegionOptStatusCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccountClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetRegionOptStatusCommandInput, GetRegionOptStatusCommandOutput>;
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 { AccountClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccountClient";
5
5
  import { ListRegionsRequest, ListRegionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListRegionsCommand}.
8
10
  */
9
11
  export interface ListRegionsCommandInput extends ListRegionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListRegionsCommand}.
13
17
  */
14
18
  export interface ListRegionsCommandOutput extends ListRegionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all the Regions for a given account and their respective opt-in statuses.
18
23
  * Optionally, this list can be filtered by the <code>region-opt-status-contains</code>
19
24
  * parameter. </p>
@@ -27,6 +32,8 @@ export interface ListRegionsCommandOutput extends ListRegionsResponse, __Metadat
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListRegionsCommandInput - {@link ListRegionsCommandInput}
36
+ * @returns {@link ListRegionsCommandOutput}
30
37
  * @see {@link ListRegionsCommandInput} for command's `input` shape.
31
38
  * @see {@link ListRegionsCommandOutput} for command's `response` shape.
32
39
  * @see {@link AccountClientResolvedConfig | config} for AccountClient's `config` shape.
@@ -51,11 +58,20 @@ export interface ListRegionsCommandOutput extends ListRegionsResponse, __Metadat
51
58
  export declare class ListRegionsCommand extends $Command<ListRegionsCommandInput, ListRegionsCommandOutput, AccountClientResolvedConfig> {
52
59
  readonly input: ListRegionsCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: ListRegionsCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccountClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRegionsCommandInput, ListRegionsCommandOutput>;
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 { AccountClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccountClient";
5
5
  import { PutAlternateContactRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutAlternateContactCommand}.
8
10
  */
9
11
  export interface PutAlternateContactCommandInput extends PutAlternateContactRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutAlternateContactCommand}.
13
17
  */
14
18
  export interface PutAlternateContactCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Modifies the specified alternate contact attached to an Amazon Web Services account.</p>
18
23
  * <p>For complete details about how to use the alternate contact operations, see <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html">Access or
19
24
  * updating the alternate contacts</a>.</p>
@@ -33,6 +38,8 @@ export interface PutAlternateContactCommandOutput extends __MetadataBearer {
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param PutAlternateContactCommandInput - {@link PutAlternateContactCommandInput}
42
+ * @returns {@link PutAlternateContactCommandOutput}
36
43
  * @see {@link PutAlternateContactCommandInput} for command's `input` shape.
37
44
  * @see {@link PutAlternateContactCommandOutput} for command's `response` shape.
38
45
  * @see {@link AccountClientResolvedConfig | config} for AccountClient's `config` shape.
@@ -57,11 +64,20 @@ export interface PutAlternateContactCommandOutput extends __MetadataBearer {
57
64
  export declare class PutAlternateContactCommand extends $Command<PutAlternateContactCommandInput, PutAlternateContactCommandOutput, AccountClientResolvedConfig> {
58
65
  readonly input: PutAlternateContactCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: PutAlternateContactCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccountClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutAlternateContactCommandInput, PutAlternateContactCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AccountClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccountClient";
5
5
  import { PutContactInformationRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutContactInformationCommand}.
8
10
  */
9
11
  export interface PutContactInformationCommandInput extends PutContactInformationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutContactInformationCommand}.
13
17
  */
14
18
  export interface PutContactInformationCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the primary contact information of an Amazon Web Services account.</p>
18
23
  * <p>For complete details about how to use the primary contact operations, see <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html">Update
19
24
  * the primary and alternate contact information</a>.</p>
@@ -27,6 +32,8 @@ export interface PutContactInformationCommandOutput extends __MetadataBearer {
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param PutContactInformationCommandInput - {@link PutContactInformationCommandInput}
36
+ * @returns {@link PutContactInformationCommandOutput}
30
37
  * @see {@link PutContactInformationCommandInput} for command's `input` shape.
31
38
  * @see {@link PutContactInformationCommandOutput} for command's `response` shape.
32
39
  * @see {@link AccountClientResolvedConfig | config} for AccountClient's `config` shape.
@@ -51,11 +58,20 @@ export interface PutContactInformationCommandOutput extends __MetadataBearer {
51
58
  export declare class PutContactInformationCommand extends $Command<PutContactInformationCommandInput, PutContactInformationCommandOutput, AccountClientResolvedConfig> {
52
59
  readonly input: PutContactInformationCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: PutContactInformationCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccountClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutContactInformationCommandInput, PutContactInformationCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -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 Account service.
4
6
  */
5
7
  export declare class AccountServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { AccountServiceException as __BaseException } from "./AccountServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>The operation failed because the calling identity doesn't have the minimum required
5
6
  * permissions.</p>
6
7
  */
@@ -12,11 +13,17 @@ export declare class AccessDeniedException extends __BaseException {
12
13
  */
13
14
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
15
  }
16
+ /**
17
+ * @public
18
+ */
15
19
  export declare enum AlternateContactType {
16
20
  BILLING = "BILLING",
17
21
  OPERATIONS = "OPERATIONS",
18
22
  SECURITY = "SECURITY"
19
23
  }
24
+ /**
25
+ * @public
26
+ */
20
27
  export interface DeleteAlternateContactRequest {
21
28
  /**
22
29
  * <p>Specifies which of the alternate contacts to delete. </p>
@@ -45,6 +52,7 @@ export interface DeleteAlternateContactRequest {
45
52
  AccountId?: string;
46
53
  }
47
54
  /**
55
+ * @public
48
56
  * <p>The operation failed because of an error internal to Amazon Web Services. Try your operation again
49
57
  * later.</p>
50
58
  */
@@ -58,6 +66,7 @@ export declare class InternalServerException extends __BaseException {
58
66
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
59
67
  }
60
68
  /**
69
+ * @public
61
70
  * <p>The operation failed because it specified a resource that can't be found.</p>
62
71
  */
63
72
  export declare class ResourceNotFoundException extends __BaseException {
@@ -69,6 +78,7 @@ export declare class ResourceNotFoundException extends __BaseException {
69
78
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
70
79
  }
71
80
  /**
81
+ * @public
72
82
  * <p>The operation failed because it was called too frequently and exceeded a throttle
73
83
  * limit.</p>
74
84
  */
@@ -84,6 +94,7 @@ export declare class TooManyRequestsException extends __BaseException {
84
94
  constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
85
95
  }
86
96
  /**
97
+ * @public
87
98
  * <p>The input failed to meet the constraints specified by the Amazon Web Services service in a specified field.</p>
88
99
  */
89
100
  export interface ValidationExceptionField {
@@ -96,11 +107,15 @@ export interface ValidationExceptionField {
96
107
  */
97
108
  message: string | undefined;
98
109
  }
110
+ /**
111
+ * @public
112
+ */
99
113
  export declare enum ValidationExceptionReason {
100
114
  FIELD_VALIDATION_FAILED = "fieldValidationFailed",
101
115
  INVALID_REGION_OPT_TARGET = "invalidRegionOptTarget"
102
116
  }
103
117
  /**
118
+ * @public
104
119
  * <p>The operation failed because one of the input parameters was invalid.</p>
105
120
  */
106
121
  export declare class ValidationException extends __BaseException {
@@ -119,6 +134,9 @@ export declare class ValidationException extends __BaseException {
119
134
  */
120
135
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
121
136
  }
137
+ /**
138
+ * @public
139
+ */
122
140
  export interface GetAlternateContactRequest {
123
141
  /**
124
142
  * <p>Specifies which alternate contact you want to retrieve.</p>
@@ -147,6 +165,7 @@ export interface GetAlternateContactRequest {
147
165
  AccountId?: string;
148
166
  }
149
167
  /**
168
+ * @public
150
169
  * <p>A structure that contains the details of an alternate contact associated with an Amazon Web Services
151
170
  * account</p>
152
171
  */
@@ -172,12 +191,18 @@ export interface AlternateContact {
172
191
  */
173
192
  AlternateContactType?: AlternateContactType | string;
174
193
  }
194
+ /**
195
+ * @public
196
+ */
175
197
  export interface GetAlternateContactResponse {
176
198
  /**
177
199
  * <p>A structure that contains the details for the specified alternate contact.</p>
178
200
  */
179
201
  AlternateContact?: AlternateContact;
180
202
  }
203
+ /**
204
+ * @public
205
+ */
181
206
  export interface PutAlternateContactRequest {
182
207
  /**
183
208
  * <p>Specifies a name for the alternate contact.</p>
@@ -221,6 +246,9 @@ export interface PutAlternateContactRequest {
221
246
  */
222
247
  AccountId?: string;
223
248
  }
249
+ /**
250
+ * @public
251
+ */
224
252
  export interface GetContactInformationRequest {
225
253
  /**
226
254
  * <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
@@ -245,6 +273,7 @@ export interface GetContactInformationRequest {
245
273
  AccountId?: string;
246
274
  }
247
275
  /**
276
+ * @public
248
277
  * <p>Contains the details of the primary contact information associated with an Amazon Web Services account.</p>
249
278
  */
250
279
  export interface ContactInformation {
@@ -297,12 +326,18 @@ export interface ContactInformation {
297
326
  */
298
327
  WebsiteUrl?: string;
299
328
  }
329
+ /**
330
+ * @public
331
+ */
300
332
  export interface GetContactInformationResponse {
301
333
  /**
302
334
  * <p>Contains the details of the primary contact information associated with an Amazon Web Services account.</p>
303
335
  */
304
336
  ContactInformation?: ContactInformation;
305
337
  }
338
+ /**
339
+ * @public
340
+ */
306
341
  export interface PutContactInformationRequest {
307
342
  /**
308
343
  * <p>Contains the details of the primary contact information associated with an Amazon Web Services account.</p>
@@ -331,6 +366,7 @@ export interface PutContactInformationRequest {
331
366
  AccountId?: string;
332
367
  }
333
368
  /**
369
+ * @public
334
370
  * <p>The request could not be processed because of a conflict in the current status of the
335
371
  * resource. For example, this happens if you try to enable a Region that is currently being disabled
336
372
  * (in a status of DISABLING).</p>
@@ -343,6 +379,9 @@ export declare class ConflictException extends __BaseException {
343
379
  */
344
380
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
345
381
  }
382
+ /**
383
+ * @public
384
+ */
346
385
  export interface DisableRegionRequest {
347
386
  /**
348
387
  * <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
@@ -374,6 +413,9 @@ export interface DisableRegionRequest {
374
413
  */
375
414
  RegionName: string | undefined;
376
415
  }
416
+ /**
417
+ * @public
418
+ */
377
419
  export interface EnableRegionRequest {
378
420
  /**
379
421
  * <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
@@ -406,6 +448,9 @@ export interface EnableRegionRequest {
406
448
  */
407
449
  RegionName: string | undefined;
408
450
  }
451
+ /**
452
+ * @public
453
+ */
409
454
  export interface GetRegionOptStatusRequest {
410
455
  /**
411
456
  * <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
@@ -434,6 +479,9 @@ export interface GetRegionOptStatusRequest {
434
479
  */
435
480
  RegionName: string | undefined;
436
481
  }
482
+ /**
483
+ * @public
484
+ */
437
485
  export declare enum RegionOptStatus {
438
486
  DISABLED = "DISABLED",
439
487
  DISABLING = "DISABLING",
@@ -441,6 +489,9 @@ export declare enum RegionOptStatus {
441
489
  ENABLED_BY_DEFAULT = "ENABLED_BY_DEFAULT",
442
490
  ENABLING = "ENABLING"
443
491
  }
492
+ /**
493
+ * @public
494
+ */
444
495
  export interface GetRegionOptStatusResponse {
445
496
  /**
446
497
  * <p>The Region code that was passed in.</p>
@@ -452,6 +503,9 @@ export interface GetRegionOptStatusResponse {
452
503
  */
453
504
  RegionOptStatus?: RegionOptStatus | string;
454
505
  }
506
+ /**
507
+ * @public
508
+ */
455
509
  export interface ListRegionsRequest {
456
510
  /**
457
511
  * <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
@@ -499,6 +553,7 @@ export interface ListRegionsRequest {
499
553
  RegionOptStatusContains?: (RegionOptStatus | string)[];
500
554
  }
501
555
  /**
556
+ * @public
502
557
  * <p>This is a structure that expresses the Region for a given account, consisting of a
503
558
  * name and opt-in status.</p>
504
559
  */
@@ -513,6 +568,9 @@ export interface Region {
513
568
  */
514
569
  RegionOptStatus?: RegionOptStatus | string;
515
570
  }
571
+ /**
572
+ * @public
573
+ */
516
574
  export interface ListRegionsResponse {
517
575
  /**
518
576
  * <p>If there is more data to be returned, this will be populated. It should be passed into
@@ -1,5 +1,8 @@
1
1
  import { PaginationConfiguration } from "@aws-sdk/types";
2
2
  import { AccountClient } from "../AccountClient";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface AccountPaginationConfiguration extends PaginationConfiguration {
4
7
  client: AccountClient;
5
8
  }
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListRegionsCommandInput, ListRegionsCommandOutput } from "../commands/ListRegionsCommand";
3
3
  import { AccountPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListRegions(config: AccountPaginationConfiguration, input: ListRegionsCommandInput, ...additionalArguments: any): Paginator<ListRegionsCommandOutput>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-account",
3
3
  "description": "AWS SDK for JavaScript Account Client for Node.js, Browser and React Native",
4
- "version": "3.296.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,9 +20,9 @@
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.296.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
24
  "@aws-sdk/config-resolver": "3.296.0",
25
- "@aws-sdk/credential-provider-node": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
26
  "@aws-sdk/fetch-http-handler": "3.296.0",
27
27
  "@aws-sdk/hash-node": "3.296.0",
28
28
  "@aws-sdk/invalid-dependency": "3.296.0",