paws (version 0.2.0)

ram: AWS Resource Access Manager

Description

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 across Amazon Web Services accounts. If you have multiple Amazon Web Services accounts, you can use RAM to share those resources with other accounts. If you use Organizations to manage your accounts, then you share your resources with your organization or organizational units (OUs). For supported resource types, you can also share resources with individual Identity and Access Management (IAM) roles an users.

To learn more about RAM, see the following resources:

• Resource Access Manager product page

• Resource Access Manager User Guide

Usage

ram(config = list())

Value

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.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

• 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.

Service syntax

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"
  )
)

Operations

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_resource_share	Creates a resource share
delete_resource_share	Deletes the specified resource share
disassociate_resource_share	Disassociates the specified principals or resources from the specified resource share
disassociate_resource_share_permission	Disassociates an RAM permission from a resource share
enable_sharing_with_aws_organization	Enables resource sharing within your organization in Organizations
get_permission	Gets the contents of an RAM 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 resource and principal associations 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_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_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_resource_share_created_from_policy	When you attach a resource-based permission policy to a resource, it automatically creates a resource share
reject_resource_share_invitation	Rejects an invitation to a resource share from another Amazon Web Services account
tag_resource	Adds the specified tag keys and values to the specified resource share
untag_resource	Removes the specified tag key and value pairs from the specified resource share
update_resource_share	Modifies some of the properties of the specified resource share

Examples

if (FALSE) {
svc <- ram()
svc$accept_resource_share_invitation(
  Foo = 123
)
}