@aws-sdk/client-rolesanywhere 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.
Files changed (36) hide show
  1. package/dist-types/RolesAnywhere.d.ts +27 -0
  2. package/dist-types/RolesAnywhereClient.d.ts +24 -4
  3. package/dist-types/commands/CreateProfileCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateTrustAnchorCommand.d.ts +16 -0
  5. package/dist-types/commands/DeleteCrlCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteProfileCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteTrustAnchorCommand.d.ts +16 -0
  8. package/dist-types/commands/DisableCrlCommand.d.ts +16 -0
  9. package/dist-types/commands/DisableProfileCommand.d.ts +16 -0
  10. package/dist-types/commands/DisableTrustAnchorCommand.d.ts +16 -0
  11. package/dist-types/commands/EnableCrlCommand.d.ts +16 -0
  12. package/dist-types/commands/EnableProfileCommand.d.ts +16 -0
  13. package/dist-types/commands/EnableTrustAnchorCommand.d.ts +16 -0
  14. package/dist-types/commands/GetCrlCommand.d.ts +16 -0
  15. package/dist-types/commands/GetProfileCommand.d.ts +16 -0
  16. package/dist-types/commands/GetSubjectCommand.d.ts +16 -0
  17. package/dist-types/commands/GetTrustAnchorCommand.d.ts +16 -0
  18. package/dist-types/commands/ImportCrlCommand.d.ts +16 -0
  19. package/dist-types/commands/ListCrlsCommand.d.ts +16 -0
  20. package/dist-types/commands/ListProfilesCommand.d.ts +16 -0
  21. package/dist-types/commands/ListSubjectsCommand.d.ts +16 -0
  22. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  23. package/dist-types/commands/ListTrustAnchorsCommand.d.ts +16 -0
  24. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  25. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  26. package/dist-types/commands/UpdateCrlCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdateProfileCommand.d.ts +16 -0
  28. package/dist-types/commands/UpdateTrustAnchorCommand.d.ts +16 -0
  29. package/dist-types/models/RolesAnywhereServiceException.d.ts +2 -0
  30. package/dist-types/models/models_0.d.ts +95 -0
  31. package/dist-types/pagination/Interfaces.d.ts +3 -0
  32. package/dist-types/pagination/ListCrlsPaginator.d.ts +3 -0
  33. package/dist-types/pagination/ListProfilesPaginator.d.ts +3 -0
  34. package/dist-types/pagination/ListSubjectsPaginator.d.ts +3 -0
  35. package/dist-types/pagination/ListTrustAnchorsPaginator.d.ts +3 -0
  36. package/package.json +29 -29
@@ -27,6 +27,7 @@ import { UpdateProfileCommandInput, UpdateProfileCommandOutput } from "./command
27
27
  import { UpdateTrustAnchorCommandInput, UpdateTrustAnchorCommandOutput } from "./commands/UpdateTrustAnchorCommand";
28
28
  import { RolesAnywhereClient } from "./RolesAnywhereClient";
29
29
  /**
30
+ * @public
30
31
  * <p>AWS Identity and Access Management Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications running outside of AWS to obtain Temporary AWS credentials. Your workloads can use the same IAM policies and roles that you have configured with native AWS applications to access AWS resources. Using IAM Roles Anywhere will eliminate the need to manage long term credentials for workloads running outside of AWS.</p>
31
32
  * <p>To use IAM Roles Anywhere customer workloads will need to use X.509 certificates issued by their Certificate Authority (CA) . The Certificate Authority (CA) needs to be registered with IAM Roles Anywhere as a trust anchor to establish trust between customer PKI and IAM Roles Anywhere. Customers who do not manage their own PKI system can use AWS Certificate Manager Private Certificate Authority (ACM PCA) to create a Certificate Authority and use that to establish trust with IAM Roles Anywhere</p>
32
33
  * <p>This guide describes the IAM rolesanywhere operations that you can call programmatically. For general information about IAM Roles Anywhere see <a href="https://docs.aws.amazon.com/">https://docs.aws.amazon.com/</a>
@@ -34,6 +35,7 @@ import { RolesAnywhereClient } from "./RolesAnywhereClient";
34
35
  */
35
36
  export declare class RolesAnywhere extends RolesAnywhereClient {
36
37
  /**
38
+ * @public
37
39
  * <p>Creates a profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can intersect permissions with IAM managed policies.</p>
38
40
  * <p>
39
41
  * <b>Required permissions: </b>
@@ -44,6 +46,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
44
46
  createProfile(args: CreateProfileCommandInput, cb: (err: any, data?: CreateProfileCommandOutput) => void): void;
45
47
  createProfile(args: CreateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProfileCommandOutput) => void): void;
46
48
  /**
49
+ * @public
47
50
  * <p>Creates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.</p>
48
51
  * <p>
49
52
  * <b>Required permissions: </b>
@@ -54,6 +57,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
54
57
  createTrustAnchor(args: CreateTrustAnchorCommandInput, cb: (err: any, data?: CreateTrustAnchorCommandOutput) => void): void;
55
58
  createTrustAnchor(args: CreateTrustAnchorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrustAnchorCommandOutput) => void): void;
56
59
  /**
60
+ * @public
57
61
  * <p>Deletes a certificate revocation list (CRL).</p>
58
62
  * <p>
59
63
  * <b>Required permissions: </b>
@@ -64,6 +68,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
64
68
  deleteCrl(args: DeleteCrlCommandInput, cb: (err: any, data?: DeleteCrlCommandOutput) => void): void;
65
69
  deleteCrl(args: DeleteCrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCrlCommandOutput) => void): void;
66
70
  /**
71
+ * @public
67
72
  * <p>Deletes a profile.</p>
68
73
  * <p>
69
74
  * <b>Required permissions: </b>
@@ -74,6 +79,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
74
79
  deleteProfile(args: DeleteProfileCommandInput, cb: (err: any, data?: DeleteProfileCommandOutput) => void): void;
75
80
  deleteProfile(args: DeleteProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfileCommandOutput) => void): void;
76
81
  /**
82
+ * @public
77
83
  * <p>Deletes a trust anchor.</p>
78
84
  * <p>
79
85
  * <b>Required permissions: </b>
@@ -84,6 +90,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
84
90
  deleteTrustAnchor(args: DeleteTrustAnchorCommandInput, cb: (err: any, data?: DeleteTrustAnchorCommandOutput) => void): void;
85
91
  deleteTrustAnchor(args: DeleteTrustAnchorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrustAnchorCommandOutput) => void): void;
86
92
  /**
93
+ * @public
87
94
  * <p>Disables a certificate revocation list (CRL).</p>
88
95
  * <p>
89
96
  * <b>Required permissions: </b>
@@ -94,6 +101,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
94
101
  disableCrl(args: DisableCrlCommandInput, cb: (err: any, data?: DisableCrlCommandOutput) => void): void;
95
102
  disableCrl(args: DisableCrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableCrlCommandOutput) => void): void;
96
103
  /**
104
+ * @public
97
105
  * <p>Disables a profile. When disabled, <a href="https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html">CreateSession</a> requests with this profile fail.</p>
98
106
  * <p>
99
107
  * <b>Required permissions: </b>
@@ -104,6 +112,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
104
112
  disableProfile(args: DisableProfileCommandInput, cb: (err: any, data?: DisableProfileCommandOutput) => void): void;
105
113
  disableProfile(args: DisableProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableProfileCommandOutput) => void): void;
106
114
  /**
115
+ * @public
107
116
  * <p>Disables a trust anchor. When disabled, <a href="https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html">CreateSession</a> requests specifying this trust anchor are unauthorized.</p>
108
117
  * <p>
109
118
  * <b>Required permissions: </b>
@@ -114,6 +123,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
114
123
  disableTrustAnchor(args: DisableTrustAnchorCommandInput, cb: (err: any, data?: DisableTrustAnchorCommandOutput) => void): void;
115
124
  disableTrustAnchor(args: DisableTrustAnchorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableTrustAnchorCommandOutput) => void): void;
116
125
  /**
126
+ * @public
117
127
  * <p>Enables a certificate revocation list (CRL). When enabled, certificates stored in the CRL are unauthorized to receive session credentials.</p>
118
128
  * <p>
119
129
  * <b>Required permissions: </b>
@@ -124,6 +134,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
124
134
  enableCrl(args: EnableCrlCommandInput, cb: (err: any, data?: EnableCrlCommandOutput) => void): void;
125
135
  enableCrl(args: EnableCrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableCrlCommandOutput) => void): void;
126
136
  /**
137
+ * @public
127
138
  * <p>Enables the roles in a profile to receive session credentials in <a href="https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html">CreateSession</a>. </p>
128
139
  * <p>
129
140
  * <b>Required permissions: </b>
@@ -134,6 +145,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
134
145
  enableProfile(args: EnableProfileCommandInput, cb: (err: any, data?: EnableProfileCommandOutput) => void): void;
135
146
  enableProfile(args: EnableProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableProfileCommandOutput) => void): void;
136
147
  /**
148
+ * @public
137
149
  * <p>Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation. </p>
138
150
  * <p>
139
151
  * <b>Required permissions: </b>
@@ -144,6 +156,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
144
156
  enableTrustAnchor(args: EnableTrustAnchorCommandInput, cb: (err: any, data?: EnableTrustAnchorCommandOutput) => void): void;
145
157
  enableTrustAnchor(args: EnableTrustAnchorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableTrustAnchorCommandOutput) => void): void;
146
158
  /**
159
+ * @public
147
160
  * <p>Gets a certificate revocation list (CRL).</p>
148
161
  * <p>
149
162
  * <b>Required permissions: </b>
@@ -154,6 +167,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
154
167
  getCrl(args: GetCrlCommandInput, cb: (err: any, data?: GetCrlCommandOutput) => void): void;
155
168
  getCrl(args: GetCrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCrlCommandOutput) => void): void;
156
169
  /**
170
+ * @public
157
171
  * <p>Gets a profile.</p>
158
172
  * <p>
159
173
  * <b>Required permissions: </b>
@@ -164,6 +178,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
164
178
  getProfile(args: GetProfileCommandInput, cb: (err: any, data?: GetProfileCommandOutput) => void): void;
165
179
  getProfile(args: GetProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProfileCommandOutput) => void): void;
166
180
  /**
181
+ * @public
167
182
  * <p>Gets a Subject. A Subject associates a certificate identity with authentication attempts by CreateSession. The Subject resources stores audit information such as status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication. </p>
168
183
  * <p>
169
184
  * <b>Required permissions: </b>
@@ -174,6 +189,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
174
189
  getSubject(args: GetSubjectCommandInput, cb: (err: any, data?: GetSubjectCommandOutput) => void): void;
175
190
  getSubject(args: GetSubjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubjectCommandOutput) => void): void;
176
191
  /**
192
+ * @public
177
193
  * <p>Gets a trust anchor.</p>
178
194
  * <p>
179
195
  * <b>Required permissions: </b>
@@ -184,6 +200,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
184
200
  getTrustAnchor(args: GetTrustAnchorCommandInput, cb: (err: any, data?: GetTrustAnchorCommandOutput) => void): void;
185
201
  getTrustAnchor(args: GetTrustAnchorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTrustAnchorCommandOutput) => void): void;
186
202
  /**
203
+ * @public
187
204
  * <p>Imports the certificate revocation list (CRL). CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials. </p>
188
205
  * <p>
189
206
  * <b>Required permissions: </b>
@@ -194,6 +211,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
194
211
  importCrl(args: ImportCrlCommandInput, cb: (err: any, data?: ImportCrlCommandOutput) => void): void;
195
212
  importCrl(args: ImportCrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportCrlCommandOutput) => void): void;
196
213
  /**
214
+ * @public
197
215
  * <p>Lists all Crls in the authenticated account and Amazon Web Services Region.</p>
198
216
  * <p>
199
217
  * <b>Required permissions: </b>
@@ -204,6 +222,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
204
222
  listCrls(args: ListCrlsCommandInput, cb: (err: any, data?: ListCrlsCommandOutput) => void): void;
205
223
  listCrls(args: ListCrlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCrlsCommandOutput) => void): void;
206
224
  /**
225
+ * @public
207
226
  * <p>Lists all profiles in the authenticated account and Amazon Web Services Region.</p>
208
227
  * <p>
209
228
  * <b>Required permissions: </b>
@@ -214,6 +233,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
214
233
  listProfiles(args: ListProfilesCommandInput, cb: (err: any, data?: ListProfilesCommandOutput) => void): void;
215
234
  listProfiles(args: ListProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProfilesCommandOutput) => void): void;
216
235
  /**
236
+ * @public
217
237
  * <p>Lists the subjects in the authenticated account and Amazon Web Services Region.</p>
218
238
  * <p>
219
239
  * <b>Required permissions: </b>
@@ -224,6 +244,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
224
244
  listSubjects(args: ListSubjectsCommandInput, cb: (err: any, data?: ListSubjectsCommandOutput) => void): void;
225
245
  listSubjects(args: ListSubjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubjectsCommandOutput) => void): void;
226
246
  /**
247
+ * @public
227
248
  * <p>Lists the tags attached to the resource.</p>
228
249
  * <p>
229
250
  * <b>Required permissions: </b>
@@ -234,6 +255,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
234
255
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
235
256
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
236
257
  /**
258
+ * @public
237
259
  * <p>Lists the trust anchors in the authenticated account and Amazon Web Services Region.</p>
238
260
  * <p>
239
261
  * <b>Required permissions: </b>
@@ -244,6 +266,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
244
266
  listTrustAnchors(args: ListTrustAnchorsCommandInput, cb: (err: any, data?: ListTrustAnchorsCommandOutput) => void): void;
245
267
  listTrustAnchors(args: ListTrustAnchorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrustAnchorsCommandOutput) => void): void;
246
268
  /**
269
+ * @public
247
270
  * <p>Attaches tags to a resource.</p>
248
271
  * <p>
249
272
  * <b>Required permissions: </b>
@@ -254,6 +277,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
254
277
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
255
278
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
256
279
  /**
280
+ * @public
257
281
  * <p>Removes tags from the resource.</p>
258
282
  * <p>
259
283
  * <b>Required permissions: </b>
@@ -264,6 +288,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
264
288
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
265
289
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
266
290
  /**
291
+ * @public
267
292
  * <p>Updates the certificate revocation list (CRL). CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials.</p>
268
293
  * <p>
269
294
  * <b>Required permissions: </b>
@@ -274,6 +299,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
274
299
  updateCrl(args: UpdateCrlCommandInput, cb: (err: any, data?: UpdateCrlCommandOutput) => void): void;
275
300
  updateCrl(args: UpdateCrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCrlCommandOutput) => void): void;
276
301
  /**
302
+ * @public
277
303
  * <p>Updates the profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can scope-down permissions with IAM managed policies.</p>
278
304
  * <p>
279
305
  * <b>Required permissions: </b>
@@ -284,6 +310,7 @@ export declare class RolesAnywhere extends RolesAnywhereClient {
284
310
  updateProfile(args: UpdateProfileCommandInput, cb: (err: any, data?: UpdateProfileCommandOutput) => void): void;
285
311
  updateProfile(args: UpdateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProfileCommandOutput) => void): void;
286
312
  /**
313
+ * @public
287
314
  * <p>Updates the trust anchor.You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.</p>
288
315
  * <p>
289
316
  * <b>Required permissions: </b>
@@ -34,15 +34,24 @@ import { UpdateCrlCommandInput, UpdateCrlCommandOutput } from "./commands/Update
34
34
  import { UpdateProfileCommandInput, UpdateProfileCommandOutput } from "./commands/UpdateProfileCommand";
35
35
  import { UpdateTrustAnchorCommandInput, UpdateTrustAnchorCommandOutput } from "./commands/UpdateTrustAnchorCommand";
36
36
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
37
+ /**
38
+ * @public
39
+ */
37
40
  export type ServiceInputTypes = CreateProfileCommandInput | CreateTrustAnchorCommandInput | DeleteCrlCommandInput | DeleteProfileCommandInput | DeleteTrustAnchorCommandInput | DisableCrlCommandInput | DisableProfileCommandInput | DisableTrustAnchorCommandInput | EnableCrlCommandInput | EnableProfileCommandInput | EnableTrustAnchorCommandInput | GetCrlCommandInput | GetProfileCommandInput | GetSubjectCommandInput | GetTrustAnchorCommandInput | ImportCrlCommandInput | ListCrlsCommandInput | ListProfilesCommandInput | ListSubjectsCommandInput | ListTagsForResourceCommandInput | ListTrustAnchorsCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCrlCommandInput | UpdateProfileCommandInput | UpdateTrustAnchorCommandInput;
41
+ /**
42
+ * @public
43
+ */
38
44
  export type ServiceOutputTypes = CreateProfileCommandOutput | CreateTrustAnchorCommandOutput | DeleteCrlCommandOutput | DeleteProfileCommandOutput | DeleteTrustAnchorCommandOutput | DisableCrlCommandOutput | DisableProfileCommandOutput | DisableTrustAnchorCommandOutput | EnableCrlCommandOutput | EnableProfileCommandOutput | EnableTrustAnchorCommandOutput | GetCrlCommandOutput | GetProfileCommandOutput | GetSubjectCommandOutput | GetTrustAnchorCommandOutput | ImportCrlCommandOutput | ListCrlsCommandOutput | ListProfilesCommandOutput | ListSubjectsCommandOutput | ListTagsForResourceCommandOutput | ListTrustAnchorsCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCrlCommandOutput | UpdateProfileCommandOutput | UpdateTrustAnchorCommandOutput;
45
+ /**
46
+ * @public
47
+ */
39
48
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
40
49
  /**
41
50
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
42
51
  */
43
52
  requestHandler?: __HttpHandler;
44
53
  /**
45
- * A constructor for a class implementing the {@link __Checksum} interface
54
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
46
55
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
47
56
  * @internal
48
57
  */
@@ -132,23 +141,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
132
141
  */
133
142
  logger?: __Logger;
134
143
  /**
135
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
144
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
136
145
  */
137
146
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
138
147
  }
148
+ /**
149
+ * @public
150
+ */
139
151
  type RolesAnywhereClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
140
152
  /**
141
- * The configuration interface of RolesAnywhereClient class constructor that set the region, credentials and other options.
153
+ * @public
154
+ *
155
+ * The configuration interface of RolesAnywhereClient class constructor that set the region, credentials and other options.
142
156
  */
143
157
  export interface RolesAnywhereClientConfig extends RolesAnywhereClientConfigType {
144
158
  }
159
+ /**
160
+ * @public
161
+ */
145
162
  type RolesAnywhereClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
146
163
  /**
147
- * The resolved configuration interface of RolesAnywhereClient class. This is resolved and normalized from the {@link RolesAnywhereClientConfig | constructor configuration interface}.
164
+ * @public
165
+ *
166
+ * The resolved configuration interface of RolesAnywhereClient class. This is resolved and normalized from the {@link RolesAnywhereClientConfig | constructor configuration interface}.
148
167
  */
149
168
  export interface RolesAnywhereClientResolvedConfig extends RolesAnywhereClientResolvedConfigType {
150
169
  }
151
170
  /**
171
+ * @public
152
172
  * <p>AWS Identity and Access Management Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications running outside of AWS to obtain Temporary AWS credentials. Your workloads can use the same IAM policies and roles that you have configured with native AWS applications to access AWS resources. Using IAM Roles Anywhere will eliminate the need to manage long term credentials for workloads running outside of AWS.</p>
153
173
  * <p>To use IAM Roles Anywhere customer workloads will need to use X.509 certificates issued by their Certificate Authority (CA) . The Certificate Authority (CA) needs to be registered with IAM Roles Anywhere as a trust anchor to establish trust between customer PKI and IAM Roles Anywhere. Customers who do not manage their own PKI system can use AWS Certificate Manager Private Certificate Authority (ACM PCA) to create a Certificate Authority and use that to establish trust with IAM Roles Anywhere</p>
154
174
  * <p>This guide describes the IAM rolesanywhere operations that you can call programmatically. For general information about IAM Roles Anywhere see <a href="https://docs.aws.amazon.com/">https://docs.aws.amazon.com/</a>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateProfileRequest, ProfileDetailResponse } from "../models/models_0";
5
5
  import { RolesAnywhereClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RolesAnywhereClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateProfileCommand}.
8
10
  */
9
11
  export interface CreateProfileCommandInput extends CreateProfileRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateProfileCommand}.
13
17
  */
14
18
  export interface CreateProfileCommandOutput extends ProfileDetailResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can intersect permissions with IAM managed policies.</p>
18
23
  * <p>
19
24
  * <b>Required permissions: </b>
@@ -29,6 +34,8 @@ export interface CreateProfileCommandOutput extends ProfileDetailResponse, __Met
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param CreateProfileCommandInput - {@link CreateProfileCommandInput}
38
+ * @returns {@link CreateProfileCommandOutput}
32
39
  * @see {@link CreateProfileCommandInput} for command's `input` shape.
33
40
  * @see {@link CreateProfileCommandOutput} for command's `response` shape.
34
41
  * @see {@link RolesAnywhereClientResolvedConfig | config} for RolesAnywhereClient's `config` shape.
@@ -44,11 +51,20 @@ export interface CreateProfileCommandOutput extends ProfileDetailResponse, __Met
44
51
  export declare class CreateProfileCommand extends $Command<CreateProfileCommandInput, CreateProfileCommandOutput, RolesAnywhereClientResolvedConfig> {
45
52
  readonly input: CreateProfileCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: CreateProfileCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RolesAnywhereClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateProfileCommandInput, CreateProfileCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateTrustAnchorRequest, TrustAnchorDetailResponse } from "../models/models_0";
5
5
  import { RolesAnywhereClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RolesAnywhereClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateTrustAnchorCommand}.
8
10
  */
9
11
  export interface CreateTrustAnchorCommandInput extends CreateTrustAnchorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateTrustAnchorCommand}.
13
17
  */
14
18
  export interface CreateTrustAnchorCommandOutput extends TrustAnchorDetailResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.</p>
18
23
  * <p>
19
24
  * <b>Required permissions: </b>
@@ -29,6 +34,8 @@ export interface CreateTrustAnchorCommandOutput extends TrustAnchorDetailRespons
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param CreateTrustAnchorCommandInput - {@link CreateTrustAnchorCommandInput}
38
+ * @returns {@link CreateTrustAnchorCommandOutput}
32
39
  * @see {@link CreateTrustAnchorCommandInput} for command's `input` shape.
33
40
  * @see {@link CreateTrustAnchorCommandOutput} for command's `response` shape.
34
41
  * @see {@link RolesAnywhereClientResolvedConfig | config} for RolesAnywhereClient's `config` shape.
@@ -44,11 +51,20 @@ export interface CreateTrustAnchorCommandOutput extends TrustAnchorDetailRespons
44
51
  export declare class CreateTrustAnchorCommand extends $Command<CreateTrustAnchorCommandInput, CreateTrustAnchorCommandOutput, RolesAnywhereClientResolvedConfig> {
45
52
  readonly input: CreateTrustAnchorCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: CreateTrustAnchorCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RolesAnywhereClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateTrustAnchorCommandInput, CreateTrustAnchorCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CrlDetailResponse, ScalarCrlRequest } from "../models/models_0";
5
5
  import { RolesAnywhereClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RolesAnywhereClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteCrlCommand}.
8
10
  */
9
11
  export interface DeleteCrlCommandInput extends ScalarCrlRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteCrlCommand}.
13
17
  */
14
18
  export interface DeleteCrlCommandOutput extends CrlDetailResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a certificate revocation list (CRL).</p>
18
23
  * <p>
19
24
  * <b>Required permissions: </b>
@@ -29,6 +34,8 @@ export interface DeleteCrlCommandOutput extends CrlDetailResponse, __MetadataBea
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteCrlCommandInput - {@link DeleteCrlCommandInput}
38
+ * @returns {@link DeleteCrlCommandOutput}
32
39
  * @see {@link DeleteCrlCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteCrlCommandOutput} for command's `response` shape.
34
41
  * @see {@link RolesAnywhereClientResolvedConfig | config} for RolesAnywhereClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DeleteCrlCommandOutput extends CrlDetailResponse, __MetadataBea
44
51
  export declare class DeleteCrlCommand extends $Command<DeleteCrlCommandInput, DeleteCrlCommandOutput, RolesAnywhereClientResolvedConfig> {
45
52
  readonly input: DeleteCrlCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DeleteCrlCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RolesAnywhereClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteCrlCommandInput, DeleteCrlCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ProfileDetailResponse, ScalarProfileRequest } from "../models/models_0";
5
5
  import { RolesAnywhereClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RolesAnywhereClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteProfileCommand}.
8
10
  */
9
11
  export interface DeleteProfileCommandInput extends ScalarProfileRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteProfileCommand}.
13
17
  */
14
18
  export interface DeleteProfileCommandOutput extends ProfileDetailResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a profile.</p>
18
23
  * <p>
19
24
  * <b>Required permissions: </b>
@@ -29,6 +34,8 @@ export interface DeleteProfileCommandOutput extends ProfileDetailResponse, __Met
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteProfileCommandInput - {@link DeleteProfileCommandInput}
38
+ * @returns {@link DeleteProfileCommandOutput}
32
39
  * @see {@link DeleteProfileCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteProfileCommandOutput} for command's `response` shape.
34
41
  * @see {@link RolesAnywhereClientResolvedConfig | config} for RolesAnywhereClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DeleteProfileCommandOutput extends ProfileDetailResponse, __Met
44
51
  export declare class DeleteProfileCommand extends $Command<DeleteProfileCommandInput, DeleteProfileCommandOutput, RolesAnywhereClientResolvedConfig> {
45
52
  readonly input: DeleteProfileCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DeleteProfileCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RolesAnywhereClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteProfileCommandInput, DeleteProfileCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ScalarTrustAnchorRequest, TrustAnchorDetailResponse } from "../models/models_0";
5
5
  import { RolesAnywhereClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RolesAnywhereClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteTrustAnchorCommand}.
8
10
  */
9
11
  export interface DeleteTrustAnchorCommandInput extends ScalarTrustAnchorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteTrustAnchorCommand}.
13
17
  */
14
18
  export interface DeleteTrustAnchorCommandOutput extends TrustAnchorDetailResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a trust anchor.</p>
18
23
  * <p>
19
24
  * <b>Required permissions: </b>
@@ -29,6 +34,8 @@ export interface DeleteTrustAnchorCommandOutput extends TrustAnchorDetailRespons
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteTrustAnchorCommandInput - {@link DeleteTrustAnchorCommandInput}
38
+ * @returns {@link DeleteTrustAnchorCommandOutput}
32
39
  * @see {@link DeleteTrustAnchorCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteTrustAnchorCommandOutput} for command's `response` shape.
34
41
  * @see {@link RolesAnywhereClientResolvedConfig | config} for RolesAnywhereClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DeleteTrustAnchorCommandOutput extends TrustAnchorDetailRespons
44
51
  export declare class DeleteTrustAnchorCommand extends $Command<DeleteTrustAnchorCommandInput, DeleteTrustAnchorCommandOutput, RolesAnywhereClientResolvedConfig> {
45
52
  readonly input: DeleteTrustAnchorCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DeleteTrustAnchorCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RolesAnywhereClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteTrustAnchorCommandInput, DeleteTrustAnchorCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CrlDetailResponse, ScalarCrlRequest } from "../models/models_0";
5
5
  import { RolesAnywhereClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RolesAnywhereClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisableCrlCommand}.
8
10
  */
9
11
  export interface DisableCrlCommandInput extends ScalarCrlRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisableCrlCommand}.
13
17
  */
14
18
  export interface DisableCrlCommandOutput extends CrlDetailResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disables a certificate revocation list (CRL).</p>
18
23
  * <p>
19
24
  * <b>Required permissions: </b>
@@ -29,6 +34,8 @@ export interface DisableCrlCommandOutput extends CrlDetailResponse, __MetadataBe
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DisableCrlCommandInput - {@link DisableCrlCommandInput}
38
+ * @returns {@link DisableCrlCommandOutput}
32
39
  * @see {@link DisableCrlCommandInput} for command's `input` shape.
33
40
  * @see {@link DisableCrlCommandOutput} for command's `response` shape.
34
41
  * @see {@link RolesAnywhereClientResolvedConfig | config} for RolesAnywhereClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DisableCrlCommandOutput extends CrlDetailResponse, __MetadataBe
44
51
  export declare class DisableCrlCommand extends $Command<DisableCrlCommandInput, DisableCrlCommandOutput, RolesAnywhereClientResolvedConfig> {
45
52
  readonly input: DisableCrlCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DisableCrlCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RolesAnywhereClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableCrlCommandInput, DisableCrlCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ProfileDetailResponse, ScalarProfileRequest } from "../models/models_0";
5
5
  import { RolesAnywhereClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RolesAnywhereClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisableProfileCommand}.
8
10
  */
9
11
  export interface DisableProfileCommandInput extends ScalarProfileRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisableProfileCommand}.
13
17
  */
14
18
  export interface DisableProfileCommandOutput extends ProfileDetailResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disables a profile. When disabled, <a href="https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html">CreateSession</a> requests with this profile fail.</p>
18
23
  * <p>
19
24
  * <b>Required permissions: </b>
@@ -29,6 +34,8 @@ export interface DisableProfileCommandOutput extends ProfileDetailResponse, __Me
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DisableProfileCommandInput - {@link DisableProfileCommandInput}
38
+ * @returns {@link DisableProfileCommandOutput}
32
39
  * @see {@link DisableProfileCommandInput} for command's `input` shape.
33
40
  * @see {@link DisableProfileCommandOutput} for command's `response` shape.
34
41
  * @see {@link RolesAnywhereClientResolvedConfig | config} for RolesAnywhereClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DisableProfileCommandOutput extends ProfileDetailResponse, __Me
44
51
  export declare class DisableProfileCommand extends $Command<DisableProfileCommandInput, DisableProfileCommandOutput, RolesAnywhereClientResolvedConfig> {
45
52
  readonly input: DisableProfileCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DisableProfileCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RolesAnywhereClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableProfileCommandInput, DisableProfileCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }