@aws-sdk/client-ram 3.43.0 → 3.47.1
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.
- package/CHANGELOG.md +47 -0
- package/README.md +5 -6
- package/dist-cjs/endpoints.js +1 -20
- package/dist-cjs/models/models_0.js +13 -128
- package/dist-cjs/protocols/Aws_restJson1.js +29 -0
- package/dist-cjs/runtimeConfig.browser.js +7 -2
- package/dist-cjs/runtimeConfig.js +9 -3
- package/dist-es/endpoints.js +1 -20
- package/dist-es/models/models_0.js +11 -84
- package/dist-es/protocols/Aws_restJson1.js +65 -36
- package/dist-es/runtimeConfig.browser.js +12 -3
- package/dist-es/runtimeConfig.js +13 -6
- package/dist-types/RAM.d.ts +55 -41
- package/dist-types/RAMClient.d.ts +10 -7
- package/dist-types/commands/AcceptResourceShareInvitationCommand.d.ts +3 -1
- package/dist-types/commands/AssociateResourceShareCommand.d.ts +3 -1
- package/dist-types/commands/AssociateResourceSharePermissionCommand.d.ts +4 -1
- package/dist-types/commands/CreateResourceShareCommand.d.ts +3 -3
- package/dist-types/commands/DeleteResourceShareCommand.d.ts +3 -1
- package/dist-types/commands/DisassociateResourceSharePermissionCommand.d.ts +3 -1
- package/dist-types/commands/EnableSharingWithAwsOrganizationCommand.d.ts +9 -2
- package/dist-types/commands/GetResourcePoliciesCommand.d.ts +2 -1
- package/dist-types/commands/GetResourceShareAssociationsCommand.d.ts +1 -1
- package/dist-types/commands/GetResourceShareInvitationsCommand.d.ts +1 -1
- package/dist-types/commands/GetResourceSharesCommand.d.ts +1 -1
- package/dist-types/commands/ListPendingInvitationResourcesCommand.d.ts +3 -2
- package/dist-types/commands/ListPermissionsCommand.d.ts +2 -1
- package/dist-types/commands/ListPrincipalsCommand.d.ts +1 -1
- package/dist-types/commands/ListResourceTypesCommand.d.ts +1 -1
- package/dist-types/commands/PromoteResourceShareCreatedFromPolicyCommand.d.ts +6 -13
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateResourceShareCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +841 -388
- package/dist-types/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/runtimeConfig.d.ts +4 -3
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/ts3.4/RAMClient.d.ts +3 -1
- package/dist-types/ts3.4/models/models_0.d.ts +24 -83
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
- package/package.json +39 -46
package/dist-types/RAM.d.ts
CHANGED
|
@@ -27,14 +27,13 @@ import { RAMClient } from "./RAMClient";
|
|
|
27
27
|
/**
|
|
28
28
|
* <p>This is the <i>Resource Access Manager API Reference</i>. This documentation provides
|
|
29
29
|
* descriptions and syntax for each of the actions and data types in RAM. RAM is a
|
|
30
|
-
* service that helps you securely share your Amazon Web Services resources across Amazon Web Services accounts
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
30
|
+
* service that helps you securely share your Amazon Web Services resources across Amazon Web Services accounts. If you
|
|
31
|
+
* have multiple Amazon Web Services accounts, you can use RAM to share those resources with other
|
|
32
|
+
* accounts. If you use Organizations to manage your accounts, then you share your resources
|
|
33
|
+
* with your organization or organizational units (OUs). For supported resource types, you
|
|
34
|
+
* can also share resources with individual Identity and Access Management (IAM) roles an users. </p>
|
|
35
35
|
*
|
|
36
36
|
* <p>To learn more about RAM, see the following resources:</p>
|
|
37
|
-
*
|
|
38
37
|
* <ul>
|
|
39
38
|
* <li>
|
|
40
39
|
* <p>
|
|
@@ -51,27 +50,34 @@ import { RAMClient } from "./RAMClient";
|
|
|
51
50
|
*/
|
|
52
51
|
export declare class RAM extends RAMClient {
|
|
53
52
|
/**
|
|
54
|
-
* <p>Accepts an invitation to a resource share from another Amazon Web Services account
|
|
53
|
+
* <p>Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the
|
|
54
|
+
* invitation, the resources included in the resource share are available to interact with in the
|
|
55
|
+
* relevant Amazon Web Services Management Consoles and tools.</p>
|
|
55
56
|
*/
|
|
56
57
|
acceptResourceShareInvitation(args: AcceptResourceShareInvitationCommandInput, options?: __HttpHandlerOptions): Promise<AcceptResourceShareInvitationCommandOutput>;
|
|
57
58
|
acceptResourceShareInvitation(args: AcceptResourceShareInvitationCommandInput, cb: (err: any, data?: AcceptResourceShareInvitationCommandOutput) => void): void;
|
|
58
59
|
acceptResourceShareInvitation(args: AcceptResourceShareInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptResourceShareInvitationCommandOutput) => void): void;
|
|
59
60
|
/**
|
|
60
|
-
* <p>
|
|
61
|
+
* <p>Adds the specified list of principals and list of resources to a resource share. Principals that
|
|
62
|
+
* already have access to this resource share immediately receive access to the added resources.
|
|
63
|
+
* Newly added principals immediately receive access to the resources shared in this resource share. </p>
|
|
61
64
|
*/
|
|
62
65
|
associateResourceShare(args: AssociateResourceShareCommandInput, options?: __HttpHandlerOptions): Promise<AssociateResourceShareCommandOutput>;
|
|
63
66
|
associateResourceShare(args: AssociateResourceShareCommandInput, cb: (err: any, data?: AssociateResourceShareCommandOutput) => void): void;
|
|
64
67
|
associateResourceShare(args: AssociateResourceShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateResourceShareCommandOutput) => void): void;
|
|
65
68
|
/**
|
|
66
|
-
* <p>
|
|
69
|
+
* <p>Adds or replaces the RAM permission for a resource type included in a resource share. You can
|
|
70
|
+
* have exactly one permission associated with each resource type in the resource share. You can add
|
|
71
|
+
* a new RAM permission only if there are currently no resources of that resource type
|
|
72
|
+
* currently in the resource share.</p>
|
|
67
73
|
*/
|
|
68
74
|
associateResourceSharePermission(args: AssociateResourceSharePermissionCommandInput, options?: __HttpHandlerOptions): Promise<AssociateResourceSharePermissionCommandOutput>;
|
|
69
75
|
associateResourceSharePermission(args: AssociateResourceSharePermissionCommandInput, cb: (err: any, data?: AssociateResourceSharePermissionCommandOutput) => void): void;
|
|
70
76
|
associateResourceSharePermission(args: AssociateResourceSharePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateResourceSharePermissionCommandOutput) => void): void;
|
|
71
77
|
/**
|
|
72
|
-
* <p>Creates a resource share. You
|
|
73
|
-
*
|
|
74
|
-
*
|
|
78
|
+
* <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
|
+
* want to share, a list of principals you want to share the resources with, and the
|
|
80
|
+
* permissions to grant those principals.</p>
|
|
75
81
|
* <note>
|
|
76
82
|
* <p>Sharing a resource makes it available for use by principals outside of the
|
|
77
83
|
* Amazon Web Services account that created the resource. Sharing doesn't change any permissions or
|
|
@@ -82,7 +88,9 @@ export declare class RAM extends RAMClient {
|
|
|
82
88
|
createResourceShare(args: CreateResourceShareCommandInput, cb: (err: any, data?: CreateResourceShareCommandOutput) => void): void;
|
|
83
89
|
createResourceShare(args: CreateResourceShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceShareCommandOutput) => void): void;
|
|
84
90
|
/**
|
|
85
|
-
* <p>Deletes the specified resource share
|
|
91
|
+
* <p>Deletes the specified resource share. This doesn't delete any of the resources that were
|
|
92
|
+
* associated with the resource share; it only stops the sharing of those resources outside of the
|
|
93
|
+
* Amazon Web Services account that created them.</p>
|
|
86
94
|
*/
|
|
87
95
|
deleteResourceShare(args: DeleteResourceShareCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourceShareCommandOutput>;
|
|
88
96
|
deleteResourceShare(args: DeleteResourceShareCommandInput, cb: (err: any, data?: DeleteResourceShareCommandOutput) => void): void;
|
|
@@ -94,14 +102,23 @@ export declare class RAM extends RAMClient {
|
|
|
94
102
|
disassociateResourceShare(args: DisassociateResourceShareCommandInput, cb: (err: any, data?: DisassociateResourceShareCommandOutput) => void): void;
|
|
95
103
|
disassociateResourceShare(args: DisassociateResourceShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateResourceShareCommandOutput) => void): void;
|
|
96
104
|
/**
|
|
97
|
-
* <p>Disassociates an RAM permission from a resource share
|
|
105
|
+
* <p>Disassociates an RAM permission from a resource share. Permission changes take effect
|
|
106
|
+
* immediately. You can remove a RAM permission from a resource share only if there are currently
|
|
107
|
+
* no resources of the relevant resource type currently attached to the resource share.</p>
|
|
98
108
|
*/
|
|
99
109
|
disassociateResourceSharePermission(args: DisassociateResourceSharePermissionCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateResourceSharePermissionCommandOutput>;
|
|
100
110
|
disassociateResourceSharePermission(args: DisassociateResourceSharePermissionCommandInput, cb: (err: any, data?: DisassociateResourceSharePermissionCommandOutput) => void): void;
|
|
101
111
|
disassociateResourceSharePermission(args: DisassociateResourceSharePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateResourceSharePermissionCommandOutput) => void): void;
|
|
102
112
|
/**
|
|
103
|
-
* <p>Enables resource sharing within your organization in Organizations
|
|
104
|
-
*
|
|
113
|
+
* <p>Enables resource sharing within your organization in Organizations. Calling this operation
|
|
114
|
+
* enables RAM to retrieve information about the organization and its structure. This
|
|
115
|
+
* lets you share resources with all of the accounts in an organization by specifying the
|
|
116
|
+
* organization's ID, or all of the accounts in an organizational unit (OU) by specifying
|
|
117
|
+
* the OU's ID. Until you enable sharing within the organization, you can specify only
|
|
118
|
+
* individual Amazon Web Services accounts, or for supported resource types, IAM users and
|
|
119
|
+
* roles.</p>
|
|
120
|
+
* <p>You must call this operation from an IAM user or role in the organization's
|
|
121
|
+
* management account.</p>
|
|
105
122
|
*/
|
|
106
123
|
enableSharingWithAwsOrganization(args: EnableSharingWithAwsOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<EnableSharingWithAwsOrganizationCommandOutput>;
|
|
107
124
|
enableSharingWithAwsOrganization(args: EnableSharingWithAwsOrganizationCommandInput, cb: (err: any, data?: EnableSharingWithAwsOrganizationCommandOutput) => void): void;
|
|
@@ -113,44 +130,47 @@ export declare class RAM extends RAMClient {
|
|
|
113
130
|
getPermission(args: GetPermissionCommandInput, cb: (err: any, data?: GetPermissionCommandOutput) => void): void;
|
|
114
131
|
getPermission(args: GetPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPermissionCommandOutput) => void): void;
|
|
115
132
|
/**
|
|
116
|
-
* <p>
|
|
133
|
+
* <p>Retrieves the resource policies for the specified resources that you own and have
|
|
134
|
+
* shared.</p>
|
|
117
135
|
*/
|
|
118
136
|
getResourcePolicies(args: GetResourcePoliciesCommandInput, options?: __HttpHandlerOptions): Promise<GetResourcePoliciesCommandOutput>;
|
|
119
137
|
getResourcePolicies(args: GetResourcePoliciesCommandInput, cb: (err: any, data?: GetResourcePoliciesCommandOutput) => void): void;
|
|
120
138
|
getResourcePolicies(args: GetResourcePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePoliciesCommandOutput) => void): void;
|
|
121
139
|
/**
|
|
122
|
-
* <p>
|
|
140
|
+
* <p>Retrieves the resource and principal associations for resource shares that you own.</p>
|
|
123
141
|
*/
|
|
124
142
|
getResourceShareAssociations(args: GetResourceShareAssociationsCommandInput, options?: __HttpHandlerOptions): Promise<GetResourceShareAssociationsCommandOutput>;
|
|
125
143
|
getResourceShareAssociations(args: GetResourceShareAssociationsCommandInput, cb: (err: any, data?: GetResourceShareAssociationsCommandOutput) => void): void;
|
|
126
144
|
getResourceShareAssociations(args: GetResourceShareAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceShareAssociationsCommandOutput) => void): void;
|
|
127
145
|
/**
|
|
128
|
-
* <p>
|
|
146
|
+
* <p>Retrieves details about invitations that you have received for resource shares.</p>
|
|
129
147
|
*/
|
|
130
148
|
getResourceShareInvitations(args: GetResourceShareInvitationsCommandInput, options?: __HttpHandlerOptions): Promise<GetResourceShareInvitationsCommandOutput>;
|
|
131
149
|
getResourceShareInvitations(args: GetResourceShareInvitationsCommandInput, cb: (err: any, data?: GetResourceShareInvitationsCommandOutput) => void): void;
|
|
132
150
|
getResourceShareInvitations(args: GetResourceShareInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceShareInvitationsCommandOutput) => void): void;
|
|
133
151
|
/**
|
|
134
|
-
* <p>
|
|
152
|
+
* <p>Retrieves details about the resource shares that you own or that are shared with you.</p>
|
|
135
153
|
*/
|
|
136
154
|
getResourceShares(args: GetResourceSharesCommandInput, options?: __HttpHandlerOptions): Promise<GetResourceSharesCommandOutput>;
|
|
137
155
|
getResourceShares(args: GetResourceSharesCommandInput, cb: (err: any, data?: GetResourceSharesCommandOutput) => void): void;
|
|
138
156
|
getResourceShares(args: GetResourceSharesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceSharesCommandOutput) => void): void;
|
|
139
157
|
/**
|
|
140
|
-
* <p>Lists the resources in a resource share that is shared with you but
|
|
141
|
-
*
|
|
158
|
+
* <p>Lists the resources in a resource share that is shared with you but for which the invitation is
|
|
159
|
+
* still <code>PENDING</code>. That means that you haven't accepted or rejected the
|
|
160
|
+
* invitation and the invitation hasn't expired.</p>
|
|
142
161
|
*/
|
|
143
162
|
listPendingInvitationResources(args: ListPendingInvitationResourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListPendingInvitationResourcesCommandOutput>;
|
|
144
163
|
listPendingInvitationResources(args: ListPendingInvitationResourcesCommandInput, cb: (err: any, data?: ListPendingInvitationResourcesCommandOutput) => void): void;
|
|
145
164
|
listPendingInvitationResources(args: ListPendingInvitationResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPendingInvitationResourcesCommandOutput) => void): void;
|
|
146
165
|
/**
|
|
147
|
-
* <p>
|
|
166
|
+
* <p>Retrieves a list of available RAM permissions that you can use for the supported
|
|
167
|
+
* resource types. </p>
|
|
148
168
|
*/
|
|
149
169
|
listPermissions(args: ListPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<ListPermissionsCommandOutput>;
|
|
150
170
|
listPermissions(args: ListPermissionsCommandInput, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void;
|
|
151
171
|
listPermissions(args: ListPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void;
|
|
152
172
|
/**
|
|
153
|
-
* <p>Lists the principals that you
|
|
173
|
+
* <p>Lists the principals that you are sharing resources with or that are sharing resources
|
|
154
174
|
* with you.</p>
|
|
155
175
|
*/
|
|
156
176
|
listPrincipals(args: ListPrincipalsCommandInput, options?: __HttpHandlerOptions): Promise<ListPrincipalsCommandOutput>;
|
|
@@ -170,25 +190,18 @@ export declare class RAM extends RAMClient {
|
|
|
170
190
|
listResourceSharePermissions(args: ListResourceSharePermissionsCommandInput, cb: (err: any, data?: ListResourceSharePermissionsCommandOutput) => void): void;
|
|
171
191
|
listResourceSharePermissions(args: ListResourceSharePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceSharePermissionsCommandOutput) => void): void;
|
|
172
192
|
/**
|
|
173
|
-
* <p>Lists the
|
|
193
|
+
* <p>Lists the resource types that can be shared by RAM.</p>
|
|
174
194
|
*/
|
|
175
195
|
listResourceTypes(args: ListResourceTypesCommandInput, options?: __HttpHandlerOptions): Promise<ListResourceTypesCommandOutput>;
|
|
176
196
|
listResourceTypes(args: ListResourceTypesCommandInput, cb: (err: any, data?: ListResourceTypesCommandOutput) => void): void;
|
|
177
197
|
listResourceTypes(args: ListResourceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceTypesCommandOutput) => void): void;
|
|
178
198
|
/**
|
|
179
|
-
* <p>
|
|
180
|
-
*
|
|
181
|
-
*
|
|
182
|
-
* <p>
|
|
183
|
-
* share, it becomes
|
|
184
|
-
*
|
|
185
|
-
* <li>
|
|
186
|
-
* <p>Visible to all principals that it is shared with.</p>
|
|
187
|
-
* </li>
|
|
188
|
-
* <li>
|
|
189
|
-
* <p>Modifiable in RAM.</p>
|
|
190
|
-
* </li>
|
|
191
|
-
* </ul>
|
|
199
|
+
* <p>When you attach a resource-based permission policy to a resource, it automatically
|
|
200
|
+
* creates a resource share. However, resource shares created this way are visible only to the resource share
|
|
201
|
+
* owner, and the resource share can't be modified in RAM.</p>
|
|
202
|
+
* <p>You can use this operation to promote the resource share to a full RAM resource share. When you promote
|
|
203
|
+
* a resource share, you can then manage the resource share in RAM and it becomes visible to all of the
|
|
204
|
+
* principals you shared it with.</p>
|
|
192
205
|
*/
|
|
193
206
|
promoteResourceShareCreatedFromPolicy(args: PromoteResourceShareCreatedFromPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PromoteResourceShareCreatedFromPolicyCommandOutput>;
|
|
194
207
|
promoteResourceShareCreatedFromPolicy(args: PromoteResourceShareCreatedFromPolicyCommandInput, cb: (err: any, data?: PromoteResourceShareCreatedFromPolicyCommandOutput) => void): void;
|
|
@@ -200,19 +213,20 @@ export declare class RAM extends RAMClient {
|
|
|
200
213
|
rejectResourceShareInvitation(args: RejectResourceShareInvitationCommandInput, cb: (err: any, data?: RejectResourceShareInvitationCommandOutput) => void): void;
|
|
201
214
|
rejectResourceShareInvitation(args: RejectResourceShareInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectResourceShareInvitationCommandOutput) => void): void;
|
|
202
215
|
/**
|
|
203
|
-
* <p>Adds the specified
|
|
216
|
+
* <p>Adds the specified tag keys and values to the specified resource share. The tags are attached
|
|
217
|
+
* only to the resource share, not to the resources that are in the resource share.</p>
|
|
204
218
|
*/
|
|
205
219
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
206
220
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
207
221
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
208
222
|
/**
|
|
209
|
-
* <p>Removes the specified
|
|
223
|
+
* <p>Removes the specified tag key and value pairs from the specified resource share.</p>
|
|
210
224
|
*/
|
|
211
225
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
212
226
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
213
227
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
214
228
|
/**
|
|
215
|
-
* <p>
|
|
229
|
+
* <p>Modifies some of the properties of the specified resource share.</p>
|
|
216
230
|
*/
|
|
217
231
|
updateResourceShare(args: UpdateResourceShareCommandInput, options?: __HttpHandlerOptions): Promise<UpdateResourceShareCommandOutput>;
|
|
218
232
|
updateResourceShare(args: UpdateResourceShareCommandInput, cb: (err: any, data?: UpdateResourceShareCommandOutput) => void): void;
|
|
@@ -4,7 +4,7 @@ import { RetryInputConfig, RetryResolvedConfig } from "@aws-sdk/middleware-retry
|
|
|
4
4
|
import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
|
|
5
5
|
import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
|
|
6
6
|
import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
|
|
7
|
-
import { Client as __Client, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
7
|
+
import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
8
8
|
import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
9
9
|
import { AcceptResourceShareInvitationCommandInput, AcceptResourceShareInvitationCommandOutput } from "./commands/AcceptResourceShareInvitationCommand";
|
|
10
10
|
import { AssociateResourceShareCommandInput, AssociateResourceShareCommandOutput } from "./commands/AssociateResourceShareCommand";
|
|
@@ -132,6 +132,10 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
132
132
|
* @internal
|
|
133
133
|
*/
|
|
134
134
|
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
135
|
+
/**
|
|
136
|
+
* The {@link DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
137
|
+
*/
|
|
138
|
+
defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
|
|
135
139
|
}
|
|
136
140
|
declare type RAMClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
|
|
137
141
|
/**
|
|
@@ -148,14 +152,13 @@ export interface RAMClientResolvedConfig extends RAMClientResolvedConfigType {
|
|
|
148
152
|
/**
|
|
149
153
|
* <p>This is the <i>Resource Access Manager API Reference</i>. This documentation provides
|
|
150
154
|
* descriptions and syntax for each of the actions and data types in RAM. RAM is a
|
|
151
|
-
* service that helps you securely share your Amazon Web Services resources across Amazon Web Services accounts
|
|
152
|
-
*
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
*
|
|
155
|
+
* service that helps you securely share your Amazon Web Services resources across Amazon Web Services accounts. If you
|
|
156
|
+
* have multiple Amazon Web Services accounts, you can use RAM to share those resources with other
|
|
157
|
+
* accounts. If you use Organizations to manage your accounts, then you share your resources
|
|
158
|
+
* with your organization or organizational units (OUs). For supported resource types, you
|
|
159
|
+
* can also share resources with individual Identity and Access Management (IAM) roles an users. </p>
|
|
156
160
|
*
|
|
157
161
|
* <p>To learn more about RAM, see the following resources:</p>
|
|
158
|
-
*
|
|
159
162
|
* <ul>
|
|
160
163
|
* <li>
|
|
161
164
|
* <p>
|
|
@@ -7,7 +7,9 @@ export interface AcceptResourceShareInvitationCommandInput extends AcceptResourc
|
|
|
7
7
|
export interface AcceptResourceShareInvitationCommandOutput extends AcceptResourceShareInvitationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Accepts an invitation to a resource share from another Amazon Web Services account
|
|
10
|
+
* <p>Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the
|
|
11
|
+
* invitation, the resources included in the resource share are available to interact with in the
|
|
12
|
+
* relevant Amazon Web Services Management Consoles and tools.</p>
|
|
11
13
|
* @example
|
|
12
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
15
|
* ```javascript
|
|
@@ -7,7 +7,9 @@ export interface AssociateResourceShareCommandInput extends AssociateResourceSha
|
|
|
7
7
|
export interface AssociateResourceShareCommandOutput extends AssociateResourceShareResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Adds the specified list of principals and list of resources to a resource share. Principals that
|
|
11
|
+
* already have access to this resource share immediately receive access to the added resources.
|
|
12
|
+
* Newly added principals immediately receive access to the resources shared in this resource share. </p>
|
|
11
13
|
* @example
|
|
12
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
15
|
* ```javascript
|
|
@@ -7,7 +7,10 @@ export interface AssociateResourceSharePermissionCommandInput extends AssociateR
|
|
|
7
7
|
export interface AssociateResourceSharePermissionCommandOutput extends AssociateResourceSharePermissionResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Adds or replaces the RAM permission for a resource type included in a resource share. You can
|
|
11
|
+
* have exactly one permission associated with each resource type in the resource share. You can add
|
|
12
|
+
* a new RAM permission only if there are currently no resources of that resource type
|
|
13
|
+
* currently in the resource share.</p>
|
|
11
14
|
* @example
|
|
12
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
16
|
* ```javascript
|
|
@@ -7,9 +7,9 @@ export interface CreateResourceShareCommandInput extends CreateResourceShareRequ
|
|
|
7
7
|
export interface CreateResourceShareCommandOutput extends CreateResourceShareResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a resource share. You
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <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
|
|
11
|
+
* want to share, a list of principals you want to share the resources with, and the
|
|
12
|
+
* permissions to grant those principals.</p>
|
|
13
13
|
* <note>
|
|
14
14
|
* <p>Sharing a resource makes it available for use by principals outside of the
|
|
15
15
|
* Amazon Web Services account that created the resource. Sharing doesn't change any permissions or
|
|
@@ -7,7 +7,9 @@ export interface DeleteResourceShareCommandInput extends DeleteResourceShareRequ
|
|
|
7
7
|
export interface DeleteResourceShareCommandOutput extends DeleteResourceShareResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes the specified resource share
|
|
10
|
+
* <p>Deletes the specified resource share. This doesn't delete any of the resources that were
|
|
11
|
+
* associated with the resource share; it only stops the sharing of those resources outside of the
|
|
12
|
+
* Amazon Web Services account that created them.</p>
|
|
11
13
|
* @example
|
|
12
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
15
|
* ```javascript
|
|
@@ -7,7 +7,9 @@ export interface DisassociateResourceSharePermissionCommandInput extends Disasso
|
|
|
7
7
|
export interface DisassociateResourceSharePermissionCommandOutput extends DisassociateResourceSharePermissionResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Disassociates an RAM permission from a resource share
|
|
10
|
+
* <p>Disassociates an RAM permission from a resource share. Permission changes take effect
|
|
11
|
+
* immediately. You can remove a RAM permission from a resource share only if there are currently
|
|
12
|
+
* no resources of the relevant resource type currently attached to the resource share.</p>
|
|
11
13
|
* @example
|
|
12
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
15
|
* ```javascript
|
|
@@ -7,8 +7,15 @@ export interface EnableSharingWithAwsOrganizationCommandInput extends EnableShar
|
|
|
7
7
|
export interface EnableSharingWithAwsOrganizationCommandOutput extends EnableSharingWithAwsOrganizationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Enables resource sharing within your organization in Organizations
|
|
11
|
-
*
|
|
10
|
+
* <p>Enables resource sharing within your organization in Organizations. Calling this operation
|
|
11
|
+
* enables RAM to retrieve information about the organization and its structure. This
|
|
12
|
+
* lets you share resources with all of the accounts in an organization by specifying the
|
|
13
|
+
* organization's ID, or all of the accounts in an organizational unit (OU) by specifying
|
|
14
|
+
* the OU's ID. Until you enable sharing within the organization, you can specify only
|
|
15
|
+
* individual Amazon Web Services accounts, or for supported resource types, IAM users and
|
|
16
|
+
* roles.</p>
|
|
17
|
+
* <p>You must call this operation from an IAM user or role in the organization's
|
|
18
|
+
* management account.</p>
|
|
12
19
|
* @example
|
|
13
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
21
|
* ```javascript
|
|
@@ -7,7 +7,8 @@ export interface GetResourcePoliciesCommandInput extends GetResourcePoliciesRequ
|
|
|
7
7
|
export interface GetResourcePoliciesCommandOutput extends GetResourcePoliciesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Retrieves the resource policies for the specified resources that you own and have
|
|
11
|
+
* shared.</p>
|
|
11
12
|
* @example
|
|
12
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
14
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetResourceShareAssociationsCommandInput extends GetResourceSha
|
|
|
7
7
|
export interface GetResourceShareAssociationsCommandOutput extends GetResourceShareAssociationsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Retrieves the resource and principal associations for resource shares that you own.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetResourceShareInvitationsCommandInput extends GetResourceShar
|
|
|
7
7
|
export interface GetResourceShareInvitationsCommandOutput extends GetResourceShareInvitationsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Retrieves details about invitations that you have received for resource shares.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetResourceSharesCommandInput extends GetResourceSharesRequest
|
|
|
7
7
|
export interface GetResourceSharesCommandOutput extends GetResourceSharesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Retrieves details about the resource shares that you own or that are shared with you.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,8 +7,9 @@ export interface ListPendingInvitationResourcesCommandInput extends ListPendingI
|
|
|
7
7
|
export interface ListPendingInvitationResourcesCommandOutput extends ListPendingInvitationResourcesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Lists the resources in a resource share that is shared with you but
|
|
11
|
-
*
|
|
10
|
+
* <p>Lists the resources in a resource share that is shared with you but for which the invitation is
|
|
11
|
+
* still <code>PENDING</code>. That means that you haven't accepted or rejected the
|
|
12
|
+
* invitation and the invitation hasn't expired.</p>
|
|
12
13
|
* @example
|
|
13
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
15
|
* ```javascript
|
|
@@ -7,7 +7,8 @@ export interface ListPermissionsCommandInput extends ListPermissionsRequest {
|
|
|
7
7
|
export interface ListPermissionsCommandOutput extends ListPermissionsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Retrieves a list of available RAM permissions that you can use for the supported
|
|
11
|
+
* resource types. </p>
|
|
11
12
|
* @example
|
|
12
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
14
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface ListPrincipalsCommandInput extends ListPrincipalsRequest {
|
|
|
7
7
|
export interface ListPrincipalsCommandOutput extends ListPrincipalsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Lists the principals that you
|
|
10
|
+
* <p>Lists the principals that you are sharing resources with or that are sharing resources
|
|
11
11
|
* with you.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,7 +7,7 @@ export interface ListResourceTypesCommandInput extends ListResourceTypesRequest
|
|
|
7
7
|
export interface ListResourceTypesCommandOutput extends ListResourceTypesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Lists the
|
|
10
|
+
* <p>Lists the resource types that can be shared by RAM.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,19 +7,12 @@ export interface PromoteResourceShareCreatedFromPolicyCommandInput extends Promo
|
|
|
7
7
|
export interface PromoteResourceShareCreatedFromPolicyCommandOutput extends PromoteResourceShareCreatedFromPolicyResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* <p>
|
|
14
|
-
* share, it becomes
|
|
15
|
-
*
|
|
16
|
-
* <li>
|
|
17
|
-
* <p>Visible to all principals that it is shared with.</p>
|
|
18
|
-
* </li>
|
|
19
|
-
* <li>
|
|
20
|
-
* <p>Modifiable in RAM.</p>
|
|
21
|
-
* </li>
|
|
22
|
-
* </ul>
|
|
10
|
+
* <p>When you attach a resource-based permission policy to a resource, it automatically
|
|
11
|
+
* creates a resource share. However, resource shares created this way are visible only to the resource share
|
|
12
|
+
* owner, and the resource share can't be modified in RAM.</p>
|
|
13
|
+
* <p>You can use this operation to promote the resource share to a full RAM resource share. When you promote
|
|
14
|
+
* a resource share, you can then manage the resource share in RAM and it becomes visible to all of the
|
|
15
|
+
* principals you shared it with.</p>
|
|
23
16
|
* @example
|
|
24
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
18
|
* ```javascript
|
|
@@ -7,7 +7,8 @@ export interface TagResourceCommandInput extends TagResourceRequest {
|
|
|
7
7
|
export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Adds the specified
|
|
10
|
+
* <p>Adds the specified tag keys and values to the specified resource share. The tags are attached
|
|
11
|
+
* only to the resource share, not to the resources that are in the resource share.</p>
|
|
11
12
|
* @example
|
|
12
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
14
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {
|
|
|
7
7
|
export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Removes the specified
|
|
10
|
+
* <p>Removes the specified tag key and value pairs from the specified resource share.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface UpdateResourceShareCommandInput extends UpdateResourceShareRequ
|
|
|
7
7
|
export interface UpdateResourceShareCommandOutput extends UpdateResourceShareResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Modifies some of the properties of the specified resource share.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|