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:
ram(config = list(), credentials = list(), endpoint = NULL, region = NULL)A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
svc <- ram(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| accept_resource_share_invitation | Accepts an invitation to a resource share from another Amazon Web Services account |
| associate_resource_share | Adds the specified list of principals and list of resources to a resource share |
| associate_resource_share_permission | Adds or replaces the RAM permission for a resource type included in a resource share |
| create_permission | Creates a customer managed permission for a specified resource type that you can attach to resource shares |
| create_permission_version | Creates a new version of the specified customer managed permission |
| create_resource_share | Creates a resource share |
| delete_permission | Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation |
| delete_permission_version | Deletes one version of a customer managed permission |
| delete_resource_share | Deletes the specified resource share |
| disassociate_resource_share | Removes the specified principals or resources from participating in the specified resource share |
| disassociate_resource_share_permission | Removes a managed permission from a resource share |
| enable_sharing_with_aws_organization | Enables resource sharing within your organization in Organizations |
| get_permission | Retrieves the contents of a managed permission in JSON format |
| get_resource_policies | Retrieves the resource policies for the specified resources that you own and have shared |
| get_resource_share_associations | Retrieves the lists of resources and principals that associated for resource shares that you own |
| get_resource_share_invitations | Retrieves details about invitations that you have received for resource shares |
| get_resource_shares | Retrieves details about the resource shares that you own or that are shared with you |
| list_pending_invitation_resources | Lists the resources in a resource share that is shared with you but for which the invitation is still PENDING |
| list_permission_associations | Lists information about the managed permission and its associations to any resource shares that use this managed permission |
| list_permissions | Retrieves a list of available RAM permissions that you can use for the supported resource types |
| list_permission_versions | Lists the available versions of the specified RAM permission |
| list_principals | Lists the principals that you are sharing resources with or that are sharing resources with you |
| list_replace_permission_associations_work | Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation |
| list_resources | Lists the resources that you added to a resource share or the resources that are shared with you |
| list_resource_share_permissions | Lists the RAM permissions that are associated with a resource share |
| list_resource_types | Lists the resource types that can be shared by RAM |
| promote_permission_created_from_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 |
| promote_resource_share_created_from_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 |
| reject_resource_share_invitation | Rejects an invitation to a resource share from another Amazon Web Services account |
| replace_permission_associations | Updates all resource shares that use a managed permission to a different managed permission |
| set_default_permission_version | Designates the specified version number as the default version for the specified customer managed permission |
| tag_resource | Adds the specified tag keys and values to a resource share or managed permission |
| untag_resource | Removes the specified tag key and value pairs from the specified resource share or managed permission |
| update_resource_share | Modifies some of the properties of the specified resource share |
if (FALSE) {
svc <- ram()
svc$accept_resource_share_invitation(
Foo = 123
)
}
Run the code above in your browser using DataLab