View Source AWS.RAM (aws-elixir 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
*
Link to this section 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 the specified principals or resources from participating in the specified resource share.
Removes a managed permission from a resource share.
Enables resource sharing within your organization in Organizations.
Retrieves the contents of a managed permission in JSON format.
Retrieves the resource policies for the specified resources that you own and have shared.
Retrieves the lists of resources and principals that associated for resource shares that you own.
Retrieves details about invitations that you have received for resource shares.
Retrieves details about the resource shares that you own or that are shared with you.
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.
Lists the available versions of the specified RAM permission.
Retrieves a list of available RAM permissions that you can use for the supported resource types.
Lists the principals that you are sharing resources with or that are sharing resources with you.
Retrieves the current status of the asynchronous tasks performed by RAM when you
perform the ReplacePermissionAssociationsWork operation.
Lists the RAM permissions that are associated with a resource share.
Lists the resource types that can be shared by RAM.
Lists the resources that you added to a resource share or the resources that are shared with you.
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.
Rejects an invitation to a resource share from another Amazon Web Services account.
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.
Removes the specified tag key and value pairs from the specified resource share or managed permission.
Modifies some of the properties of the specified resource share.
Link to this section 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.
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.
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.
enable_sharing_with_aws_organization(client, input, options \\ [])
View SourceEnables 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.
You must call this operation from an IAM role or user in the organization's management account.
Retrieves the contents of a managed permission in JSON format.
Retrieves the resource policies for the specified resources that you own and have shared.
Lists the resources in a resource share that is shared with you but for which
the invitation is
still PENDING.
That means that you haven't accepted or rejected the invitation and the invitation hasn't expired.
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.
Lists the available versions of the specified RAM permission.
Retrieves a list of available RAM permissions that you can use for the supported resource types.
Lists the principals that you are sharing resources with or that are sharing resources with you.
list_replace_permission_associations_work(client, input, options \\ [])
View SourceRetrieves the current status of the asynchronous tasks performed by RAM when you
perform the ReplacePermissionAssociationsWork operation.
Lists the resource types that can be shared by RAM.
Lists the resources that you added to a resource share or the resources that are shared with you.
promote_permission_created_from_policy(client, input, options \\ [])
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.
After you promote a resource share, if the original 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.
To successfully perform this operation, you must have permission to update the resource-based policy on all affected resource types.
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.
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.
Removes the specified tag key and value pairs from the specified resource share or managed permission.