You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RAM::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AWS Resource Access Manager. To construct a client, you need to configure a :region and :credentials.

ram = Aws::RAM::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::RAM::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::RAM::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#accept_resource_share_invitation(options = {}) ⇒ Types::AcceptResourceShareInvitationResponse

Accepts an invitation to a resource share from another AWS account.

Examples:

Request syntax with placeholder values


resp = client.accept_resource_share_invitation({
  resource_share_invitation_arn: "String", # required
  client_token: "String",
})

Response structure


resp.resource_share_invitation.resource_share_invitation_arn #=> String
resp.resource_share_invitation.resource_share_name #=> String
resp.resource_share_invitation.resource_share_arn #=> String
resp.resource_share_invitation. #=> String
resp.resource_share_invitation. #=> String
resp.resource_share_invitation.invitation_timestamp #=> Time
resp.resource_share_invitation.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "EXPIRED"
resp.resource_share_invitation.resource_share_associations #=> Array
resp.resource_share_invitation.resource_share_associations[0].resource_share_arn #=> String
resp.resource_share_invitation.resource_share_associations[0].resource_share_name #=> String
resp.resource_share_invitation.resource_share_associations[0].associated_entity #=> String
resp.resource_share_invitation.resource_share_associations[0].association_type #=> String, one of "PRINCIPAL", "RESOURCE"
resp.resource_share_invitation.resource_share_associations[0].status #=> String, one of "ASSOCIATING", "ASSOCIATED", "FAILED", "DISASSOCIATING", "DISASSOCIATED"
resp.resource_share_invitation.resource_share_associations[0].status_message #=> String
resp.resource_share_invitation.resource_share_associations[0].creation_time #=> Time
resp.resource_share_invitation.resource_share_associations[0].last_updated_time #=> Time
resp.resource_share_invitation.resource_share_associations[0].external #=> true/false
resp.client_token #=> String

Options Hash (options):

  • :resource_share_invitation_arn (required, String)

    The Amazon Resource Name (ARN) of the invitation.

  • :client_token (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

See Also:

#associate_resource_share(options = {}) ⇒ Types::AssociateResourceShareResponse

Associates the specified resource share with the specified principals and resources.

Examples:

Request syntax with placeholder values


resp = client.associate_resource_share({
  resource_share_arn: "String", # required
  resource_arns: ["String"],
  principals: ["String"],
  client_token: "String",
})

Response structure


resp.resource_share_associations #=> Array
resp.resource_share_associations[0].resource_share_arn #=> String
resp.resource_share_associations[0].resource_share_name #=> String
resp.resource_share_associations[0].associated_entity #=> String
resp.resource_share_associations[0].association_type #=> String, one of "PRINCIPAL", "RESOURCE"
resp.resource_share_associations[0].status #=> String, one of "ASSOCIATING", "ASSOCIATED", "FAILED", "DISASSOCIATING", "DISASSOCIATED"
resp.resource_share_associations[0].status_message #=> String
resp.resource_share_associations[0].creation_time #=> Time
resp.resource_share_associations[0].last_updated_time #=> Time
resp.resource_share_associations[0].external #=> true/false
resp.client_token #=> String

Options Hash (options):

  • :resource_share_arn (required, String)

    The Amazon Resource Name (ARN) of the resource share.

  • :resource_arns (Array<String>)

    The Amazon Resource Names (ARN) of the resources.

  • :principals (Array<String>)

    The principals.

  • :client_token (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

See Also:

#associate_resource_share_permission(options = {}) ⇒ Types::AssociateResourceSharePermissionResponse

Associates a permission with a resource share.

Examples:

Request syntax with placeholder values


resp = client.associate_resource_share_permission({
  resource_share_arn: "String", # required
  permission_arn: "String", # required
  replace: false,
  client_token: "String",
})

Response structure


resp.return_value #=> true/false
resp.client_token #=> String

Options Hash (options):

  • :resource_share_arn (required, String)

    The Amazon Resource Name (ARN) of the resource share.

  • :permission_arn (required, String)

    The ARN of the AWS RAM permission to associate with the resource share.

  • :replace (Boolean)

    Indicates whether the permission should replace the permissions that are currently associated with the resource share. Use true to replace the current permissions. Use false to add the permission to the current permission.

  • :client_token (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

See Also:

#create_resource_share(options = {}) ⇒ Types::CreateResourceShareResponse

Creates a resource share.

Examples:

Request syntax with placeholder values


resp = client.create_resource_share({
  name: "String", # required
  resource_arns: ["String"],
  principals: ["String"],
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  allow_external_principals: false,
  client_token: "String",
  permission_arns: ["String"],
})

Response structure


resp.resource_share.resource_share_arn #=> String
resp.resource_share.name #=> String
resp.resource_share. #=> String
resp.resource_share.allow_external_principals #=> true/false
resp.resource_share.status #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING", "DELETED"
resp.resource_share.status_message #=> String
resp.resource_share.tags #=> Array
resp.resource_share.tags[0].key #=> String
resp.resource_share.tags[0].value #=> String
resp.resource_share.creation_time #=> Time
resp.resource_share.last_updated_time #=> Time
resp.resource_share.feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
resp.client_token #=> String

Options Hash (options):

  • :name (required, String)

    The name of the resource share.

  • :resource_arns (Array<String>)

    The Amazon Resource Names (ARN) of the resources to associate with the resource share.

  • :principals (Array<String>)

    The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of an OU or organization from AWS Organizations.

  • :tags (Array<Types::Tag>)

    One or more tags.

  • :allow_external_principals (Boolean)

    Indicates whether principals outside your AWS organization can be associated with a resource share.

  • :client_token (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

  • :permission_arns (Array<String>)

    The ARNs of the permissions to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type.

Returns:

See Also:

#delete_resource_share(options = {}) ⇒ Types::DeleteResourceShareResponse

Deletes the specified resource share.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_share({
  resource_share_arn: "String", # required
  client_token: "String",
})

Response structure


resp.return_value #=> true/false
resp.client_token #=> String

Options Hash (options):

  • :resource_share_arn (required, String)

    The Amazon Resource Name (ARN) of the resource share.

  • :client_token (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

See Also:

#disassociate_resource_share(options = {}) ⇒ Types::DisassociateResourceShareResponse

Disassociates the specified principals or resources from the specified resource share.

Examples:

Request syntax with placeholder values


resp = client.disassociate_resource_share({
  resource_share_arn: "String", # required
  resource_arns: ["String"],
  principals: ["String"],
  client_token: "String",
})

Response structure


resp.resource_share_associations #=> Array
resp.resource_share_associations[0].resource_share_arn #=> String
resp.resource_share_associations[0].resource_share_name #=> String
resp.resource_share_associations[0].associated_entity #=> String
resp.resource_share_associations[0].association_type #=> String, one of "PRINCIPAL", "RESOURCE"
resp.resource_share_associations[0].status #=> String, one of "ASSOCIATING", "ASSOCIATED", "FAILED", "DISASSOCIATING", "DISASSOCIATED"
resp.resource_share_associations[0].status_message #=> String
resp.resource_share_associations[0].creation_time #=> Time
resp.resource_share_associations[0].last_updated_time #=> Time
resp.resource_share_associations[0].external #=> true/false
resp.client_token #=> String

Options Hash (options):

  • :resource_share_arn (required, String)

    The Amazon Resource Name (ARN) of the resource share.

  • :resource_arns (Array<String>)

    The Amazon Resource Names (ARNs) of the resources.

  • :principals (Array<String>)

    The principals.

  • :client_token (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

See Also:

#disassociate_resource_share_permission(options = {}) ⇒ Types::DisassociateResourceSharePermissionResponse

Disassociates an AWS RAM permission from a resource share.

Examples:

Request syntax with placeholder values


resp = client.disassociate_resource_share_permission({
  resource_share_arn: "String", # required
  permission_arn: "String", # required
  client_token: "String",
})

Response structure


resp.return_value #=> true/false
resp.client_token #=> String

Options Hash (options):

  • :resource_share_arn (required, String)

    The Amazon Resource Name (ARN) of the resource share.

  • :permission_arn (required, String)

    The ARN of the permission to disassociate from the resource share.

  • :client_token (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

See Also:

#enable_sharing_with_aws_organization(options = {}) ⇒ Types::EnableSharingWithAwsOrganizationResponse

Enables resource sharing within your AWS Organization.

The caller must be the master account for the AWS Organization.

Examples:

Request syntax with placeholder values


resp = client.enable_sharing_with_aws_organization()

Response structure


resp.return_value #=> true/false

Returns:

See Also:

#get_permission(options = {}) ⇒ Types::GetPermissionResponse

Gets the contents of an AWS RAM permission in JSON format.

Examples:

Request syntax with placeholder values


resp = client.get_permission({
  permission_arn: "String", # required
  permission_version: 1,
})

Response structure


resp.permission.arn #=> String
resp.permission.version #=> String
resp.permission.default_version #=> true/false
resp.permission.name #=> String
resp.permission.resource_type #=> String
resp.permission.permission #=> String
resp.permission.creation_time #=> Time
resp.permission.last_updated_time #=> Time

Options Hash (options):

  • :permission_arn (required, String)

    The ARN of the permission.

  • :permission_version (Integer)

    The identifier for the version of the permission.

Returns:

See Also:

#get_resource_policies(options = {}) ⇒ Types::GetResourcePoliciesResponse

Gets the policies for the specified resources that you own and have shared.

Examples:

Request syntax with placeholder values


resp = client.get_resource_policies({
  resource_arns: ["String"], # required
  principal: "String",
  next_token: "String",
  max_results: 1,
})

Response structure


resp.policies #=> Array
resp.policies[0] #=> String
resp.next_token #=> String

Options Hash (options):

  • :resource_arns (required, Array<String>)

    The Amazon Resource Names (ARN) of the resources.

  • :principal (String)

    The principal.

  • :next_token (String)

    The token for the next page of results.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

See Also:

#get_resource_share_associations(options = {}) ⇒ Types::GetResourceShareAssociationsResponse

Gets the resources or principals for the resource shares that you own.

Examples:

Request syntax with placeholder values


resp = client.get_resource_share_associations({
  association_type: "PRINCIPAL", # required, accepts PRINCIPAL, RESOURCE
  resource_share_arns: ["String"],
  resource_arn: "String",
  principal: "String",
  association_status: "ASSOCIATING", # accepts ASSOCIATING, ASSOCIATED, FAILED, DISASSOCIATING, DISASSOCIATED
  next_token: "String",
  max_results: 1,
})

Response structure


resp.resource_share_associations #=> Array
resp.resource_share_associations[0].resource_share_arn #=> String
resp.resource_share_associations[0].resource_share_name #=> String
resp.resource_share_associations[0].associated_entity #=> String
resp.resource_share_associations[0].association_type #=> String, one of "PRINCIPAL", "RESOURCE"
resp.resource_share_associations[0].status #=> String, one of "ASSOCIATING", "ASSOCIATED", "FAILED", "DISASSOCIATING", "DISASSOCIATED"
resp.resource_share_associations[0].status_message #=> String
resp.resource_share_associations[0].creation_time #=> Time
resp.resource_share_associations[0].last_updated_time #=> Time
resp.resource_share_associations[0].external #=> true/false
resp.next_token #=> String

Options Hash (options):

  • :association_type (required, String)

    The association type. Specify PRINCIPAL to list the principals that are associated with the specified resource share. Specify RESOURCE to list the resources that are associated with the specified resource share.

  • :resource_share_arns (Array<String>)

    The Amazon Resource Names (ARN) of the resource shares.

  • :resource_arn (String)

    The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the association type is PRINCIPAL.

  • :principal (String)

    The principal. You cannot specify this parameter if the association type is RESOURCE.

  • :association_status (String)

    The association status.

  • :next_token (String)

    The token for the next page of results.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

See Also:

#get_resource_share_invitations(options = {}) ⇒ Types::GetResourceShareInvitationsResponse

Gets the invitations for resource sharing that you've received.

Examples:

Request syntax with placeholder values


resp = client.get_resource_share_invitations({
  resource_share_invitation_arns: ["String"],
  resource_share_arns: ["String"],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.resource_share_invitations #=> Array
resp.resource_share_invitations[0].resource_share_invitation_arn #=> String
resp.resource_share_invitations[0].resource_share_name #=> String
resp.resource_share_invitations[0].resource_share_arn #=> String
resp.resource_share_invitations[0]. #=> String
resp.resource_share_invitations[0]. #=> String
resp.resource_share_invitations[0].invitation_timestamp #=> Time
resp.resource_share_invitations[0].status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "EXPIRED"
resp.resource_share_invitations[0].resource_share_associations #=> Array
resp.resource_share_invitations[0].resource_share_associations[0].resource_share_arn #=> String
resp.resource_share_invitations[0].resource_share_associations[0].resource_share_name #=> String
resp.resource_share_invitations[0].resource_share_associations[0].associated_entity #=> String
resp.resource_share_invitations[0].resource_share_associations[0].association_type #=> String, one of "PRINCIPAL", "RESOURCE"
resp.resource_share_invitations[0].resource_share_associations[0].status #=> String, one of "ASSOCIATING", "ASSOCIATED", "FAILED", "DISASSOCIATING", "DISASSOCIATED"
resp.resource_share_invitations[0].resource_share_associations[0].status_message #=> String
resp.resource_share_invitations[0].resource_share_associations[0].creation_time #=> Time
resp.resource_share_invitations[0].resource_share_associations[0].last_updated_time #=> Time
resp.resource_share_invitations[0].resource_share_associations[0].external #=> true/false
resp.next_token #=> String

Options Hash (options):

  • :resource_share_invitation_arns (Array<String>)

    The Amazon Resource Names (ARN) of the invitations.

  • :resource_share_arns (Array<String>)

    The Amazon Resource Names (ARN) of the resource shares.

  • :next_token (String)

    The token for the next page of results.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

See Also:

#get_resource_shares(options = {}) ⇒ Types::GetResourceSharesResponse

Gets the resource shares that you own or the resource shares that are shared with you.

Examples:

Request syntax with placeholder values


resp = client.get_resource_shares({
  resource_share_arns: ["String"],
  resource_share_status: "PENDING", # accepts PENDING, ACTIVE, FAILED, DELETING, DELETED
  resource_owner: "SELF", # required, accepts SELF, OTHER-ACCOUNTS
  name: "String",
  tag_filters: [
    {
      tag_key: "TagKey",
      tag_values: ["TagValue"],
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.resource_shares #=> Array
resp.resource_shares[0].resource_share_arn #=> String
resp.resource_shares[0].name #=> String
resp.resource_shares[0]. #=> String
resp.resource_shares[0].allow_external_principals #=> true/false
resp.resource_shares[0].status #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING", "DELETED"
resp.resource_shares[0].status_message #=> String
resp.resource_shares[0].tags #=> Array
resp.resource_shares[0].tags[0].key #=> String
resp.resource_shares[0].tags[0].value #=> String
resp.resource_shares[0].creation_time #=> Time
resp.resource_shares[0].last_updated_time #=> Time
resp.resource_shares[0].feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
resp.next_token #=> String

Options Hash (options):

  • :resource_share_arns (Array<String>)

    The Amazon Resource Names (ARN) of the resource shares.

  • :resource_share_status (String)

    The status of the resource share.

  • :resource_owner (required, String)

    The type of owner.

  • :name (String)

    The name of the resource share.

  • :tag_filters (Array<Types::TagFilter>)

    One or more tag filters.

  • :next_token (String)

    The token for the next page of results.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

See Also:

#list_pending_invitation_resources(options = {}) ⇒ Types::ListPendingInvitationResourcesResponse

Lists the resources in a resource share that is shared with you but that the invitation is still pending for.

Examples:

Request syntax with placeholder values


resp = client.list_pending_invitation_resources({
  resource_share_invitation_arn: "String", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.resources #=> Array
resp.resources[0].arn #=> String
resp.resources[0].type #=> String
resp.resources[0].resource_share_arn #=> String
resp.resources[0].resource_group_arn #=> String
resp.resources[0].status #=> String, one of "AVAILABLE", "ZONAL_RESOURCE_INACCESSIBLE", "LIMIT_EXCEEDED", "UNAVAILABLE", "PENDING"
resp.resources[0].status_message #=> String
resp.resources[0].creation_time #=> Time
resp.resources[0].last_updated_time #=> Time
resp.next_token #=> String

Options Hash (options):

  • :resource_share_invitation_arn (required, String)

    The Amazon Resource Name (ARN) of the invitation.

  • :next_token (String)

    The token for the next page of results.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

See Also:

#list_permissions(options = {}) ⇒ Types::ListPermissionsResponse

Lists the AWS RAM permissions.

Examples:

Request syntax with placeholder values


resp = client.list_permissions({
  resource_type: "String",
  next_token: "String",
  max_results: 1,
})

Response structure


resp.permissions #=> Array
resp.permissions[0].arn #=> String
resp.permissions[0].version #=> String
resp.permissions[0].default_version #=> true/false
resp.permissions[0].name #=> String
resp.permissions[0].resource_type #=> String
resp.permissions[0].status #=> String
resp.permissions[0].creation_time #=> Time
resp.permissions[0].last_updated_time #=> Time
resp.next_token #=> String

Options Hash (options):

  • :resource_type (String)

    Specifies the resource type for which to list permissions. For example, to list only permissions that apply to EC2 subnets, specify ec2:Subnet.

  • :next_token (String)

    The token for the next page of results.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

See Also:

#list_principals(options = {}) ⇒ Types::ListPrincipalsResponse

Lists the principals that you have shared resources with or that have shared resources with you.

Examples:

Request syntax with placeholder values


resp = client.list_principals({
  resource_owner: "SELF", # required, accepts SELF, OTHER-ACCOUNTS
  resource_arn: "String",
  principals: ["String"],
  resource_type: "String",
  resource_share_arns: ["String"],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.principals #=> Array
resp.principals[0].id #=> String
resp.principals[0].resource_share_arn #=> String
resp.principals[0].creation_time #=> Time
resp.principals[0].last_updated_time #=> Time
resp.principals[0].external #=> true/false
resp.next_token #=> String

Options Hash (options):

  • :resource_owner (required, String)

    The type of owner.

  • :resource_arn (String)

    The Amazon Resource Name (ARN) of the resource.

  • :principals (Array<String>)

    The principals.

  • :resource_type (String)

    The resource type.

    Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule

  • :resource_share_arns (Array<String>)

    The Amazon Resource Names (ARN) of the resource shares.

  • :next_token (String)

    The token for the next page of results.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

See Also:

#list_resource_share_permissions(options = {}) ⇒ Types::ListResourceSharePermissionsResponse

Lists the AWS RAM permissions that are associated with a resource share.

Examples:

Request syntax with placeholder values


resp = client.list_resource_share_permissions({
  resource_share_arn: "String", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.permissions #=> Array
resp.permissions[0].arn #=> String
resp.permissions[0].version #=> String
resp.permissions[0].default_version #=> true/false
resp.permissions[0].name #=> String
resp.permissions[0].resource_type #=> String
resp.permissions[0].status #=> String
resp.permissions[0].creation_time #=> Time
resp.permissions[0].last_updated_time #=> Time
resp.next_token #=> String

Options Hash (options):

  • :resource_share_arn (required, String)

    The Amazon Resource Name (ARN) of the resource share.

  • :next_token (String)

    The token for the next page of results.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

See Also:

#list_resource_types(options = {}) ⇒ Types::ListResourceTypesResponse

Lists the shareable resource types supported by AWS RAM.

Examples:

Request syntax with placeholder values


resp = client.list_resource_types({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.resource_types #=> Array
resp.resource_types[0].resource_type #=> String
resp.resource_types[0].service_name #=> String
resp.next_token #=> String

Options Hash (options):

  • :next_token (String)

    The token for the next page of results.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

See Also:

#list_resources(options = {}) ⇒ Types::ListResourcesResponse

Lists the resources that you added to a resource shares or the resources that are shared with you.

Examples:

Request syntax with placeholder values


resp = client.list_resources({
  resource_owner: "SELF", # required, accepts SELF, OTHER-ACCOUNTS
  principal: "String",
  resource_type: "String",
  resource_arns: ["String"],
  resource_share_arns: ["String"],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.resources #=> Array
resp.resources[0].arn #=> String
resp.resources[0].type #=> String
resp.resources[0].resource_share_arn #=> String
resp.resources[0].resource_group_arn #=> String
resp.resources[0].status #=> String, one of "AVAILABLE", "ZONAL_RESOURCE_INACCESSIBLE", "LIMIT_EXCEEDED", "UNAVAILABLE", "PENDING"
resp.resources[0].status_message #=> String
resp.resources[0].creation_time #=> Time
resp.resources[0].last_updated_time #=> Time
resp.next_token #=> String

Options Hash (options):

  • :resource_owner (required, String)

    The type of owner.

  • :principal (String)

    The principal.

  • :resource_type (String)

    The resource type.

    Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule

  • :resource_arns (Array<String>)

    The Amazon Resource Names (ARN) of the resources.

  • :resource_share_arns (Array<String>)

    The Amazon Resource Names (ARN) of the resource shares.

  • :next_token (String)

    The token for the next page of results.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

See Also:

#promote_resource_share_created_from_policy(options = {}) ⇒ Types::PromoteResourceShareCreatedFromPolicyResponse

Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM.

Use this API action to promote the resource share. When you promote the resource share, it becomes:

  • Visible to all principals that it is shared with.

  • Modifiable in AWS RAM.

Examples:

Request syntax with placeholder values


resp = client.promote_resource_share_created_from_policy({
  resource_share_arn: "String", # required
})

Response structure


resp.return_value #=> true/false

Options Hash (options):

  • :resource_share_arn (required, String)

    The ARN of the resource share to promote.

Returns:

See Also:

#reject_resource_share_invitation(options = {}) ⇒ Types::RejectResourceShareInvitationResponse

Rejects an invitation to a resource share from another AWS account.

Examples:

Request syntax with placeholder values


resp = client.reject_resource_share_invitation({
  resource_share_invitation_arn: "String", # required
  client_token: "String",
})

Response structure


resp.resource_share_invitation.resource_share_invitation_arn #=> String
resp.resource_share_invitation.resource_share_name #=> String
resp.resource_share_invitation.resource_share_arn #=> String
resp.resource_share_invitation. #=> String
resp.resource_share_invitation. #=> String
resp.resource_share_invitation.invitation_timestamp #=> Time
resp.resource_share_invitation.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "EXPIRED"
resp.resource_share_invitation.resource_share_associations #=> Array
resp.resource_share_invitation.resource_share_associations[0].resource_share_arn #=> String
resp.resource_share_invitation.resource_share_associations[0].resource_share_name #=> String
resp.resource_share_invitation.resource_share_associations[0].associated_entity #=> String
resp.resource_share_invitation.resource_share_associations[0].association_type #=> String, one of "PRINCIPAL", "RESOURCE"
resp.resource_share_invitation.resource_share_associations[0].status #=> String, one of "ASSOCIATING", "ASSOCIATED", "FAILED", "DISASSOCIATING", "DISASSOCIATED"
resp.resource_share_invitation.resource_share_associations[0].status_message #=> String
resp.resource_share_invitation.resource_share_associations[0].creation_time #=> Time
resp.resource_share_invitation.resource_share_associations[0].last_updated_time #=> Time
resp.resource_share_invitation.resource_share_associations[0].external #=> true/false
resp.client_token #=> String

Options Hash (options):

  • :resource_share_invitation_arn (required, String)

    The Amazon Resource Name (ARN) of the invitation.

  • :client_token (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

See Also:

#tag_resource(options = {}) ⇒ Struct

Adds the specified tags to the specified resource share that you own.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_share_arn: "String", # required
  tags: [ # required
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Options Hash (options):

  • :resource_share_arn (required, String)

    The Amazon Resource Name (ARN) of the resource share.

  • :tags (required, Array<Types::Tag>)

    One or more tags.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#untag_resource(options = {}) ⇒ Struct

Removes the specified tags from the specified resource share that you own.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_share_arn: "String", # required
  tag_keys: ["TagKey"], # required
})

Options Hash (options):

  • :resource_share_arn (required, String)

    The Amazon Resource Name (ARN) of the resource share.

  • :tag_keys (required, Array<String>)

    The tag keys of the tags to remove.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_resource_share(options = {}) ⇒ Types::UpdateResourceShareResponse

Updates the specified resource share that you own.

Examples:

Request syntax with placeholder values


resp = client.update_resource_share({
  resource_share_arn: "String", # required
  name: "String",
  allow_external_principals: false,
  client_token: "String",
})

Response structure


resp.resource_share.resource_share_arn #=> String
resp.resource_share.name #=> String
resp.resource_share. #=> String
resp.resource_share.allow_external_principals #=> true/false
resp.resource_share.status #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING", "DELETED"
resp.resource_share.status_message #=> String
resp.resource_share.tags #=> Array
resp.resource_share.tags[0].key #=> String
resp.resource_share.tags[0].value #=> String
resp.resource_share.creation_time #=> Time
resp.resource_share.last_updated_time #=> Time
resp.resource_share.feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
resp.client_token #=> String

Options Hash (options):

  • :resource_share_arn (required, String)

    The Amazon Resource Name (ARN) of the resource share.

  • :name (String)

    The name of the resource share.

  • :allow_external_principals (Boolean)

    Indicates whether principals outside your AWS organization can be associated with a resource share.

  • :client_token (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {})

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.