Class: Aws::RAM::Client

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

Overview

An API client for RAM. To construct a client, you need to configure a :region and :credentials.

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

For details on configuring region and credentials see the developer guide.

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

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::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

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

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

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

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    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/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials 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 searched 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.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

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

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :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 or custom endpoints. This should be a valid 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.

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

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

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

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

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

    @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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

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

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle 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.

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



324
325
326
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 324

def initialize(*args)
  super
end

Instance Method Details

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

Accepts an invitation to a resource share from another Amazon Web Services 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.resource_share_invitation.receiver_arn #=> String
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:



378
379
380
381
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 378

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 (ARNs) of the resources.

  • :principals (Array<String>) —

    The principals to associate with the resource share. The possible values are:

    • An Amazon Web Services account ID

    • An Amazon Resource Name (ARN) of an organization in Organizations

    • An ARN of an organizational unit (OU) in Organizations

    • An ARN of an IAM role

    • An ARN of an IAM user

    Not all resource types can be shared with IAM roles and IAM users. For more information, see Sharing with IAM roles and IAM users in the Resource Access Manager User Guide.

  • :client_token (String) —

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

Returns:

See Also:



452
453
454
455
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 452

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

#associate_resource_share_permission(params = {}) ⇒ 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",
  permission_version: 1,
})

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.

  • :permission_arn (required, String) —

    The Amazon Resource Name (ARN) of the 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.

  • :permission_version (Integer) —

    The version of the RAM permissions to associate with the resource share.

Returns:

See Also:



504
505
506
507
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 504

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

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

Creates a resource share. You must provide a list of the Amazon Resource Names (ARNs) for the resources you want to share. You must also specify who you want to share the resources with, and the permissions that you grant them.

Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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 #=> 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.resource_share.feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
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 ARNs of the resources to associate with the resource share.

  • :principals (Array<String>) —

    The principals to associate with the resource share. The possible values are:

    • An Amazon Web Services account ID

    • An Amazon Resource Name (ARN) of an organization in Organizations

    • An ARN of an organizational unit (OU) in Organizations

    • An ARN of an IAM role

    • An ARN of an IAM user

    Not all resource types can be shared with IAM roles and IAM users. For more information, see Sharing with IAM roles and IAM users in the Resource Access Manager User Guide.

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

    One or more tags.

  • :allow_external_principals (Boolean) —

    Indicates whether principals outside your organization in Organizations 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 Amazon Resource Names (ARNs) of the permissions to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. Only one permission can be associated with each resource type in a resource share.

Returns:

See Also:



611
612
613
614
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 611

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:



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

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



699
700
701
702
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 699

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

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

Disassociates an 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 #=> 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.

  • :permission_arn (required, String) —

    The Amazon Resource Name (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:



739
740
741
742
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 739

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

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

Enables resource sharing within your organization in Organizations.

The caller must be the master account for the organization.

Examples:

Response structure


resp.return_value #=> Boolean

Parameters:

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

    ({})

Returns:

See Also:



760
761
762
763
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 760

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

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

Gets the contents of an 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 #=> Boolean
resp.permission.name #=> String
resp.permission.resource_type #=> String
resp.permission.permission #=> String
resp.permission.creation_time #=> Time
resp.permission.last_updated_time #=> Time
resp.permission.is_resource_type_default #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :permission_arn (required, String) —

    The Amazon Resource Name (ARN) of the permission.

  • :permission_version (Integer) —

    The identifier for the version of the permission.

Returns:

See Also:



800
801
802
803
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 800

def get_permission(params = {}, options = {})
  req = build_request(:get_permission, 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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 (ARNs) 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:



848
849
850
851
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 848

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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



920
921
922
923
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 920

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 that you have received for resource shares.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.resource_share_invitations[0].receiver_arn #=> String
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:



984
985
986
987
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 984

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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,
  permission_arn: "String",
})

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.resource_shares[0].feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_share_arns (Array<String>) —

    The Amazon Resource Names (ARNs) 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.

  • :permission_arn (String) —

    The Amazon Resource Name (ARN) of the RAM permission that is associated with the resource share.

Returns:

See Also:



1065
1066
1067
1068
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1065

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

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:



1116
1117
1118
1119
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1116

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

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

Lists the RAM permissions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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 #=> Boolean
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.permissions[0].is_resource_type_default #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



1169
1170
1171
1172
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1169

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

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule | s3-outposts:Outpost | ssm-contacts:Contact | ssm-incidents:ResponsePlan

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



1251
1252
1253
1254
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1251

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

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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 #=> Boolean
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.permissions[0].is_resource_type_default #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



1302
1303
1304
1305
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1302

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

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

Lists the shareable resource types supported by RAM.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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



1342
1343
1344
1345
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1342

def list_resource_types(params = {}, options = {})
  req = build_request(:list_resource_types, 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

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: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule | s3-outposts:Outpost | ssm-contacts:Contact | ssm-incidents:ResponsePlan

  • :resource_arns (Array<String>) —

    The Amazon Resource Names (ARNs) 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:



1427
1428
1429
1430
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1427

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_share_arn (required, String) —

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

Returns:

See Also:



1464
1465
1466
1467
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1464

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

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

Rejects an invitation to a resource share from another Amazon Web Services 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.resource_share_invitation.receiver_arn #=> String
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:



1517
1518
1519
1520
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1517

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:



1548
1549
1550
1551
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1548

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:



1575
1576
1577
1578
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1575

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.resource_share.feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
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 organization in Organizations 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:



1630
1631
1632
1633
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1630

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