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

Class: Aws::RAM::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

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

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    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.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

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

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



251
252
253
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 251

def initialize(*args)
  super
end

Instance Method Details

#accept_resource_share_invitation(params = {}) ⇒ 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 #=> Boolean
resp.client_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



303
304
305
306
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 303

def accept_resource_share_invitation(params = {}, options = {})
  req = build_request(:accept_resource_share_invitation, params)
  req.send_request(options)
end

#associate_resource_share(params = {}) ⇒ 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 #=> Boolean
resp.client_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



356
357
358
359
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 356

def associate_resource_share(params = {}, options = {})
  req = build_request(:associate_resource_share, params)
  req.send_request(options)
end

#create_resource_share(params = {}) ⇒ 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",
})

Response structure


resp.resource_share.resource_share_arn #=> String
resp.resource_share.name #=> String
resp.resource_share. #=> String
resp.resource_share.allow_external_principals #=> Boolean
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.client_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



426
427
428
429
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 426

def create_resource_share(params = {}, options = {})
  req = build_request(:create_resource_share, params)
  req.send_request(options)
end

#delete_resource_share(params = {}) ⇒ 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 #=> Boolean
resp.client_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



461
462
463
464
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 461

def delete_resource_share(params = {}, options = {})
  req = build_request(:delete_resource_share, params)
  req.send_request(options)
end

#disassociate_resource_share(params = {}) ⇒ 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 #=> Boolean
resp.client_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



514
515
516
517
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 514

def disassociate_resource_share(params = {}, options = {})
  req = build_request(:disassociate_resource_share, params)
  req.send_request(options)
end

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

Enables resource sharing within your AWS Organization.

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

Examples:

Response structure


resp.return_value #=> Boolean

Parameters:

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

    ({})

Returns:

See Also:



535
536
537
538
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 535

def enable_sharing_with_aws_organization(params = {}, options = {})
  req = build_request(:enable_sharing_with_aws_organization, params)
  req.send_request(options)
end

#get_resource_policies(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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



581
582
583
584
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 581

def get_resource_policies(params = {}, options = {})
  req = build_request(:get_resource_policies, params)
  req.send_request(options)
end

#get_resource_share_associations(params = {}) ⇒ 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 #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :association_type (required, String)

    The association type.

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



648
649
650
651
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 648

def get_resource_share_associations(params = {}, options = {})
  req = build_request(:get_resource_share_associations, params)
  req.send_request(options)
end

#get_resource_share_invitations(params = {}) ⇒ 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 #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



709
710
711
712
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 709

def get_resource_share_invitations(params = {}, options = {})
  req = build_request(:get_resource_share_invitations, params)
  req.send_request(options)
end

#get_resource_shares(params = {}) ⇒ 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 #=> Boolean
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.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



782
783
784
785
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 782

def get_resource_shares(params = {}, options = {})
  req = build_request(:get_resource_shares, params)
  req.send_request(options)
end

#list_pending_invitation_resources(params = {}) ⇒ 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].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

Parameters:

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

    ({})

Options Hash (params):

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



830
831
832
833
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 830

def list_pending_invitation_resources(params = {}, options = {})
  req = build_request(:list_pending_invitation_resources, params)
  req.send_request(options)
end

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

Lists the principals that you have shared resources with or the principals 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 #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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: route53resolver:ResolverRule | ec2:TransitGateway | ec2:Subnet | license-manager:LicenseConfiguration

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



895
896
897
898
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 895

def list_principals(params = {}, options = {})
  req = build_request(:list_principals, params)
  req.send_request(options)
end

#list_resources(params = {}) ⇒ 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].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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_owner (required, String)

    The type of owner.

  • :principal (String)

    The principal.

  • :resource_type (String)

    The resource type.

    Valid values: route53resolver:ResolverRule | ec2:TransitGateway | ec2:Subnet | license-manager:LicenseConfiguration

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



962
963
964
965
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 962

def list_resources(params = {}, options = {})
  req = build_request(:list_resources, params)
  req.send_request(options)
end

#reject_resource_share_invitation(params = {}) ⇒ 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 #=> Boolean
resp.client_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



1013
1014
1015
1016
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1013

def reject_resource_share_invitation(params = {}, options = {})
  req = build_request(:reject_resource_share_invitation, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ 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",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

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



1044
1045
1046
1047
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1044

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

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



1071
1072
1073
1074
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1071

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_resource_share(params = {}) ⇒ 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 #=> Boolean
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.client_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



1125
1126
1127
1128
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1125

def update_resource_share(params = {}, options = {})
  req = build_request(:update_resource_share, params)
  req.send_request(options)
end