- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
RAMClient
This is the Resource Access Manager API Reference. This documentation provides descriptions and syntax for each of the actions and data types in RAM. RAM is a service that helps you securely share your Amazon Web Services resources to other Amazon Web Services accounts. If you use Organizations to manage your accounts, then you can share your resources with your entire organization or to organizational units (OUs). For supported resource types, you can also share resources with individual Identity and Access Management (IAM) roles and users.
To learn more about RAM, see the following resources:
Installation
npm install @aws-sdk/client-ram
yarn add @aws-sdk/client-ram
pnpm add @aws-sdk/client-ram
RAMClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AcceptResourceShareInvitationCommand | Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the invitation, the resources included in the resource share are available to interact with in the relevant Amazon Web Services Management Consoles and tools. |
AssociateResourceShareCommand | Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share. |
AssociateResourceSharePermissionCommand | Adds or replaces the RAM permission for a resource type included in a resource share. You can have exactly one permission associated with each resource type in the resource share. You can add a new RAM permission only if there are currently no resources of that resource type currently in the resource share. |
CreatePermissionCommand | Creates a customer managed permission for a specified resource type that you can attach to resource shares. It is created in the Amazon Web Services Region in which you call the operation. |
CreatePermissionVersionCommand | Creates a new version of the specified customer managed permission. The new version is automatically set as the default version of the customer managed permission. New resource shares automatically use the default permission. Existing resource shares continue to use their original permission versions, but you can use ReplacePermissionAssociations to update them. If the specified customer managed permission already has the maximum of 5 versions, then you must delete one of the existing versions before you can create a new one. |
CreateResourceShareCommand | Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals. Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it. |
DeletePermissionCommand | Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation. You can delete a customer managed permission only if it isn't attached to any resource share. The operation deletes all versions associated with the customer managed permission. |
DeletePermissionVersionCommand | Deletes one version of a customer managed permission. The version you specify must not be attached to any resource share and must not be the default version for the permission. If a customer managed permission has the maximum of 5 versions, then you must delete at least one version before you can create another. |
DeleteResourceShareCommand | Deletes the specified resource share. This doesn't delete any of the resources that were associated with the resource share; it only stops the sharing of those resources through this resource share. |
DisassociateResourceShareCommand | Removes the specified principals or resources from participating in the specified resource share. |
DisassociateResourceSharePermissionCommand | Removes a managed permission from a resource share. Permission changes take effect immediately. You can remove a managed permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share. |
EnableSharingWithAwsOrganizationCommand | Enables resource sharing within your organization in Organizations. This operation creates a service-linked role called You must call this operation from an IAM role or user in the organization's management account. |
GetPermissionCommand | Retrieves the contents of a managed permission in JSON format. |
GetResourcePoliciesCommand | Retrieves the resource policies for the specified resources that you own and have shared. |
GetResourceShareAssociationsCommand | Retrieves the lists of resources and principals that associated for resource shares that you own. |
GetResourceShareInvitationsCommand | Retrieves details about invitations that you have received for resource shares. |
GetResourceSharesCommand | Retrieves details about the resource shares that you own or that are shared with you. |
ListPendingInvitationResourcesCommand | Lists the resources in a resource share that is shared with you but for which the invitation is still |
ListPermissionAssociationsCommand | Lists information about the managed permission and its associations to any resource shares that use this managed permission. This lets you see which resource shares use which versions of the specified managed permission. |
ListPermissionVersionsCommand | Lists the available versions of the specified RAM permission. |
ListPermissionsCommand | Retrieves a list of available RAM permissions that you can use for the supported resource types. |
ListPrincipalsCommand | Lists the principals that you are sharing resources with or that are sharing resources with you. |
ListReplacePermissionAssociationsWorkCommand | Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation. |
ListResourceSharePermissionsCommand | Lists the RAM permissions that are associated with a resource share. |
ListResourceTypesCommand | Lists the resource types that can be shared by RAM. |
ListResourcesCommand | Lists the resources that you added to a resource share or the resources that are shared with you. |
PromotePermissionCreatedFromPolicyCommand | When you attach a resource-based policy to a resource, RAM automatically creates a resource share of This operation creates a separate, fully manageable customer managed permission that has the same IAM permissions as the original resource-based policy. You can associate this customer managed permission to any resource shares. Before you use PromoteResourceShareCreatedFromPolicy, you should first run this operation to ensure that you have an appropriate customer managed permission that can be associated with the promoted resource share.
|
PromoteResourceShareCreatedFromPolicyCommand | When you attach a resource-based policy to a resource, RAM automatically creates a resource share of This operation promotes the resource share to a Before you perform this operation, you should first run PromotePermissionCreatedFromPolicyto ensure that you have an appropriate customer managed permission that can be associated with this resource share after its is promoted. If this operation can't find a managed permission that exactly matches the existing |
RejectResourceShareInvitationCommand | Rejects an invitation to a resource share from another Amazon Web Services account. |
ReplacePermissionAssociationsCommand | Updates all resource shares that use a managed permission to a different managed permission. This operation always applies the default version of the target managed permission. You can optionally specify that the update applies to only resource shares that currently use a specified version. This enables you to update to the latest version, without changing the which managed permission is used. You can use this operation to update all of your resource shares to use the current default version of the permission by specifying the same value for the You can use the optional To successfully perform this operation, you must have permission to update the resource-based policy on all affected resource types. |
SetDefaultPermissionVersionCommand | Designates the specified version number as the default version for the specified customer managed permission. New resource shares automatically use this new default permission. Existing resource shares continue to use their original permission version, but you can use ReplacePermissionAssociations to update them. |
TagResourceCommand | Adds the specified tag keys and values to a resource share or managed permission. If you choose a resource share, the tags are attached to only the resource share, not to the resources that are in the resource share. The tags on a managed permission are the same for all versions of the managed permission. |
UntagResourceCommand | Removes the specified tag key and value pairs from the specified resource share or managed permission. |
UpdateResourceShareCommand | Modifies some of the properties of the specified resource share. |
RAMClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: RAMClientConfig