RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/RAM/Client.html below:

Client — AWS SDK for Ruby V2

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

Class: Aws::RAM::Client 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:

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.

Attribute Summary collapse

Instance Attribute Summary Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::RAM::Client constructor Constructs an API client.

API Operations collapse

#accept_resource_share_invitation(options = {}) ⇒ Types::AcceptResourceShareInvitationResponse Accepts an invitation to a resource share from another AWS account. .
#associate_resource_share(options = {}) ⇒ Types::AssociateResourceShareResponse Associates the specified resource share with the specified principals and resources. .
#associate_resource_share_permission(options = {}) ⇒ Types::AssociateResourceSharePermissionResponse Associates a permission with a resource share. .
#create_resource_share(options = {}) ⇒ Types::CreateResourceShareResponse Creates a resource share. .
#delete_resource_share(options = {}) ⇒ Types::DeleteResourceShareResponse Deletes the specified resource share. .
#disassociate_resource_share(options = {}) ⇒ Types::DisassociateResourceShareResponse Disassociates the specified principals or resources from the specified resource share. .
#disassociate_resource_share_permission(options = {}) ⇒ Types::DisassociateResourceSharePermissionResponse Disassociates an AWS RAM permission from a resource share. .
#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. .
#get_permission(options = {}) ⇒ Types::GetPermissionResponse Gets the contents of an AWS RAM permission in JSON format. .
#get_resource_policies(options = {}) ⇒ Types::GetResourcePoliciesResponse Gets the policies for the specified resources that you own and have shared. .
#get_resource_share_associations(options = {}) ⇒ Types::GetResourceShareAssociationsResponse Gets the resources or principals for the resource shares that you own. .
#get_resource_share_invitations(options = {}) ⇒ Types::GetResourceShareInvitationsResponse Gets the invitations for resource sharing that you've received. .
#get_resource_shares(options = {}) ⇒ Types::GetResourceSharesResponse Gets the resource shares that you own or the resource shares that are shared with you. .
#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. .
#list_permissions(options = {}) ⇒ Types::ListPermissionsResponse Lists the AWS RAM permissions. .
#list_principals(options = {}) ⇒ Types::ListPrincipalsResponse Lists the principals that you have shared resources with or that have shared resources with you. .
#list_resource_share_permissions(options = {}) ⇒ Types::ListResourceSharePermissionsResponse Lists the AWS RAM permissions that are associated with a resource share. .
#list_resource_types(options = {}) ⇒ Types::ListResourceTypesResponse Lists the shareable resource types supported by AWS RAM. .
#list_resources(options = {}) ⇒ Types::ListResourcesResponse Lists the resources that you added to a resource shares or the resources that are shared with you. .
#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.
#reject_resource_share_invitation(options = {}) ⇒ Types::RejectResourceShareInvitationResponse Rejects an invitation to a resource share from another AWS account. .
#tag_resource(options = {}) ⇒ Struct Adds the specified tags to the specified resource share that you own. .
#untag_resource(options = {}) ⇒ Struct Removes the specified tags from the specified resource share that you own. .
#update_resource_share(options = {}) ⇒ Types::UpdateResourceShareResponse Updates the specified resource share that you own. .

Instance Method Summary collapse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol> Returns the list of supported waiters.

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

Instance Method Details

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

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

Associates a permission with a resource share.

Creates a resource share.

Deletes the specified resource share.

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

Disassociates an AWS RAM permission from a resource share.

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

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

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

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

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

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

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

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

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.

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

#tag_resource(options = {}) ⇒ Struct

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

#untag_resource(options = {}) ⇒ Struct

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

Updates the specified resource share that you own.

#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

#waiter_names ⇒ Array<Symbol>

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

Waiter Name Client Method Default Delay: Default Max Attempts:

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4