View Source aws_ram (aws v1.0.4)
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:
Resource Access Manager product page: http://aws.amazon.com/ram
Resource Access Manager User Guide: https://docs.aws.amazon.com/ram/latest/userguide/
Summary
Functions
Accepts an invitation to a resource share from another Amazon Web Services account.
Adds the specified list of principals and list of resources to a resource share.
Adds or replaces the RAM permission for a resource type included in a resource share.
Creates a customer managed permission for a specified resource type that you can attach to resource shares.
Creates a new version of the specified customer managed permission.
Creates a resource share.
Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation.
Deletes one version of a customer managed permission.
Deletes the specified resource share.
Removes a managed permission from a resource share.
Enables resource sharing within your organization in Organizations.
Lists the resources in a resource share that is shared with you but for which the invitation is still PENDING
.
Lists information about the managed permission and its associations to any resource shares that use this managed permission.
ReplacePermissionAssociationsWork
operation.When you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM permissions as the original resource-based policy.
When you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM permissions as the original resource-based policy.
Updates all resource shares that use a managed permission to a different managed permission.
Designates the specified version number as the default version for the specified customer managed permission.
Adds the specified tag keys and values to a resource share or managed permission.
Functions
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.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.
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.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.Enables resource sharing within your organization in Organizations.
This operation creates a service-linked role called AWSServiceRoleForResourceAccessManager
that has the IAM managed policy named AWSResourceAccessManagerServiceRolePolicy attached. This role permits RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in the calling account's organization by specifying the organization ID, or all of the accounts in an organizational unit (OU) by specifying the OU ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM roles and users.
Lists the resources in a resource share that is shared with you but for which the invitation is still PENDING
.
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.ReplacePermissionAssociationsWork
operation.
list_replace_permission_associations_work(Client, Input0, Options0)
View SourceWhen you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM permissions as the original resource-based policy.
However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM.
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.
The original CREATED_FROM_POLICY
policy isn't deleted, and resource shares using that original policy aren't automatically updated.
You can't modify a CREATED_FROM_POLICY
resource share so you can't associate the new customer managed permission by using ReplacePermsissionAssociations
. However, if you use PromoteResourceShareCreatedFromPolicy
, that operation automatically associates the fully manageable customer managed permission to the newly promoted STANDARD
resource share.
CREATED_FROM_POLICY
managed permission has no other associations to A resource share, then RAM automatically deletes it.
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 fromPermissionArn
and toPermissionArn
parameters.
You can use the optional fromPermissionVersion
parameter to update only those resources that use a specified version of the managed permission to the new managed permission.
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 useReplacePermissionAssociations
to update them.
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.