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. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :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.

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

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

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

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

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

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.

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

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

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

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::RAM::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::RAM::EndpointParameters

  • :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 (Float) — 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.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

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



385
386
387
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 385

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. After you accept the invitation, the resources included in the resource share are available to interact with in the relevant Amazon Web Services Management Consoles and tools.

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 that you want to accept.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Returns:

See Also:



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

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

Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share.

Examples:

Request syntax with placeholder values


resp = client.associate_resource_share({
  resource_share_arn: "String", # required
  resource_arns: ["String"],
  principals: ["String"],
  client_token: "String",
  sources: ["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) —

    Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.

  • :resource_arns (Array<String>) —

    Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be null if you want to add only principals.

  • :principals (Array<String>) —

    Specifies a list of principals to whom you want to the resource share. This can be null if you want to add only resources.

    What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.

    You can include the following values:

    • An Amazon Web Services account ID, for example: 123456789012

    • An Amazon Resource Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

    • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

    • An ARN of an IAM role, for example: iam::123456789012:role/rolename

    • An ARN of an IAM user, for example: iam::123456789012user/username

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

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

  • :sources (Array<String>) —

    Specifies from which source accounts the service principal has access to the resources in this resource share.

Returns:

See Also:



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

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

Adds or replaces the RAM permission for a resource type included in a resource share. You can have exactly one permission associated with each resource type in the resource share. You can add a new RAM permission only if there are currently no resources of that resource type currently in the 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) —

    Specifies the Amazon Resource Name (ARN) of the resource share to which you want to add or replace permissions.

  • :permission_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the RAM permission to associate with the resource share. To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and then choose the name of the permission. The ARN is displayed on the detail page.

  • :replace (Boolean) —

    Specifies whether the specified permission should replace the existing permission associated with the resource share. Use true to replace the current permissions. Use false to add the permission to a resource share that currently doesn't have a permission. The default value is false.

    A resource share can have only one permission per resource type. If a resource share already has a permission for the specified resource type and you don't set replace to true then the operation returns an error. This helps prevent accidental overwriting of a permission.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

  • :permission_version (Integer) —

    Specifies the version of the RAM permission to associate with the resource share. You can specify only the version that is currently set as the default version for the permission. If you also set the replace pararameter to true, then this operation updates an outdated version of the permission to the current default version.

    You don't need to specify this parameter because the default behavior is to use the version that is currently set as the default version for the permission. This parameter is supported for backwards compatibility.

Returns:

See Also:



682
683
684
685
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 682

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

#create_permission(params = {}) ⇒ Types::CreatePermissionResponse

Creates a customer managed permission for a specified resource type that you can attach to resource shares. It is created in the Amazon Web Services Region in which you call the operation.

Examples:

Request syntax with placeholder values


resp = client.create_permission({
  name: "PermissionName", # required
  resource_type: "String", # required
  policy_template: "Policy", # required
  client_token: "String",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

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.status #=> String
resp.permission.creation_time #=> Time
resp.permission.last_updated_time #=> Time
resp.permission.is_resource_type_default #=> Boolean
resp.permission.permission_type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
resp.permission.feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
resp.permission.tags #=> Array
resp.permission.tags[0].key #=> String
resp.permission.tags[0].value #=> String
resp.client_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    Specifies the name of the customer managed permission. The name must be unique within the Amazon Web Services Region.

  • :resource_type (required, String) —

    Specifies the name of the resource type that this customer managed permission applies to.

    The format is <service-code>:<resource-type> and is not case sensitive. For example, to specify an Amazon EC2 Subnet, you can use the string ec2:subnet. To see the list of valid values for this parameter, query the ListResourceTypes operation.

  • :policy_template (required, String) —

    A string in JSON format string that contains the following elements of a resource-based policy:

    • Effect: must be set to ALLOW.

    • Action: specifies the actions that are allowed by this customer managed permission. The list must contain only actions that are supported by the specified resource type. For a list of all actions supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access Management User Guide.

    • Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an action for that action to be allowed. For more information about the Condition element, see IAM policies: Condition element in the Identity and Access Management User Guide.

    This template can't include either the Resource or Principal elements. Those are both filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed permission. The Resource comes from the ARN of the specific resource that you are sharing. The Principal comes from the list of identities added to the resource share.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

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

    Specifies a list of one or more tag key and value pairs to attach to the permission.

Returns:

See Also:



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

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

#create_permission_version(params = {}) ⇒ Types::CreatePermissionVersionResponse

Creates a new version of the specified customer managed permission. The new version is automatically set as the default version of the customer managed permission. New resource shares automatically use the default permission. Existing resource shares continue to use their original permission versions, but you can use ReplacePermissionAssociations to update them.

If the specified customer managed permission already has the maximum of 5 versions, then you must delete one of the existing versions before you can create a new one.

Examples:

Request syntax with placeholder values


resp = client.create_permission_version({
  permission_arn: "String", # required
  policy_template: "Policy", # required
  client_token: "String",
})

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
resp.permission.permission_type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
resp.permission.feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
resp.permission.status #=> String, one of "ATTACHABLE", "UNATTACHABLE", "DELETING", "DELETED"
resp.permission.tags #=> Array
resp.permission.tags[0].key #=> String
resp.permission.tags[0].value #=> String
resp.client_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :permission_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the customer managed permission you're creating a new version for.

  • :policy_template (required, String) —

    A string in JSON format string that contains the following elements of a resource-based policy:

    • Effect: must be set to ALLOW.

    • Action: specifies the actions that are allowed by this customer managed permission. The list must contain only actions that are supported by the specified resource type. For a list of all actions supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access Management User Guide.

    • Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an action for that action to be allowed. For more information about the Condition element, see IAM policies: Condition element in the Identity and Access Management User Guide.

    This template can't include either the Resource or Principal elements. Those are both filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed permission. The Resource comes from the ARN of the specific resource that you are sharing. The Principal comes from the list of identities added to the resource share.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Returns:

See Also:



910
911
912
913
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 910

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

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

Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

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"],
  sources: ["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) —

    Specifies the name of the resource share.

  • :resource_arns (Array<String>) —

    Specifies a list of one or more ARNs of the resources to associate with the resource share.

  • :principals (Array<String>) —

    Specifies a list of one or more principals to associate with the resource share.

    You can include the following values:

    • An Amazon Web Services account ID, for example: 123456789012

    • An Amazon Resource Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

    • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

    • An ARN of an IAM role, for example: iam::123456789012:role/rolename

    • An ARN of an IAM user, for example: iam::123456789012user/username

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

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

    Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share.

  • :allow_external_principals (Boolean) —

    Specifies whether principals outside your organization in Organizations can be associated with a resource share. A value of true lets you share with individual Amazon Web Services accounts that are not in your organization. A value of false only has meaning if your account is a member of an Amazon Web Services Organization. The default value is true.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

  • :permission_arns (Array<String>) —

    Specifies the Amazon Resource Names (ARNs) of the RAM permission 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. You can associate only one permission with each resource type included in the resource share.

  • :sources (Array<String>) —

    Specifies from which source accounts the service principal has access to the resources in this resource share.

Returns:

See Also:



1059
1060
1061
1062
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1059

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

#delete_permission(params = {}) ⇒ Types::DeletePermissionResponse

Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation. You can delete a customer managed permission only if it isn't attached to any resource share. The operation deletes all versions associated with the customer managed permission.

Examples:

Request syntax with placeholder values


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

Response structure


resp.return_value #=> Boolean
resp.client_token #=> String
resp.permission_status #=> String, one of "ATTACHABLE", "UNATTACHABLE", "DELETING", "DELETED"

Parameters:

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

    ({})

Options Hash (params):

  • :permission_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the customer managed permission that you want to delete.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Returns:

See Also:



1120
1121
1122
1123
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1120

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

#delete_permission_version(params = {}) ⇒ Types::DeletePermissionVersionResponse

Deletes one version of a customer managed permission. The version you specify must not be attached to any resource share and must not be the default version for the permission.

If a customer managed permission has the maximum of 5 versions, then you must delete at least one version before you can create another.

Examples:

Request syntax with placeholder values


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

Response structure


resp.return_value #=> Boolean
resp.client_token #=> String
resp.permission_status #=> String, one of "ATTACHABLE", "UNATTACHABLE", "DELETING", "DELETED"

Parameters:

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

    ({})

Options Hash (params):

  • :permission_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the permission with the version you want to delete.

  • :permission_version (required, Integer) —

    Specifies the version number to delete.

    You can't delete the default version for a customer managed permission.

    You can't delete a version if it's the only version of the permission. You must either first create another version, or delete the permission completely.

    You can't delete a version if it is attached to any resource shares. If the version is the default, you must first use SetDefaultPermissionVersion to set a different version as the default for the customer managed permission, and then use AssociateResourceSharePermission to update your resource shares to use the new default version.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Returns:

See Also:



1200
1201
1202
1203
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1200

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

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

Deletes the specified resource share.

This doesn't delete any of the resources that were associated with the resource share; it only stops the sharing of those resources through this 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) —

    Specifies the Amazon Resource Name (ARN) of the resource share to delete.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Returns:

See Also:



1259
1260
1261
1262
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1259

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

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

Removes the specified principals or resources from participating in 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",
  sources: ["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) —

    Specifies Amazon Resource Name (ARN) of the resource share that you want to remove resources or principals from.

  • :resource_arns (Array<String>) —

    Specifies a list of Amazon Resource Names (ARNs) for one or more resources that you want to remove from the resource share. After the operation runs, these resources are no longer shared with principals associated with the resource share.

  • :principals (Array<String>) —

    Specifies a list of one or more principals that no longer are to have access to the resources in this resource share.

    You can include the following values:

    • An Amazon Web Services account ID, for example: 123456789012

    • An Amazon Resource Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

    • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

    • An ARN of an IAM role, for example: iam::123456789012:role/rolename

    • An ARN of an IAM user, for example: iam::123456789012user/username

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

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

  • :sources (Array<String>) —

    Specifies from which source accounts the service principal no longer has access to the resources in this resource share.

Returns:

See Also:



1372
1373
1374
1375
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1372

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

Removes a managed permission from a resource share. Permission changes take effect immediately. You can remove a managed permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the 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 that you want to remove the managed permission from.

  • :permission_arn (required, String) —

    The Amazon Resource Name (ARN) of the managed permission to disassociate from the resource share. Changes to permissions take effect immediately.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Returns:

See Also:



1440
1441
1442
1443
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1440

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. This operation creates a service-linked role called AWSServiceRoleForResourceAccessManager that has the IAM managed policy named AWSResourceAccessManagerServiceRolePolicy attached. This role permits RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in the calling account's organization by specifying the organization ID, or all of the accounts in an organizational unit (OU) by specifying the OU ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM roles and users.

You must call this operation from an IAM role or user in the organization's management account.

Examples:

Response structure


resp.return_value #=> Boolean

Parameters:

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

    ({})

Returns:

See Also:



1472
1473
1474
1475
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1472

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

Retrieves the contents of a managed 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
resp.permission.permission_type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
resp.permission.feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
resp.permission.status #=> String, one of "ATTACHABLE", "UNATTACHABLE", "DELETING", "DELETED"
resp.permission.tags #=> Array
resp.permission.tags[0].key #=> String
resp.permission.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :permission_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the permission whose contents you want to retrieve. To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and then choose the name of the permission. The ARN is displayed on the detail page.

  • :permission_version (Integer) —

    Specifies the version number of the RAM permission to retrieve. If you don't specify this parameter, the operation retrieves the default version.

    To see the list of available versions, use ListPermissionVersions.

Returns:

See Also:



1531
1532
1533
1534
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1531

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

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

Retrieves the resource 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>) —

    Specifies the Amazon Resource Names (ARNs) of the resources whose policies you want to retrieve.

  • :principal (String) —

    Specifies the principal.

  • :next_token (String) —

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • :max_results (Integer) —

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

See Also:



1595
1596
1597
1598
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1595

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

Retrieves the lists of resources and principals that associated for 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) —

    Specifies whether you want to retrieve the associations that involve a specified resource or principal.

    • PRINCIPAL – list the principals whose associations you want to see.

    • RESOURCE – list the resources whose associations you want to see.

  • :resource_share_arns (Array<String>) —

    Specifies a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to retrieve.

  • :resource_arn (String) —

    Specifies the Amazon Resource Name (ARN) of a resource whose resource shares you want to retrieve.

    You cannot specify this parameter if the association type is PRINCIPAL.

  • :principal (String) —

    Specifies the ID of the principal whose resource shares you want to retrieve. This can be an Amazon Web Services account ID, an organization ID, an organizational unit ID, or the Amazon Resource Name (ARN) of an individual IAM role or user.

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

  • :association_status (String) —

    Specifies that you want to retrieve only associations that have this status.

  • :next_token (String) —

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • :max_results (Integer) —

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

See Also:



1704
1705
1706
1707
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1704

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

Retrieves details about 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>) —

    Specifies the Amazon Resource Names (ARNs) of the resource share invitations you want information about.

  • :resource_share_arns (Array<String>) —

    Specifies that you want details about invitations only for the resource shares described by this list of Amazon Resource Names (ARNs)

  • :next_token (String) —

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • :max_results (Integer) —

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

See Also:



1791
1792
1793
1794
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1791

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

Retrieves details about the resource shares that you own or 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",
  permission_version: 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.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>) —

    Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

  • :resource_share_status (String) —

    Specifies that you want to retrieve details of only those resource shares that have this status.

  • :resource_owner (required, String) —

    Specifies that you want to retrieve details of only those resource shares that match the following:

    • SELF – resource shares that your account shares with other accounts

    • OTHER-ACCOUNTS – resource shares that other accounts share with your account

  • :name (String) —

    Specifies the name of an individual resource share that you want to retrieve details about.

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

    Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

  • :next_token (String) —

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • :max_results (Integer) —

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • :permission_arn (String) —

    Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).

  • :permission_version (Integer) —

    Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.

Returns:

See Also:



1908
1909
1910
1911
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1908

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 for which the invitation is still PENDING. That means that you haven't accepted or rejected the invitation and the invitation hasn't expired.

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,
  resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
})

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.resources[0].resource_region_scope #=> String, one of "REGIONAL", "GLOBAL"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_share_invitation_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN of the invitation.

  • :next_token (String) —

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • :max_results (Integer) —

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • :resource_region_scope (String) —

    Specifies that you want the results to include only resources that have the specified scope.

    • ALL – the results include both global and regional resources or resource types.

    • GLOBAL – the results include only global resources or resource types.

    • REGIONAL – the results include only regional resources or resource types.

    The default value is ALL.

Returns:

See Also:



1994
1995
1996
1997
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1994

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

#list_permission_associations(params = {}) ⇒ Types::ListPermissionAssociationsResponse

Lists information about the managed permission and its associations to any resource shares that use this managed permission. This lets you see which resource shares use which versions of the specified managed permission.

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_permission_associations({
  permission_arn: "String",
  permission_version: 1,
  association_status: "ASSOCIATING", # accepts ASSOCIATING, ASSOCIATED, FAILED, DISASSOCIATING, DISASSOCIATED
  resource_type: "String",
  feature_set: "CREATED_FROM_POLICY", # accepts CREATED_FROM_POLICY, PROMOTING_TO_STANDARD, STANDARD
  default_version: false,
  next_token: "String",
  max_results: 1,
})

Response structure


resp.permissions #=> Array
resp.permissions[0].arn #=> String
resp.permissions[0].permission_version #=> String
resp.permissions[0].default_version #=> Boolean
resp.permissions[0].resource_type #=> String
resp.permissions[0].status #=> String
resp.permissions[0].feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
resp.permissions[0].last_updated_time #=> Time
resp.permissions[0].resource_share_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :permission_arn (String) —

    Specifies the Amazon Resource Name (ARN) of the managed permission.

  • :permission_version (Integer) —

    Specifies that you want to list only those associations with resource shares that use this version of the managed permission. If you don't provide a value for this parameter, then the operation returns information about associations with resource shares that use any version of the managed permission.

  • :association_status (String) —

    Specifies that you want to list only those associations with resource shares that match this status.

  • :resource_type (String) —

    Specifies that you want to list only those associations with resource shares that include at least one resource of this resource type.

  • :feature_set (String) —

    Specifies that you want to list only those associations with resource shares that have a featureSet with this value.

  • :default_version (Boolean) —

    When true, specifies that you want to list only those associations with resource shares that use the default version of the specified managed permission.

    When false (the default value), lists associations with resource shares that use any version of the specified managed permission.

  • :next_token (String) —

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • :max_results (Integer) —

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

See Also:



2095
2096
2097
2098
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 2095

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

#list_permission_versions(params = {}) ⇒ Types::ListPermissionVersionsResponse

Lists the available versions of the specified RAM permission.

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_permission_versions({
  permission_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.permissions[0].permission_type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
resp.permissions[0].feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
resp.permissions[0].tags #=> Array
resp.permissions[0].tags[0].key #=> String
resp.permissions[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :permission_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the RAM permission whose versions you want to list. You can use the permissionVersion parameter on the AssociateResourceSharePermission operation to specify a non-default version to attach.

  • :next_token (String) —

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • :max_results (Integer) —

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

See Also:



2169
2170
2171
2172
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 2169

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

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

Retrieves a list of available RAM permissions that you can use for the supported resource types.

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,
  permission_type: "ALL", # accepts ALL, AWS_MANAGED, CUSTOMER_MANAGED
})

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.permissions[0].permission_type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
resp.permissions[0].feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
resp.permissions[0].tags #=> Array
resp.permissions[0].tags[0].key #=> String
resp.permissions[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_type (String) —

    Specifies that you want to list only those permissions that apply to the specified resource type. This parameter is not case sensitive.

    For example, to list only permissions that apply to Amazon EC2 subnets, specify ec2:subnet. You can use the ListResourceTypes operation to get the specific string required.

  • :next_token (String) —

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • :max_results (Integer) —

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • :permission_type (String) —

    Specifies that you want to list only permissions of this type:

    • AWS – returns only Amazon Web Services managed permissions.

    • LOCAL – returns only customer managed permissions

    • ALL – returns both Amazon Web Services managed permissions and customer managed permissions.

    If you don't specify this parameter, the default is All.

Returns:

See Also:



2255
2256
2257
2258
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 2255

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 are sharing resources with or that are sharing 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) —

    Specifies that you want to list information for only resource shares that match the following:

    • SELF – principals that your account is sharing resources with

    • OTHER-ACCOUNTS – principals that are sharing resources with your account

  • :resource_arn (String) —

    Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).

  • :principals (Array<String>) —

    Specifies that you want to list information for only the listed principals.

    You can include the following values:

    • An Amazon Web Services account ID, for example: 123456789012

    • An Amazon Resource Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

    • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

    • An ARN of an IAM role, for example: iam::123456789012:role/rolename

    • An ARN of an IAM user, for example: iam::123456789012user/username

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

  • :resource_type (String) —

    Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.

    For a list of valid values, query the ListResourceTypes operation.

  • :resource_share_arns (Array<String>) —

    Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).

  • :next_token (String) —

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • :max_results (Integer) —

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

See Also:



2380
2381
2382
2383
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 2380

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

#list_replace_permission_associations_work(params = {}) ⇒ Types::ListReplacePermissionAssociationsWorkResponse

Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.

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_replace_permission_associations_work({
  work_ids: ["String"],
  status: "IN_PROGRESS", # accepts IN_PROGRESS, COMPLETED, FAILED
  next_token: "String",
  max_results: 1,
})

Response structure


resp.replace_permission_associations_works #=> Array
resp.replace_permission_associations_works[0].id #=> String
resp.replace_permission_associations_works[0].from_permission_arn #=> String
resp.replace_permission_associations_works[0].from_permission_version #=> String
resp.replace_permission_associations_works[0].to_permission_arn #=> String
resp.replace_permission_associations_works[0].to_permission_version #=> String
resp.replace_permission_associations_works[0].status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.replace_permission_associations_works[0].status_message #=> String
resp.replace_permission_associations_works[0].creation_time #=> Time
resp.replace_permission_associations_works[0].last_updated_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :work_ids (Array<String>) —

    A list of IDs. These values come from the idfield of the replacePermissionAssociationsWorkstructure returned by the ReplacePermissionAssociations operation.

  • :status (String) —

    Specifies that you want to see only the details about requests with a status that matches this value.

  • :next_token (String) —

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • :max_results (Integer) —

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

See Also:



2450
2451
2452
2453
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 2450

def list_replace_permission_associations_work(params = {}, options = {})
  req = build_request(:list_replace_permission_associations_work, 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.permissions[0].permission_type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
resp.permissions[0].feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
resp.permissions[0].tags #=> Array
resp.permissions[0].tags[0].key #=> String
resp.permissions[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_share_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the resource share for which you want to retrieve the associated permissions.

  • :next_token (String) —

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • :max_results (Integer) —

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

See Also:



2522
2523
2524
2525
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 2522

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 resource types that can be shared 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,
  resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
})

Response structure


resp.resource_types #=> Array
resp.resource_types[0].resource_type #=> String
resp.resource_types[0].service_name #=> String
resp.resource_types[0].resource_region_scope #=> String, one of "REGIONAL", "GLOBAL"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • :max_results (Integer) —

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • :resource_region_scope (String) —

    Specifies that you want the results to include only resources that have the specified scope.

    • ALL – the results include both global and regional resources or resource types.

    • GLOBAL – the results include only global resources or resource types.

    • REGIONAL – the results include only regional resources or resource types.

    The default value is ALL.

Returns:

See Also:



2590
2591
2592
2593
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 2590

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 share 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,
  resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
})

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.resources[0].resource_region_scope #=> String, one of "REGIONAL", "GLOBAL"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_owner (required, String) —

    Specifies that you want to list only the resource shares that match the following:

    • SELF – resources that your account shares with other accounts

    • OTHER-ACCOUNTS – resources that other accounts share with your account

  • :principal (String) —

    Specifies that you want to list only the resource shares that are associated with the specified principal.

  • :resource_type (String) —

    Specifies that you want to list only the resource shares that include resources of the specified resource type.

    For valid values, query the ListResourceTypes operation.

  • :resource_arns (Array<String>) —

    Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

  • :resource_share_arns (Array<String>) —

    Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

  • :next_token (String) —

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • :max_results (Integer) —

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • :resource_region_scope (String) —

    Specifies that you want the results to include only resources that have the specified scope.

    • ALL – the results include both global and regional resources or resource types.

    • GLOBAL – the results include only global resources or resource types.

    • REGIONAL – the results include only regional resources or resource types.

    The default value is ALL.

Returns:

See Also:



2706
2707
2708
2709
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 2706

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

#promote_permission_created_from_policy(params = {}) ⇒ Types::PromotePermissionCreatedFromPolicyResponse

When you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet=CREATED_FROM_POLICY with a managed permission that has the same IAM permissions as the original resource-based policy. However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM.

This operation creates a separate, fully manageable customer managed permission that has the same IAM permissions as the original resource-based policy. You can associate this customer managed permission to any resource shares.

Before you use PromoteResourceShareCreatedFromPolicy, you should first run this operation to ensure that you have an appropriate customer managed permission that can be associated with the promoted resource share.

* The original CREATED_FROM_POLICY policy isn't deleted, and resource shares using that original policy aren't automatically updated.

  • You can't modify a CREATED_FROM_POLICY resource share so you can't associate the new customer managed permission by using ReplacePermsissionAssociations. However, if you use PromoteResourceShareCreatedFromPolicy, that operation automatically associates the fully manageable customer managed permission to the newly promoted STANDARD resource share.

  • After you promote a resource share, if the original CREATED_FROM_POLICY managed permission has no other associations to A resource share, then RAM automatically deletes it.

Examples:

Request syntax with placeholder values


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

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.status #=> String
resp.permission.creation_time #=> Time
resp.permission.last_updated_time #=> Time
resp.permission.is_resource_type_default #=> Boolean
resp.permission.permission_type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
resp.permission.feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
resp.permission.tags #=> Array
resp.permission.tags[0].key #=> String
resp.permission.tags[0].value #=> String
resp.client_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :permission_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the CREATED_FROM_POLICY permission that you want to promote. You can get this Amazon Resource Name (ARN) by calling the ListResourceSharePermissions operation.

  • :name (required, String) —

    Specifies a name for the promoted customer managed permission.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Returns:

See Also:



2813
2814
2815
2816
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 2813

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

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

When you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet=CREATED_FROM_POLICY with a managed permission that has the same IAM permissions as the original resource-based policy. However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM.

This operation promotes the resource share to a STANDARD resource share that is fully manageable in RAM. When you promote a resource share, you can then manage the resource share in RAM and it becomes visible to all of the principals you shared it with.

Before you perform this operation, you should first run PromotePermissionCreatedFromPolicyto ensure that you have an appropriate customer managed permission that can be associated with this resource share after its is promoted. If this operation can't find a managed permission that exactly matches the existing CREATED_FROM_POLICY permission, then this operation fails.

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

Returns:

See Also:



2864
2865
2866
2867
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 2864

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

    Specifies the Amazon Resource Name (ARN) of the invitation that you want to reject.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Returns:

See Also:



2937
2938
2939
2940
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 2937

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

#replace_permission_associations(params = {}) ⇒ Types::ReplacePermissionAssociationsResponse

Updates all resource shares that use a managed permission to a different managed permission. This operation always applies the default version of the target managed permission. You can optionally specify that the update applies to only resource shares that currently use a specified version. This enables you to update to the latest version, without changing the which managed permission is used.

You can use this operation to update all of your resource shares to use the current default version of the permission by specifying the same value for the fromPermissionArn and toPermissionArn parameters.

You can use the optional fromPermissionVersion parameter to update only those resources that use a specified version of the managed permission to the new managed permission.

To successfully perform this operation, you must have permission to update the resource-based policy on all affected resource types.

Examples:

Request syntax with placeholder values


resp = client.replace_permission_associations({
  from_permission_arn: "String", # required
  from_permission_version: 1,
  to_permission_arn: "String", # required
  client_token: "String",
})

Response structure


resp.replace_permission_associations_work.id #=> String
resp.replace_permission_associations_work.from_permission_arn #=> String
resp.replace_permission_associations_work.from_permission_version #=> String
resp.replace_permission_associations_work.to_permission_arn #=> String
resp.replace_permission_associations_work.to_permission_version #=> String
resp.replace_permission_associations_work.status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.replace_permission_associations_work.status_message #=> String
resp.replace_permission_associations_work.creation_time #=> Time
resp.replace_permission_associations_work.last_updated_time #=> Time
resp.client_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :from_permission_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the managed permission that you want to replace.

  • :from_permission_version (Integer) —

    Specifies that you want to updated the permissions for only those resource shares that use the specified version of the managed permission.

  • :to_permission_arn (required, String) —

    Specifies the ARN of the managed permission that you want to associate with resource shares in place of the one specified by fromPerssionArn and fromPermissionVersion.

    The operation always associates the version that is currently the default for the specified managed permission.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Returns:

See Also:



3032
3033
3034
3035
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 3032

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

#set_default_permission_version(params = {}) ⇒ Types::SetDefaultPermissionVersionResponse

Designates the specified version number as the default version for the specified customer managed permission. New resource shares automatically use this new default permission. Existing resource shares continue to use their original permission version, but you can use ReplacePermissionAssociations to update them.

Examples:

Request syntax with placeholder values


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

Response structure


resp.return_value #=> Boolean
resp.client_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :permission_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the customer managed permission whose default version you want to change.

  • :permission_version (required, Integer) —

    Specifies the version number that you want to designate as the default for customer managed permission. To see a list of all available version numbers, use ListPermissionVersions.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Returns:

See Also:



3097
3098
3099
3100
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 3097

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

#tag_resource(params = {}) ⇒ Struct

Adds the specified tag keys and values to a resource share or managed permission. If you choose a resource share, the tags are attached to only the resource share, not to the resources that are in the resource share.

The tags on a managed permission are the same for all versions of the managed permission.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_share_arn (String) —

    Specifies the Amazon Resource Name (ARN) of the resource share that you want to add tags to. You must specify either resourceShareArn, or resourceArn, but not both.

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

    A list of one or more tag key and value pairs. The tag key must be present and not be an empty string. The tag value must be present but can be an empty string.

  • :resource_arn (String) —

    Specifies the Amazon Resource Name (ARN) of the managed permission that you want to add tags to. You must specify either resourceArn, or resourceShareArn, but not both.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3152
3153
3154
3155
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 3152

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

#untag_resource(params = {}) ⇒ Struct

Removes the specified tag key and value pairs from the specified resource share or managed permission.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_share_arn (String) —

    Specifies the Amazon Resource Name (ARN) of the resource share that you want to remove tags from. The tags are removed from the resource share, not the resources in the resource share. You must specify either resourceShareArn, or resourceArn, but not both.

  • :tag_keys (required, Array<String>) —

    Specifies a list of one or more tag keys that you want to remove.

  • :resource_arn (String) —

    Specifies the Amazon Resource Name (ARN) of the managed permission that you want to remove tags from. You must specify either resourceArn, or resourceShareArn, but not both.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3196
3197
3198
3199
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 3196

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

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

Modifies some of the properties of the specified resource share.

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

    Specifies the Amazon Resource Name (ARN) of the resource share that you want to modify.

  • :name (String) —

    If specified, the new name that you want to attach to the resource share.

  • :allow_external_principals (Boolean) —

    Specifies whether principals outside your organization in Organizations can be associated with a resource share.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Returns:

See Also:



3272
3273
3274
3275
 
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 3272

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