@aws-sdk/client-ram 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 (42) hide show
  1. package/dist-types/RAM.d.ts +26 -0
  2. package/dist-types/RAMClient.d.ts +24 -4
  3. package/dist-types/commands/AcceptResourceShareInvitationCommand.d.ts +16 -0
  4. package/dist-types/commands/AssociateResourceShareCommand.d.ts +16 -0
  5. package/dist-types/commands/AssociateResourceSharePermissionCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateResourceShareCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteResourceShareCommand.d.ts +16 -0
  8. package/dist-types/commands/DisassociateResourceShareCommand.d.ts +16 -0
  9. package/dist-types/commands/DisassociateResourceSharePermissionCommand.d.ts +16 -0
  10. package/dist-types/commands/EnableSharingWithAwsOrganizationCommand.d.ts +16 -0
  11. package/dist-types/commands/GetPermissionCommand.d.ts +16 -0
  12. package/dist-types/commands/GetResourcePoliciesCommand.d.ts +16 -0
  13. package/dist-types/commands/GetResourceShareAssociationsCommand.d.ts +16 -0
  14. package/dist-types/commands/GetResourceShareInvitationsCommand.d.ts +16 -0
  15. package/dist-types/commands/GetResourceSharesCommand.d.ts +16 -0
  16. package/dist-types/commands/ListPendingInvitationResourcesCommand.d.ts +16 -0
  17. package/dist-types/commands/ListPermissionVersionsCommand.d.ts +16 -0
  18. package/dist-types/commands/ListPermissionsCommand.d.ts +16 -0
  19. package/dist-types/commands/ListPrincipalsCommand.d.ts +16 -0
  20. package/dist-types/commands/ListResourceSharePermissionsCommand.d.ts +16 -0
  21. package/dist-types/commands/ListResourceTypesCommand.d.ts +16 -0
  22. package/dist-types/commands/ListResourcesCommand.d.ts +16 -0
  23. package/dist-types/commands/PromoteResourceShareCreatedFromPolicyCommand.d.ts +16 -0
  24. package/dist-types/commands/RejectResourceShareInvitationCommand.d.ts +16 -0
  25. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  26. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdateResourceShareCommand.d.ts +16 -0
  28. package/dist-types/models/RAMServiceException.d.ts +2 -0
  29. package/dist-types/models/models_0.d.ts +209 -0
  30. package/dist-types/pagination/GetResourcePoliciesPaginator.d.ts +3 -0
  31. package/dist-types/pagination/GetResourceShareAssociationsPaginator.d.ts +3 -0
  32. package/dist-types/pagination/GetResourceShareInvitationsPaginator.d.ts +3 -0
  33. package/dist-types/pagination/GetResourceSharesPaginator.d.ts +3 -0
  34. package/dist-types/pagination/Interfaces.d.ts +3 -0
  35. package/dist-types/pagination/ListPendingInvitationResourcesPaginator.d.ts +3 -0
  36. package/dist-types/pagination/ListPermissionVersionsPaginator.d.ts +3 -0
  37. package/dist-types/pagination/ListPermissionsPaginator.d.ts +3 -0
  38. package/dist-types/pagination/ListPrincipalsPaginator.d.ts +3 -0
  39. package/dist-types/pagination/ListResourceSharePermissionsPaginator.d.ts +3 -0
  40. package/dist-types/pagination/ListResourceTypesPaginator.d.ts +3 -0
  41. package/dist-types/pagination/ListResourcesPaginator.d.ts +3 -0
  42. package/package.json +29 -29
@@ -26,6 +26,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
26
26
  import { UpdateResourceShareCommandInput, UpdateResourceShareCommandOutput } from "./commands/UpdateResourceShareCommand";
27
27
  import { RAMClient } from "./RAMClient";
28
28
  /**
29
+ * @public
29
30
  * <p>This is the <i>Resource Access Manager API Reference</i>. This documentation provides
30
31
  * descriptions and syntax for each of the actions and data types in RAM. RAM is a
31
32
  * service that helps you securely share your Amazon Web Services resources across Amazon Web Services accounts. If you
@@ -50,6 +51,7 @@ import { RAMClient } from "./RAMClient";
50
51
  */
51
52
  export declare class RAM extends RAMClient {
52
53
  /**
54
+ * @public
53
55
  * <p>Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the
54
56
  * invitation, the resources included in the resource share are available to interact with in the
55
57
  * relevant Amazon Web Services Management Consoles and tools.</p>
@@ -58,6 +60,7 @@ export declare class RAM extends RAMClient {
58
60
  acceptResourceShareInvitation(args: AcceptResourceShareInvitationCommandInput, cb: (err: any, data?: AcceptResourceShareInvitationCommandOutput) => void): void;
59
61
  acceptResourceShareInvitation(args: AcceptResourceShareInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptResourceShareInvitationCommandOutput) => void): void;
60
62
  /**
63
+ * @public
61
64
  * <p>Adds the specified list of principals and list of resources to a resource share. Principals that
62
65
  * already have access to this resource share immediately receive access to the added resources.
63
66
  * Newly added principals immediately receive access to the resources shared in this resource share. </p>
@@ -66,6 +69,7 @@ export declare class RAM extends RAMClient {
66
69
  associateResourceShare(args: AssociateResourceShareCommandInput, cb: (err: any, data?: AssociateResourceShareCommandOutput) => void): void;
67
70
  associateResourceShare(args: AssociateResourceShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateResourceShareCommandOutput) => void): void;
68
71
  /**
72
+ * @public
69
73
  * <p>Adds or replaces the RAM permission for a resource type included in a resource share. You can
70
74
  * have exactly one permission associated with each resource type in the resource share. You can add
71
75
  * a new RAM permission only if there are currently no resources of that resource type
@@ -75,6 +79,7 @@ export declare class RAM extends RAMClient {
75
79
  associateResourceSharePermission(args: AssociateResourceSharePermissionCommandInput, cb: (err: any, data?: AssociateResourceSharePermissionCommandOutput) => void): void;
76
80
  associateResourceSharePermission(args: AssociateResourceSharePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateResourceSharePermissionCommandOutput) => void): void;
77
81
  /**
82
+ * @public
78
83
  * <p>Creates a resource share. You can provide a list of the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> for the resources that you
79
84
  * want to share, a list of principals you want to share the resources with, and the
80
85
  * permissions to grant those principals.</p>
@@ -88,6 +93,7 @@ export declare class RAM extends RAMClient {
88
93
  createResourceShare(args: CreateResourceShareCommandInput, cb: (err: any, data?: CreateResourceShareCommandOutput) => void): void;
89
94
  createResourceShare(args: CreateResourceShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceShareCommandOutput) => void): void;
90
95
  /**
96
+ * @public
91
97
  * <p>Deletes the specified resource share. This doesn't delete any of the resources that were
92
98
  * associated with the resource share; it only stops the sharing of those resources outside of the
93
99
  * Amazon Web Services account that created them.</p>
@@ -96,12 +102,14 @@ export declare class RAM extends RAMClient {
96
102
  deleteResourceShare(args: DeleteResourceShareCommandInput, cb: (err: any, data?: DeleteResourceShareCommandOutput) => void): void;
97
103
  deleteResourceShare(args: DeleteResourceShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceShareCommandOutput) => void): void;
98
104
  /**
105
+ * @public
99
106
  * <p>Disassociates the specified principals or resources from the specified resource share.</p>
100
107
  */
101
108
  disassociateResourceShare(args: DisassociateResourceShareCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateResourceShareCommandOutput>;
102
109
  disassociateResourceShare(args: DisassociateResourceShareCommandInput, cb: (err: any, data?: DisassociateResourceShareCommandOutput) => void): void;
103
110
  disassociateResourceShare(args: DisassociateResourceShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateResourceShareCommandOutput) => void): void;
104
111
  /**
112
+ * @public
105
113
  * <p>Disassociates an RAM permission from a resource share. Permission changes take effect
106
114
  * immediately. You can remove a RAM permission from a resource share only if there are currently
107
115
  * no resources of the relevant resource type currently attached to the resource share.</p>
@@ -110,6 +118,7 @@ export declare class RAM extends RAMClient {
110
118
  disassociateResourceSharePermission(args: DisassociateResourceSharePermissionCommandInput, cb: (err: any, data?: DisassociateResourceSharePermissionCommandOutput) => void): void;
111
119
  disassociateResourceSharePermission(args: DisassociateResourceSharePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateResourceSharePermissionCommandOutput) => void): void;
112
120
  /**
121
+ * @public
113
122
  * <p>Enables resource sharing within your organization in Organizations. Calling this operation
114
123
  * enables RAM to retrieve information about the organization and its structure. This
115
124
  * lets you share resources with all of the accounts in an organization by specifying the
@@ -124,12 +133,14 @@ export declare class RAM extends RAMClient {
124
133
  enableSharingWithAwsOrganization(args: EnableSharingWithAwsOrganizationCommandInput, cb: (err: any, data?: EnableSharingWithAwsOrganizationCommandOutput) => void): void;
125
134
  enableSharingWithAwsOrganization(args: EnableSharingWithAwsOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableSharingWithAwsOrganizationCommandOutput) => void): void;
126
135
  /**
136
+ * @public
127
137
  * <p>Gets the contents of an RAM permission in JSON format.</p>
128
138
  */
129
139
  getPermission(args: GetPermissionCommandInput, options?: __HttpHandlerOptions): Promise<GetPermissionCommandOutput>;
130
140
  getPermission(args: GetPermissionCommandInput, cb: (err: any, data?: GetPermissionCommandOutput) => void): void;
131
141
  getPermission(args: GetPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPermissionCommandOutput) => void): void;
132
142
  /**
143
+ * @public
133
144
  * <p>Retrieves the resource policies for the specified resources that you own and have
134
145
  * shared.</p>
135
146
  */
@@ -137,24 +148,28 @@ export declare class RAM extends RAMClient {
137
148
  getResourcePolicies(args: GetResourcePoliciesCommandInput, cb: (err: any, data?: GetResourcePoliciesCommandOutput) => void): void;
138
149
  getResourcePolicies(args: GetResourcePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePoliciesCommandOutput) => void): void;
139
150
  /**
151
+ * @public
140
152
  * <p>Retrieves the resource and principal associations for resource shares that you own.</p>
141
153
  */
142
154
  getResourceShareAssociations(args: GetResourceShareAssociationsCommandInput, options?: __HttpHandlerOptions): Promise<GetResourceShareAssociationsCommandOutput>;
143
155
  getResourceShareAssociations(args: GetResourceShareAssociationsCommandInput, cb: (err: any, data?: GetResourceShareAssociationsCommandOutput) => void): void;
144
156
  getResourceShareAssociations(args: GetResourceShareAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceShareAssociationsCommandOutput) => void): void;
145
157
  /**
158
+ * @public
146
159
  * <p>Retrieves details about invitations that you have received for resource shares.</p>
147
160
  */
148
161
  getResourceShareInvitations(args: GetResourceShareInvitationsCommandInput, options?: __HttpHandlerOptions): Promise<GetResourceShareInvitationsCommandOutput>;
149
162
  getResourceShareInvitations(args: GetResourceShareInvitationsCommandInput, cb: (err: any, data?: GetResourceShareInvitationsCommandOutput) => void): void;
150
163
  getResourceShareInvitations(args: GetResourceShareInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceShareInvitationsCommandOutput) => void): void;
151
164
  /**
165
+ * @public
152
166
  * <p>Retrieves details about the resource shares that you own or that are shared with you.</p>
153
167
  */
154
168
  getResourceShares(args: GetResourceSharesCommandInput, options?: __HttpHandlerOptions): Promise<GetResourceSharesCommandOutput>;
155
169
  getResourceShares(args: GetResourceSharesCommandInput, cb: (err: any, data?: GetResourceSharesCommandOutput) => void): void;
156
170
  getResourceShares(args: GetResourceSharesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceSharesCommandOutput) => void): void;
157
171
  /**
172
+ * @public
158
173
  * <p>Lists the resources in a resource share that is shared with you but for which the invitation is
159
174
  * still <code>PENDING</code>. That means that you haven't accepted or rejected the
160
175
  * invitation and the invitation hasn't expired.</p>
@@ -163,6 +178,7 @@ export declare class RAM extends RAMClient {
163
178
  listPendingInvitationResources(args: ListPendingInvitationResourcesCommandInput, cb: (err: any, data?: ListPendingInvitationResourcesCommandOutput) => void): void;
164
179
  listPendingInvitationResources(args: ListPendingInvitationResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPendingInvitationResourcesCommandOutput) => void): void;
165
180
  /**
181
+ * @public
166
182
  * <p>Retrieves a list of available RAM permissions that you can use for the supported
167
183
  * resource types. </p>
168
184
  */
@@ -170,12 +186,14 @@ export declare class RAM extends RAMClient {
170
186
  listPermissions(args: ListPermissionsCommandInput, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void;
171
187
  listPermissions(args: ListPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void;
172
188
  /**
189
+ * @public
173
190
  * <p>Lists the available versions of the specified RAM permission.</p>
174
191
  */
175
192
  listPermissionVersions(args: ListPermissionVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListPermissionVersionsCommandOutput>;
176
193
  listPermissionVersions(args: ListPermissionVersionsCommandInput, cb: (err: any, data?: ListPermissionVersionsCommandOutput) => void): void;
177
194
  listPermissionVersions(args: ListPermissionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionVersionsCommandOutput) => void): void;
178
195
  /**
196
+ * @public
179
197
  * <p>Lists the principals that you are sharing resources with or that are sharing resources
180
198
  * with you.</p>
181
199
  */
@@ -183,6 +201,7 @@ export declare class RAM extends RAMClient {
183
201
  listPrincipals(args: ListPrincipalsCommandInput, cb: (err: any, data?: ListPrincipalsCommandOutput) => void): void;
184
202
  listPrincipals(args: ListPrincipalsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPrincipalsCommandOutput) => void): void;
185
203
  /**
204
+ * @public
186
205
  * <p>Lists the resources that you added to a resource share or the resources that are shared with
187
206
  * you.</p>
188
207
  */
@@ -190,18 +209,21 @@ export declare class RAM extends RAMClient {
190
209
  listResources(args: ListResourcesCommandInput, cb: (err: any, data?: ListResourcesCommandOutput) => void): void;
191
210
  listResources(args: ListResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesCommandOutput) => void): void;
192
211
  /**
212
+ * @public
193
213
  * <p>Lists the RAM permissions that are associated with a resource share.</p>
194
214
  */
195
215
  listResourceSharePermissions(args: ListResourceSharePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<ListResourceSharePermissionsCommandOutput>;
196
216
  listResourceSharePermissions(args: ListResourceSharePermissionsCommandInput, cb: (err: any, data?: ListResourceSharePermissionsCommandOutput) => void): void;
197
217
  listResourceSharePermissions(args: ListResourceSharePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceSharePermissionsCommandOutput) => void): void;
198
218
  /**
219
+ * @public
199
220
  * <p>Lists the resource types that can be shared by RAM.</p>
200
221
  */
201
222
  listResourceTypes(args: ListResourceTypesCommandInput, options?: __HttpHandlerOptions): Promise<ListResourceTypesCommandOutput>;
202
223
  listResourceTypes(args: ListResourceTypesCommandInput, cb: (err: any, data?: ListResourceTypesCommandOutput) => void): void;
203
224
  listResourceTypes(args: ListResourceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceTypesCommandOutput) => void): void;
204
225
  /**
226
+ * @public
205
227
  * <p>When you attach a resource-based permission policy to a resource, it automatically
206
228
  * creates a resource share. However, resource shares created this way are visible only to the resource share owner, and
207
229
  * the resource share can't be modified in RAM.</p>
@@ -213,12 +235,14 @@ export declare class RAM extends RAMClient {
213
235
  promoteResourceShareCreatedFromPolicy(args: PromoteResourceShareCreatedFromPolicyCommandInput, cb: (err: any, data?: PromoteResourceShareCreatedFromPolicyCommandOutput) => void): void;
214
236
  promoteResourceShareCreatedFromPolicy(args: PromoteResourceShareCreatedFromPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PromoteResourceShareCreatedFromPolicyCommandOutput) => void): void;
215
237
  /**
238
+ * @public
216
239
  * <p>Rejects an invitation to a resource share from another Amazon Web Services account.</p>
217
240
  */
218
241
  rejectResourceShareInvitation(args: RejectResourceShareInvitationCommandInput, options?: __HttpHandlerOptions): Promise<RejectResourceShareInvitationCommandOutput>;
219
242
  rejectResourceShareInvitation(args: RejectResourceShareInvitationCommandInput, cb: (err: any, data?: RejectResourceShareInvitationCommandOutput) => void): void;
220
243
  rejectResourceShareInvitation(args: RejectResourceShareInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectResourceShareInvitationCommandOutput) => void): void;
221
244
  /**
245
+ * @public
222
246
  * <p>Adds the specified tag keys and values to the specified resource share. The tags are attached
223
247
  * only to the resource share, not to the resources that are in the resource share.</p>
224
248
  */
@@ -226,12 +250,14 @@ export declare class RAM extends RAMClient {
226
250
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
227
251
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
228
252
  /**
253
+ * @public
229
254
  * <p>Removes the specified tag key and value pairs from the specified resource share.</p>
230
255
  */
231
256
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
232
257
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
233
258
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
234
259
  /**
260
+ * @public
235
261
  * <p>Modifies some of the properties of the specified resource share.</p>
236
262
  */
237
263
  updateResourceShare(args: UpdateResourceShareCommandInput, options?: __HttpHandlerOptions): Promise<UpdateResourceShareCommandOutput>;
@@ -33,15 +33,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
33
33
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
34
34
  import { UpdateResourceShareCommandInput, UpdateResourceShareCommandOutput } from "./commands/UpdateResourceShareCommand";
35
35
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
36
+ /**
37
+ * @public
38
+ */
36
39
  export type ServiceInputTypes = AcceptResourceShareInvitationCommandInput | AssociateResourceShareCommandInput | AssociateResourceSharePermissionCommandInput | CreateResourceShareCommandInput | DeleteResourceShareCommandInput | DisassociateResourceShareCommandInput | DisassociateResourceSharePermissionCommandInput | EnableSharingWithAwsOrganizationCommandInput | GetPermissionCommandInput | GetResourcePoliciesCommandInput | GetResourceShareAssociationsCommandInput | GetResourceShareInvitationsCommandInput | GetResourceSharesCommandInput | ListPendingInvitationResourcesCommandInput | ListPermissionVersionsCommandInput | ListPermissionsCommandInput | ListPrincipalsCommandInput | ListResourceSharePermissionsCommandInput | ListResourceTypesCommandInput | ListResourcesCommandInput | PromoteResourceShareCreatedFromPolicyCommandInput | RejectResourceShareInvitationCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateResourceShareCommandInput;
40
+ /**
41
+ * @public
42
+ */
37
43
  export type ServiceOutputTypes = AcceptResourceShareInvitationCommandOutput | AssociateResourceShareCommandOutput | AssociateResourceSharePermissionCommandOutput | CreateResourceShareCommandOutput | DeleteResourceShareCommandOutput | DisassociateResourceShareCommandOutput | DisassociateResourceSharePermissionCommandOutput | EnableSharingWithAwsOrganizationCommandOutput | GetPermissionCommandOutput | GetResourcePoliciesCommandOutput | GetResourceShareAssociationsCommandOutput | GetResourceShareInvitationsCommandOutput | GetResourceSharesCommandOutput | ListPendingInvitationResourcesCommandOutput | ListPermissionVersionsCommandOutput | ListPermissionsCommandOutput | ListPrincipalsCommandOutput | ListResourceSharePermissionsCommandOutput | ListResourceTypesCommandOutput | ListResourcesCommandOutput | PromoteResourceShareCreatedFromPolicyCommandOutput | RejectResourceShareInvitationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateResourceShareCommandOutput;
44
+ /**
45
+ * @public
46
+ */
38
47
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
39
48
  /**
40
49
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
41
50
  */
42
51
  requestHandler?: __HttpHandler;
43
52
  /**
44
- * A constructor for a class implementing the {@link __Checksum} interface
53
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
45
54
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
46
55
  * @internal
47
56
  */
@@ -131,23 +140,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
131
140
  */
132
141
  logger?: __Logger;
133
142
  /**
134
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
143
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
135
144
  */
136
145
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
137
146
  }
147
+ /**
148
+ * @public
149
+ */
138
150
  type RAMClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
139
151
  /**
140
- * The configuration interface of RAMClient class constructor that set the region, credentials and other options.
152
+ * @public
153
+ *
154
+ * The configuration interface of RAMClient class constructor that set the region, credentials and other options.
141
155
  */
142
156
  export interface RAMClientConfig extends RAMClientConfigType {
143
157
  }
158
+ /**
159
+ * @public
160
+ */
144
161
  type RAMClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
145
162
  /**
146
- * The resolved configuration interface of RAMClient class. This is resolved and normalized from the {@link RAMClientConfig | constructor configuration interface}.
163
+ * @public
164
+ *
165
+ * The resolved configuration interface of RAMClient class. This is resolved and normalized from the {@link RAMClientConfig | constructor configuration interface}.
147
166
  */
148
167
  export interface RAMClientResolvedConfig extends RAMClientResolvedConfigType {
149
168
  }
150
169
  /**
170
+ * @public
151
171
  * <p>This is the <i>Resource Access Manager API Reference</i>. This documentation provides
152
172
  * descriptions and syntax for each of the actions and data types in RAM. RAM is a
153
173
  * service that helps you securely share your Amazon Web Services resources across Amazon Web Services accounts. If you
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AcceptResourceShareInvitationRequest, AcceptResourceShareInvitationResponse } from "../models/models_0";
5
5
  import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AcceptResourceShareInvitationCommand}.
8
10
  */
9
11
  export interface AcceptResourceShareInvitationCommandInput extends AcceptResourceShareInvitationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AcceptResourceShareInvitationCommand}.
13
17
  */
14
18
  export interface AcceptResourceShareInvitationCommandOutput extends AcceptResourceShareInvitationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the
18
23
  * invitation, the resources included in the resource share are available to interact with in the
19
24
  * relevant Amazon Web Services Management Consoles and tools.</p>
@@ -27,6 +32,8 @@ export interface AcceptResourceShareInvitationCommandOutput extends AcceptResour
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param AcceptResourceShareInvitationCommandInput - {@link AcceptResourceShareInvitationCommandInput}
36
+ * @returns {@link AcceptResourceShareInvitationCommandOutput}
30
37
  * @see {@link AcceptResourceShareInvitationCommandInput} for command's `input` shape.
31
38
  * @see {@link AcceptResourceShareInvitationCommandOutput} for command's `response` shape.
32
39
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
@@ -68,11 +75,20 @@ export interface AcceptResourceShareInvitationCommandOutput extends AcceptResour
68
75
  export declare class AcceptResourceShareInvitationCommand extends $Command<AcceptResourceShareInvitationCommandInput, AcceptResourceShareInvitationCommandOutput, RAMClientResolvedConfig> {
69
76
  readonly input: AcceptResourceShareInvitationCommandInput;
70
77
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
78
+ /**
79
+ * @public
80
+ */
71
81
  constructor(input: AcceptResourceShareInvitationCommandInput);
72
82
  /**
73
83
  * @internal
74
84
  */
75
85
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AcceptResourceShareInvitationCommandInput, AcceptResourceShareInvitationCommandOutput>;
86
+ /**
87
+ * @internal
88
+ */
76
89
  private serialize;
90
+ /**
91
+ * @internal
92
+ */
77
93
  private deserialize;
78
94
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AssociateResourceShareRequest, AssociateResourceShareResponse } from "../models/models_0";
5
5
  import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssociateResourceShareCommand}.
8
10
  */
9
11
  export interface AssociateResourceShareCommandInput extends AssociateResourceShareRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssociateResourceShareCommand}.
13
17
  */
14
18
  export interface AssociateResourceShareCommandOutput extends AssociateResourceShareResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds the specified list of principals and list of resources to a resource share. Principals that
18
23
  * already have access to this resource share immediately receive access to the added resources.
19
24
  * Newly added principals immediately receive access to the resources shared in this resource share. </p>
@@ -27,6 +32,8 @@ export interface AssociateResourceShareCommandOutput extends AssociateResourceSh
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param AssociateResourceShareCommandInput - {@link AssociateResourceShareCommandInput}
36
+ * @returns {@link AssociateResourceShareCommandOutput}
30
37
  * @see {@link AssociateResourceShareCommandInput} for command's `input` shape.
31
38
  * @see {@link AssociateResourceShareCommandOutput} for command's `response` shape.
32
39
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
@@ -72,11 +79,20 @@ export interface AssociateResourceShareCommandOutput extends AssociateResourceSh
72
79
  export declare class AssociateResourceShareCommand extends $Command<AssociateResourceShareCommandInput, AssociateResourceShareCommandOutput, RAMClientResolvedConfig> {
73
80
  readonly input: AssociateResourceShareCommandInput;
74
81
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
82
+ /**
83
+ * @public
84
+ */
75
85
  constructor(input: AssociateResourceShareCommandInput);
76
86
  /**
77
87
  * @internal
78
88
  */
79
89
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateResourceShareCommandInput, AssociateResourceShareCommandOutput>;
90
+ /**
91
+ * @internal
92
+ */
80
93
  private serialize;
94
+ /**
95
+ * @internal
96
+ */
81
97
  private deserialize;
82
98
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AssociateResourceSharePermissionRequest, AssociateResourceSharePermissionResponse } from "../models/models_0";
5
5
  import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssociateResourceSharePermissionCommand}.
8
10
  */
9
11
  export interface AssociateResourceSharePermissionCommandInput extends AssociateResourceSharePermissionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssociateResourceSharePermissionCommand}.
13
17
  */
14
18
  export interface AssociateResourceSharePermissionCommandOutput extends AssociateResourceSharePermissionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds or replaces the RAM permission for a resource type included in a resource share. You can
18
23
  * have exactly one permission associated with each resource type in the resource share. You can add
19
24
  * a new RAM permission only if there are currently no resources of that resource type
@@ -28,6 +33,8 @@ export interface AssociateResourceSharePermissionCommandOutput extends Associate
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param AssociateResourceSharePermissionCommandInput - {@link AssociateResourceSharePermissionCommandInput}
37
+ * @returns {@link AssociateResourceSharePermissionCommandOutput}
31
38
  * @see {@link AssociateResourceSharePermissionCommandInput} for command's `input` shape.
32
39
  * @see {@link AssociateResourceSharePermissionCommandOutput} for command's `response` shape.
33
40
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
@@ -58,11 +65,20 @@ export interface AssociateResourceSharePermissionCommandOutput extends Associate
58
65
  export declare class AssociateResourceSharePermissionCommand extends $Command<AssociateResourceSharePermissionCommandInput, AssociateResourceSharePermissionCommandOutput, RAMClientResolvedConfig> {
59
66
  readonly input: AssociateResourceSharePermissionCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: AssociateResourceSharePermissionCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateResourceSharePermissionCommandInput, AssociateResourceSharePermissionCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateResourceShareRequest, CreateResourceShareResponse } from "../models/models_0";
5
5
  import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateResourceShareCommand}.
8
10
  */
9
11
  export interface CreateResourceShareCommandInput extends CreateResourceShareRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateResourceShareCommand}.
13
17
  */
14
18
  export interface CreateResourceShareCommandOutput extends CreateResourceShareResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a resource share. You can provide a list of the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> for the resources that you
18
23
  * want to share, a list of principals you want to share the resources with, and the
19
24
  * permissions to grant those principals.</p>
@@ -32,6 +37,8 @@ export interface CreateResourceShareCommandOutput extends CreateResourceShareRes
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param CreateResourceShareCommandInput - {@link CreateResourceShareCommandInput}
41
+ * @returns {@link CreateResourceShareCommandOutput}
35
42
  * @see {@link CreateResourceShareCommandInput} for command's `input` shape.
36
43
  * @see {@link CreateResourceShareCommandOutput} for command's `response` shape.
37
44
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
@@ -76,11 +83,20 @@ export interface CreateResourceShareCommandOutput extends CreateResourceShareRes
76
83
  export declare class CreateResourceShareCommand extends $Command<CreateResourceShareCommandInput, CreateResourceShareCommandOutput, RAMClientResolvedConfig> {
77
84
  readonly input: CreateResourceShareCommandInput;
78
85
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
86
+ /**
87
+ * @public
88
+ */
79
89
  constructor(input: CreateResourceShareCommandInput);
80
90
  /**
81
91
  * @internal
82
92
  */
83
93
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateResourceShareCommandInput, CreateResourceShareCommandOutput>;
94
+ /**
95
+ * @internal
96
+ */
84
97
  private serialize;
98
+ /**
99
+ * @internal
100
+ */
85
101
  private deserialize;
86
102
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteResourceShareRequest, DeleteResourceShareResponse } from "../models/models_0";
5
5
  import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteResourceShareCommand}.
8
10
  */
9
11
  export interface DeleteResourceShareCommandInput extends DeleteResourceShareRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteResourceShareCommand}.
13
17
  */
14
18
  export interface DeleteResourceShareCommandOutput extends DeleteResourceShareResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified resource share. This doesn't delete any of the resources that were
18
23
  * associated with the resource share; it only stops the sharing of those resources outside of the
19
24
  * Amazon Web Services account that created them.</p>
@@ -27,6 +32,8 @@ export interface DeleteResourceShareCommandOutput extends DeleteResourceShareRes
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DeleteResourceShareCommandInput - {@link DeleteResourceShareCommandInput}
36
+ * @returns {@link DeleteResourceShareCommandOutput}
30
37
  * @see {@link DeleteResourceShareCommandInput} for command's `input` shape.
31
38
  * @see {@link DeleteResourceShareCommandOutput} for command's `response` shape.
32
39
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
@@ -65,11 +72,20 @@ export interface DeleteResourceShareCommandOutput extends DeleteResourceShareRes
65
72
  export declare class DeleteResourceShareCommand extends $Command<DeleteResourceShareCommandInput, DeleteResourceShareCommandOutput, RAMClientResolvedConfig> {
66
73
  readonly input: DeleteResourceShareCommandInput;
67
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
68
78
  constructor(input: DeleteResourceShareCommandInput);
69
79
  /**
70
80
  * @internal
71
81
  */
72
82
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteResourceShareCommandInput, DeleteResourceShareCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
73
86
  private serialize;
87
+ /**
88
+ * @internal
89
+ */
74
90
  private deserialize;
75
91
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DisassociateResourceShareRequest, DisassociateResourceShareResponse } from "../models/models_0";
5
5
  import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisassociateResourceShareCommand}.
8
10
  */
9
11
  export interface DisassociateResourceShareCommandInput extends DisassociateResourceShareRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisassociateResourceShareCommand}.
13
17
  */
14
18
  export interface DisassociateResourceShareCommandOutput extends DisassociateResourceShareResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disassociates the specified principals or resources from the specified resource share.</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 DisassociateResourceShareCommandOutput extends DisassociateReso
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DisassociateResourceShareCommandInput - {@link DisassociateResourceShareCommandInput}
34
+ * @returns {@link DisassociateResourceShareCommandOutput}
28
35
  * @see {@link DisassociateResourceShareCommandInput} for command's `input` shape.
29
36
  * @see {@link DisassociateResourceShareCommandOutput} for command's `response` shape.
30
37
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
@@ -66,11 +73,20 @@ export interface DisassociateResourceShareCommandOutput extends DisassociateReso
66
73
  export declare class DisassociateResourceShareCommand extends $Command<DisassociateResourceShareCommandInput, DisassociateResourceShareCommandOutput, RAMClientResolvedConfig> {
67
74
  readonly input: DisassociateResourceShareCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: DisassociateResourceShareCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateResourceShareCommandInput, DisassociateResourceShareCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DisassociateResourceSharePermissionRequest, DisassociateResourceSharePermissionResponse } from "../models/models_0";
5
5
  import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisassociateResourceSharePermissionCommand}.
8
10
  */
9
11
  export interface DisassociateResourceSharePermissionCommandInput extends DisassociateResourceSharePermissionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisassociateResourceSharePermissionCommand}.
13
17
  */
14
18
  export interface DisassociateResourceSharePermissionCommandOutput extends DisassociateResourceSharePermissionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disassociates an RAM permission from a resource share. Permission changes take effect
18
23
  * immediately. You can remove a RAM permission from a resource share only if there are currently
19
24
  * no resources of the relevant resource type currently attached to the resource share.</p>
@@ -27,6 +32,8 @@ export interface DisassociateResourceSharePermissionCommandOutput extends Disass
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DisassociateResourceSharePermissionCommandInput - {@link DisassociateResourceSharePermissionCommandInput}
36
+ * @returns {@link DisassociateResourceSharePermissionCommandOutput}
30
37
  * @see {@link DisassociateResourceSharePermissionCommandInput} for command's `input` shape.
31
38
  * @see {@link DisassociateResourceSharePermissionCommandOutput} for command's `response` shape.
32
39
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DisassociateResourceSharePermissionCommandOutput extends Disass
60
67
  export declare class DisassociateResourceSharePermissionCommand extends $Command<DisassociateResourceSharePermissionCommandInput, DisassociateResourceSharePermissionCommandOutput, RAMClientResolvedConfig> {
61
68
  readonly input: DisassociateResourceSharePermissionCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DisassociateResourceSharePermissionCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateResourceSharePermissionCommandInput, DisassociateResourceSharePermissionCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }