Class: Aws::CleanRooms::Client

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

Overview

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

client = Aws::CleanRooms::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 Aws::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.

  • :endpoint (String) —

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

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

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

    The log formatter.

  • :log_level (Symbol) — default: :info —

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

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

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

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

    Specifies which retry algorithm to use. Values are:

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

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

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

  • :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 Aws::ClientStubs#stub_responses. See Aws::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::CleanRooms::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::CleanRooms::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.



370
371
372
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 370

def initialize(*args)
  super
end

Instance Method Details

#batch_get_schema(params = {}) ⇒ Types::BatchGetSchemaOutput

Retrieves multiple schemas by their identifiers.

Examples:

Request syntax with placeholder values


resp = client.batch_get_schema({
  collaboration_identifier: "CollaborationIdentifier", # required
  names: ["TableAlias"], # required
})

Response structure


resp.schemas #=> Array
resp.schemas[0].columns #=> Array
resp.schemas[0].columns[0].name #=> String
resp.schemas[0].columns[0].type #=> String
resp.schemas[0].partition_keys #=> Array
resp.schemas[0].partition_keys[0].name #=> String
resp.schemas[0].partition_keys[0].type #=> String
resp.schemas[0].analysis_rule_types #=> Array
resp.schemas[0].analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST"
resp.schemas[0].analysis_method #=> String, one of "DIRECT_QUERY"
resp.schemas[0]. #=> String
resp.schemas[0].name #=> String
resp.schemas[0].collaboration_id #=> String
resp.schemas[0].collaboration_arn #=> String
resp.schemas[0].description #=> String
resp.schemas[0].create_time #=> Time
resp.schemas[0].update_time #=> Time
resp.schemas[0].type #=> String, one of "TABLE"
resp.errors #=> Array
resp.errors[0].name #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    A unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID.

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

    The names for the schema objects to retrieve.>

Returns:

See Also:



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

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

#create_collaboration(params = {}) ⇒ Types::CreateCollaborationOutput

Creates a new collaboration.

Examples:

Request syntax with placeholder values


resp = client.create_collaboration({
  members: [ # required
    {
      account_id: "AccountId", # required
      member_abilities: ["CAN_QUERY"], # required, accepts CAN_QUERY, CAN_RECEIVE_RESULTS
      display_name: "DisplayName", # required
    },
  ],
  name: "CollaborationName", # required
  description: "CollaborationDescription", # required
  creator_member_abilities: ["CAN_QUERY"], # required, accepts CAN_QUERY, CAN_RECEIVE_RESULTS
  creator_display_name: "DisplayName", # required
  data_encryption_metadata: {
    allow_cleartext: false, # required
    allow_duplicates: false, # required
    allow_joins_on_columns_with_different_names: false, # required
    preserve_nulls: false, # required
  },
  query_log_status: "ENABLED", # required, accepts ENABLED, DISABLED
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.collaboration.id #=> String
resp.collaboration.arn #=> String
resp.collaboration.name #=> String
resp.collaboration.description #=> String
resp.collaboration. #=> String
resp.collaboration.creator_display_name #=> String
resp.collaboration.create_time #=> Time
resp.collaboration.update_time #=> Time
resp.collaboration.member_status #=> String, one of "INVITED", "ACTIVE", "LEFT", "REMOVED"
resp.collaboration.membership_id #=> String
resp.collaboration.membership_arn #=> String
resp.collaboration.data_encryption_metadata.allow_cleartext #=> Boolean
resp.collaboration.data_encryption_metadata.allow_duplicates #=> Boolean
resp.collaboration.data_encryption_metadata.allow_joins_on_columns_with_different_names #=> Boolean
resp.collaboration.data_encryption_metadata.preserve_nulls #=> Boolean
resp.collaboration.query_log_status #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :members (required, Array<Types::MemberSpecification>) —

    A list of initial members, not including the creator. This list is immutable.

  • :name (required, String) —

    The display name for a collaboration.

  • :description (required, String) —

    A description of the collaboration provided by the collaboration owner.

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

    The abilities granted to the collaboration creator.

  • :creator_display_name (required, String) —

    The display name of the collaboration creator.

  • :data_encryption_metadata (Types::DataEncryptionMetadata) —

    The settings for client-side encryption with Cryptographic Computing for Clean Rooms.

  • :query_log_status (required, String) —

    An indicator as to whether query logging has been enabled or disabled for the collaboration.

  • :tags (Hash<String,String>) —

    An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

Returns:

See Also:



517
518
519
520
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 517

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

#create_configured_table(params = {}) ⇒ Types::CreateConfiguredTableOutput

Creates a new configured table resource.

Examples:

Request syntax with placeholder values


resp = client.create_configured_table({
  name: "DisplayName", # required
  description: "TableDescription",
  table_reference: { # required
    glue: {
      table_name: "GlueResourceName", # required
      database_name: "GlueResourceName", # required
    },
  },
  allowed_columns: ["ColumnName"], # required
  analysis_method: "DIRECT_QUERY", # required, accepts DIRECT_QUERY
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.configured_table.id #=> String
resp.configured_table.arn #=> String
resp.configured_table.name #=> String
resp.configured_table.description #=> String
resp.configured_table.table_reference.glue.table_name #=> String
resp.configured_table.table_reference.glue.database_name #=> String
resp.configured_table.create_time #=> Time
resp.configured_table.update_time #=> Time
resp.configured_table.analysis_rule_types #=> Array
resp.configured_table.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST"
resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY"
resp.configured_table.allowed_columns #=> Array
resp.configured_table.allowed_columns[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the configured table.

  • :description (String) —

    A description for the configured table.

  • :table_reference (required, Types::TableReference) —

    A reference to the AWS Glue table being configured.

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

    The columns of the underlying table that can be used by collaborations or analysis rules.

  • :analysis_method (required, String) —

    The analysis method for the configured tables. The only valid value is currently DIRECT\_QUERY.

  • :tags (Hash<String,String>) —

    An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

Returns:

See Also:



589
590
591
592
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 589

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

#create_configured_table_analysis_rule(params = {}) ⇒ Types::CreateConfiguredTableAnalysisRuleOutput

Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.

Examples:

Request syntax with placeholder values


resp = client.create_configured_table_analysis_rule({
  configured_table_identifier: "ConfiguredTableIdentifier", # required
  analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST
  analysis_rule_policy: { # required
    v1: {
      list: {
        join_columns: ["AnalysisRuleColumnName"], # required
        list_columns: ["AnalysisRuleColumnName"], # required
      },
      aggregation: {
        aggregate_columns: [ # required
          {
            column_names: ["AnalysisRuleColumnName"], # required
            function: "SUM", # required, accepts SUM, SUM_DISTINCT, COUNT, COUNT_DISTINCT, AVG
          },
        ],
        join_columns: ["AnalysisRuleColumnName"], # required
        join_required: "QUERY_RUNNER", # accepts QUERY_RUNNER
        dimension_columns: ["AnalysisRuleColumnName"], # required
        scalar_functions: ["TRUNC"], # required, accepts TRUNC, ABS, CEILING, FLOOR, LN, LOG, ROUND, SQRT, CAST, LOWER, RTRIM, UPPER, COALESCE
        output_constraints: [ # required
          {
            column_name: "AnalysisRuleColumnName", # required
            minimum: 1, # required
            type: "COUNT_DISTINCT", # required, accepts COUNT_DISTINCT
          },
        ],
      },
    },
  },
})

Response structure


resp.analysis_rule.configured_table_id #=> String
resp.analysis_rule.configured_table_arn #=> String
resp.analysis_rule.policy.v1.list.join_columns #=> Array
resp.analysis_rule.policy.v1.list.join_columns[0] #=> String
resp.analysis_rule.policy.v1.list.list_columns #=> Array
resp.analysis_rule.policy.v1.list.list_columns[0] #=> String
resp.analysis_rule.policy.v1.aggregation.aggregate_columns #=> Array
resp.analysis_rule.policy.v1.aggregation.aggregate_columns[0].column_names #=> Array
resp.analysis_rule.policy.v1.aggregation.aggregate_columns[0].column_names[0] #=> String
resp.analysis_rule.policy.v1.aggregation.aggregate_columns[0].function #=> String, one of "SUM", "SUM_DISTINCT", "COUNT", "COUNT_DISTINCT", "AVG"
resp.analysis_rule.policy.v1.aggregation.join_columns #=> Array
resp.analysis_rule.policy.v1.aggregation.join_columns[0] #=> String
resp.analysis_rule.policy.v1.aggregation.join_required #=> String, one of "QUERY_RUNNER"
resp.analysis_rule.policy.v1.aggregation.dimension_columns #=> Array
resp.analysis_rule.policy.v1.aggregation.dimension_columns[0] #=> String
resp.analysis_rule.policy.v1.aggregation.scalar_functions #=> Array
resp.analysis_rule.policy.v1.aggregation.scalar_functions[0] #=> String, one of "TRUNC", "ABS", "CEILING", "FLOOR", "LN", "LOG", "ROUND", "SQRT", "CAST", "LOWER", "RTRIM", "UPPER", "COALESCE"
resp.analysis_rule.policy.v1.aggregation.output_constraints #=> Array
resp.analysis_rule.policy.v1.aggregation.output_constraints[0].column_name #=> String
resp.analysis_rule.policy.v1.aggregation.output_constraints[0].minimum #=> Integer
resp.analysis_rule.policy.v1.aggregation.output_constraints[0].type #=> String, one of "COUNT_DISTINCT"
resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST"
resp.analysis_rule.create_time #=> Time
resp.analysis_rule.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :configured_table_identifier (required, String) —

    The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID.

  • :analysis_rule_type (required, String) —

    The type of analysis rule. Valid values are AGGREGATION and LIST.

  • :analysis_rule_policy (required, Types::ConfiguredTableAnalysisRulePolicy) —

    The entire created configured table analysis rule object.

Returns:

See Also:



676
677
678
679
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 676

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

#create_configured_table_association(params = {}) ⇒ Types::CreateConfiguredTableAssociationOutput

Creates a configured table association. A configured table association links a configured table with a collaboration.

Examples:

Request syntax with placeholder values


resp = client.create_configured_table_association({
  name: "TableAlias", # required
  description: "TableDescription",
  membership_identifier: "MembershipIdentifier", # required
  configured_table_identifier: "ConfiguredTableIdentifier", # required
  role_arn: "RoleArn", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.configured_table_association.arn #=> String
resp.configured_table_association.id #=> String
resp.configured_table_association.configured_table_id #=> String
resp.configured_table_association.configured_table_arn #=> String
resp.configured_table_association.membership_id #=> String
resp.configured_table_association.membership_arn #=> String
resp.configured_table_association.role_arn #=> String
resp.configured_table_association.name #=> String
resp.configured_table_association.description #=> String
resp.configured_table_association.create_time #=> Time
resp.configured_table_association.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the configured table association. This name is used to query the underlying configured table.

  • :description (String) —

    A description for the configured table association.

  • :membership_identifier (required, String) —

    A unique identifier for one of your memberships for a collaboration. The configured table is associated to the collaboration that this membership belongs to. Currently accepts a membership ID.

  • :configured_table_identifier (required, String) —

    A unique identifier for the configured table to be associated to. Currently accepts a configured table ID.

  • :role_arn (required, String) —

    The service will assume this role to access catalog metadata and query the table.

  • :tags (Hash<String,String>) —

    An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

Returns:

See Also:



745
746
747
748
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 745

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

#create_membership(params = {}) ⇒ Types::CreateMembershipOutput

Creates a membership for a specific collaboration identifier and joins the collaboration.

Examples:

Request syntax with placeholder values


resp = client.create_membership({
  collaboration_identifier: "CollaborationIdentifier", # required
  query_log_status: "ENABLED", # required, accepts ENABLED, DISABLED
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.membership.id #=> String
resp.membership.arn #=> String
resp.membership.collaboration_arn #=> String
resp.membership.collaboration_id #=> String
resp.membership. #=> String
resp.membership.collaboration_creator_display_name #=> String
resp.membership.collaboration_name #=> String
resp.membership.create_time #=> Time
resp.membership.update_time #=> Time
resp.membership.status #=> String, one of "ACTIVE", "REMOVED", "COLLABORATION_DELETED"
resp.membership.member_abilities #=> Array
resp.membership.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS"
resp.membership.query_log_status #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    The unique ID for the associated collaboration.

  • :query_log_status (required, String) —

    An indicator as to whether query logging has been enabled or disabled for the collaboration.

  • :tags (Hash<String,String>) —

    An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

Returns:

See Also:



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

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

#delete_collaboration(params = {}) ⇒ Struct

Deletes a collaboration. It can only be called by the collaboration owner.

Examples:

Request syntax with placeholder values


resp = client.delete_collaboration({
  collaboration_identifier: "CollaborationIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    The identifier for the collaboration.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



823
824
825
826
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 823

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

#delete_configured_table(params = {}) ⇒ Struct

Deletes a configured table.

Examples:

Request syntax with placeholder values


resp = client.delete_configured_table({
  configured_table_identifier: "ConfiguredTableIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :configured_table_identifier (required, String) —

    The unique ID for the configured table to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



845
846
847
848
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 845

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

#delete_configured_table_analysis_rule(params = {}) ⇒ Struct

Deletes a configured table analysis rule.

Examples:

Request syntax with placeholder values


resp = client.delete_configured_table_analysis_rule({
  configured_table_identifier: "ConfiguredTableIdentifier", # required
  analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST
})

Parameters:

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

    ({})

Options Hash (params):

  • :configured_table_identifier (required, String) —

    The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.

  • :analysis_rule_type (required, String) —

    The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



874
875
876
877
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 874

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

#delete_configured_table_association(params = {}) ⇒ Struct

Deletes a configured table association.

Examples:

Request syntax with placeholder values


resp = client.delete_configured_table_association({
  configured_table_association_identifier: "ConfiguredTableAssociationIdentifier", # required
  membership_identifier: "MembershipIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :configured_table_association_identifier (required, String) —

    The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.

  • :membership_identifier (required, String) —

    A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



902
903
904
905
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 902

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

#delete_member(params = {}) ⇒ Struct

Removes the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.

Examples:

Request syntax with placeholder values


resp = client.delete_member({
  collaboration_identifier: "CollaborationIdentifier", # required
  account_id: "AccountId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    The unique identifier for the associated collaboration.

  • :account_id (required, String) —

    The account ID of the member to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



931
932
933
934
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 931

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

#delete_membership(params = {}) ⇒ Struct

Deletes a specified membership. All resources under a membership must be deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_membership({
  membership_identifier: "MembershipIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The identifier for a membership resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



954
955
956
957
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 954

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

#get_collaboration(params = {}) ⇒ Types::GetCollaborationOutput

Returns metadata about a collaboration.

Examples:

Request syntax with placeholder values


resp = client.get_collaboration({
  collaboration_identifier: "CollaborationIdentifier", # required
})

Response structure


resp.collaboration.id #=> String
resp.collaboration.arn #=> String
resp.collaboration.name #=> String
resp.collaboration.description #=> String
resp.collaboration. #=> String
resp.collaboration.creator_display_name #=> String
resp.collaboration.create_time #=> Time
resp.collaboration.update_time #=> Time
resp.collaboration.member_status #=> String, one of "INVITED", "ACTIVE", "LEFT", "REMOVED"
resp.collaboration.membership_id #=> String
resp.collaboration.membership_arn #=> String
resp.collaboration.data_encryption_metadata.allow_cleartext #=> Boolean
resp.collaboration.data_encryption_metadata.allow_duplicates #=> Boolean
resp.collaboration.data_encryption_metadata.allow_joins_on_columns_with_different_names #=> Boolean
resp.collaboration.data_encryption_metadata.preserve_nulls #=> Boolean
resp.collaboration.query_log_status #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    The identifier for the collaboration.

Returns:

See Also:



997
998
999
1000
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 997

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

#get_configured_table(params = {}) ⇒ Types::GetConfiguredTableOutput

Retrieves a configured table.

Examples:

Request syntax with placeholder values


resp = client.get_configured_table({
  configured_table_identifier: "ConfiguredTableIdentifier", # required
})

Response structure


resp.configured_table.id #=> String
resp.configured_table.arn #=> String
resp.configured_table.name #=> String
resp.configured_table.description #=> String
resp.configured_table.table_reference.glue.table_name #=> String
resp.configured_table.table_reference.glue.database_name #=> String
resp.configured_table.create_time #=> Time
resp.configured_table.update_time #=> Time
resp.configured_table.analysis_rule_types #=> Array
resp.configured_table.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST"
resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY"
resp.configured_table.allowed_columns #=> Array
resp.configured_table.allowed_columns[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :configured_table_identifier (required, String) —

    The unique ID for the configured table to retrieve.

Returns:

See Also:



1037
1038
1039
1040
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1037

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

#get_configured_table_analysis_rule(params = {}) ⇒ Types::GetConfiguredTableAnalysisRuleOutput

Retrieves a configured table analysis rule.

Examples:

Request syntax with placeholder values


resp = client.get_configured_table_analysis_rule({
  configured_table_identifier: "ConfiguredTableIdentifier", # required
  analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST
})

Response structure


resp.analysis_rule.configured_table_id #=> String
resp.analysis_rule.configured_table_arn #=> String
resp.analysis_rule.policy.v1.list.join_columns #=> Array
resp.analysis_rule.policy.v1.list.join_columns[0] #=> String
resp.analysis_rule.policy.v1.list.list_columns #=> Array
resp.analysis_rule.policy.v1.list.list_columns[0] #=> String
resp.analysis_rule.policy.v1.aggregation.aggregate_columns #=> Array
resp.analysis_rule.policy.v1.aggregation.aggregate_columns[0].column_names #=> Array
resp.analysis_rule.policy.v1.aggregation.aggregate_columns[0].column_names[0] #=> String
resp.analysis_rule.policy.v1.aggregation.aggregate_columns[0].function #=> String, one of "SUM", "SUM_DISTINCT", "COUNT", "COUNT_DISTINCT", "AVG"
resp.analysis_rule.policy.v1.aggregation.join_columns #=> Array
resp.analysis_rule.policy.v1.aggregation.join_columns[0] #=> String
resp.analysis_rule.policy.v1.aggregation.join_required #=> String, one of "QUERY_RUNNER"
resp.analysis_rule.policy.v1.aggregation.dimension_columns #=> Array
resp.analysis_rule.policy.v1.aggregation.dimension_columns[0] #=> String
resp.analysis_rule.policy.v1.aggregation.scalar_functions #=> Array
resp.analysis_rule.policy.v1.aggregation.scalar_functions[0] #=> String, one of "TRUNC", "ABS", "CEILING", "FLOOR", "LN", "LOG", "ROUND", "SQRT", "CAST", "LOWER", "RTRIM", "UPPER", "COALESCE"
resp.analysis_rule.policy.v1.aggregation.output_constraints #=> Array
resp.analysis_rule.policy.v1.aggregation.output_constraints[0].column_name #=> String
resp.analysis_rule.policy.v1.aggregation.output_constraints[0].minimum #=> Integer
resp.analysis_rule.policy.v1.aggregation.output_constraints[0].type #=> String, one of "COUNT_DISTINCT"
resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST"
resp.analysis_rule.create_time #=> Time
resp.analysis_rule.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :configured_table_identifier (required, String) —

    The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.

  • :analysis_rule_type (required, String) —

    The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

Returns:

See Also:



1095
1096
1097
1098
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1095

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

#get_configured_table_association(params = {}) ⇒ Types::GetConfiguredTableAssociationOutput

Retrieves a configured table association.

Examples:

Request syntax with placeholder values


resp = client.get_configured_table_association({
  configured_table_association_identifier: "ConfiguredTableAssociationIdentifier", # required
  membership_identifier: "MembershipIdentifier", # required
})

Response structure


resp.configured_table_association.arn #=> String
resp.configured_table_association.id #=> String
resp.configured_table_association.configured_table_id #=> String
resp.configured_table_association.configured_table_arn #=> String
resp.configured_table_association.membership_id #=> String
resp.configured_table_association.membership_arn #=> String
resp.configured_table_association.role_arn #=> String
resp.configured_table_association.name #=> String
resp.configured_table_association.description #=> String
resp.configured_table_association.create_time #=> Time
resp.configured_table_association.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :configured_table_association_identifier (required, String) —

    The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.

  • :membership_identifier (required, String) —

    A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.

Returns:

See Also:



1139
1140
1141
1142
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1139

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

#get_membership(params = {}) ⇒ Types::GetMembershipOutput

Retrieves a specified membership for an identifier.

Examples:

Request syntax with placeholder values


resp = client.get_membership({
  membership_identifier: "MembershipIdentifier", # required
})

Response structure


resp.membership.id #=> String
resp.membership.arn #=> String
resp.membership.collaboration_arn #=> String
resp.membership.collaboration_id #=> String
resp.membership. #=> String
resp.membership.collaboration_creator_display_name #=> String
resp.membership.collaboration_name #=> String
resp.membership.create_time #=> Time
resp.membership.update_time #=> Time
resp.membership.status #=> String, one of "ACTIVE", "REMOVED", "COLLABORATION_DELETED"
resp.membership.member_abilities #=> Array
resp.membership.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS"
resp.membership.query_log_status #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The identifier for a membership resource.

Returns:

See Also:



1179
1180
1181
1182
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1179

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

#get_protected_query(params = {}) ⇒ Types::GetProtectedQueryOutput

Returns query processing metadata.

Examples:

Request syntax with placeholder values


resp = client.get_protected_query({
  membership_identifier: "MembershipIdentifier", # required
  protected_query_identifier: "ProtectedQueryIdentifier", # required
})

Response structure


resp.protected_query.id #=> String
resp.protected_query.membership_id #=> String
resp.protected_query.membership_arn #=> String
resp.protected_query.create_time #=> Time
resp.protected_query.sql_parameters.query_string #=> String
resp.protected_query.status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS", "TIMED_OUT"
resp.protected_query.result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
resp.protected_query.result_configuration.output_configuration.s3.bucket #=> String
resp.protected_query.result_configuration.output_configuration.s3.key_prefix #=> String
resp.protected_query.statistics.total_duration_in_millis #=> Integer
resp.protected_query.result.output.s3.location #=> String
resp.protected_query.error.message #=> String
resp.protected_query.error.code #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The identifier for a membership in a protected query instance.

  • :protected_query_identifier (required, String) —

    The identifier for a protected query instance.

Returns:

See Also:



1223
1224
1225
1226
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1223

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

#get_schema(params = {}) ⇒ Types::GetSchemaOutput

Retrieves the schema for a relation within a collaboration.

Examples:

Request syntax with placeholder values


resp = client.get_schema({
  collaboration_identifier: "CollaborationIdentifier", # required
  name: "TableAlias", # required
})

Response structure


resp.schema.columns #=> Array
resp.schema.columns[0].name #=> String
resp.schema.columns[0].type #=> String
resp.schema.partition_keys #=> Array
resp.schema.partition_keys[0].name #=> String
resp.schema.partition_keys[0].type #=> String
resp.schema.analysis_rule_types #=> Array
resp.schema.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST"
resp.schema.analysis_method #=> String, one of "DIRECT_QUERY"
resp.schema. #=> String
resp.schema.name #=> String
resp.schema.collaboration_id #=> String
resp.schema.collaboration_arn #=> String
resp.schema.description #=> String
resp.schema.create_time #=> Time
resp.schema.update_time #=> Time
resp.schema.type #=> String, one of "TABLE"

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.

  • :name (required, String) —

    The name of the relation to retrieve the schema for.

Returns:

See Also:



1272
1273
1274
1275
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1272

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

#get_schema_analysis_rule(params = {}) ⇒ Types::GetSchemaAnalysisRuleOutput

Retrieves a schema analysis rule.

Examples:

Request syntax with placeholder values


resp = client.get_schema_analysis_rule({
  collaboration_identifier: "CollaborationIdentifier", # required
  name: "TableAlias", # required
  type: "AGGREGATION", # required, accepts AGGREGATION, LIST
})

Response structure


resp.analysis_rule.collaboration_id #=> String
resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST"
resp.analysis_rule.name #=> String
resp.analysis_rule.create_time #=> Time
resp.analysis_rule.update_time #=> Time
resp.analysis_rule.policy.v1.list.join_columns #=> Array
resp.analysis_rule.policy.v1.list.join_columns[0] #=> String
resp.analysis_rule.policy.v1.list.list_columns #=> Array
resp.analysis_rule.policy.v1.list.list_columns[0] #=> String
resp.analysis_rule.policy.v1.aggregation.aggregate_columns #=> Array
resp.analysis_rule.policy.v1.aggregation.aggregate_columns[0].column_names #=> Array
resp.analysis_rule.policy.v1.aggregation.aggregate_columns[0].column_names[0] #=> String
resp.analysis_rule.policy.v1.aggregation.aggregate_columns[0].function #=> String, one of "SUM", "SUM_DISTINCT", "COUNT", "COUNT_DISTINCT", "AVG"
resp.analysis_rule.policy.v1.aggregation.join_columns #=> Array
resp.analysis_rule.policy.v1.aggregation.join_columns[0] #=> String
resp.analysis_rule.policy.v1.aggregation.join_required #=> String, one of "QUERY_RUNNER"
resp.analysis_rule.policy.v1.aggregation.dimension_columns #=> Array
resp.analysis_rule.policy.v1.aggregation.dimension_columns[0] #=> String
resp.analysis_rule.policy.v1.aggregation.scalar_functions #=> Array
resp.analysis_rule.policy.v1.aggregation.scalar_functions[0] #=> String, one of "TRUNC", "ABS", "CEILING", "FLOOR", "LN", "LOG", "ROUND", "SQRT", "CAST", "LOWER", "RTRIM", "UPPER", "COALESCE"
resp.analysis_rule.policy.v1.aggregation.output_constraints #=> Array
resp.analysis_rule.policy.v1.aggregation.output_constraints[0].column_name #=> String
resp.analysis_rule.policy.v1.aggregation.output_constraints[0].minimum #=> Integer
resp.analysis_rule.policy.v1.aggregation.output_constraints[0].type #=> String, one of "COUNT_DISTINCT"

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.

  • :name (required, String) —

    The name of the schema to retrieve the analysis rule for.

  • :type (required, String) —

    The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.

Returns:

See Also:



1334
1335
1336
1337
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1334

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

#list_collaborations(params = {}) ⇒ Types::ListCollaborationsOutput

Lists collaborations the caller owns, is active in, or has been invited to.

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_collaborations({
  next_token: "PaginationToken",
  max_results: 1,
  member_status: "INVITED", # accepts INVITED, ACTIVE
})

Response structure


resp.next_token #=> String
resp.collaboration_list #=> Array
resp.collaboration_list[0].id #=> String
resp.collaboration_list[0].arn #=> String
resp.collaboration_list[0].name #=> String
resp.collaboration_list[0]. #=> String
resp.collaboration_list[0].creator_display_name #=> String
resp.collaboration_list[0].create_time #=> Time
resp.collaboration_list[0].update_time #=> Time
resp.collaboration_list[0].member_status #=> String, one of "INVITED", "ACTIVE", "LEFT", "REMOVED"
resp.collaboration_list[0].membership_id #=> String
resp.collaboration_list[0].membership_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token value retrieved from a previous call to access the next page of results.

  • :max_results (Integer) —

    The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

  • :member_status (String) —

    The caller's status in a collaboration.

Returns:

See Also:



1388
1389
1390
1391
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1388

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

#list_configured_table_associations(params = {}) ⇒ Types::ListConfiguredTableAssociationsOutput

Lists configured table associations for a membership.

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_configured_table_associations({
  membership_identifier: "MembershipIdentifier", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.configured_table_association_summaries #=> Array
resp.configured_table_association_summaries[0].configured_table_id #=> String
resp.configured_table_association_summaries[0].membership_id #=> String
resp.configured_table_association_summaries[0].membership_arn #=> String
resp.configured_table_association_summaries[0].name #=> String
resp.configured_table_association_summaries[0].create_time #=> Time
resp.configured_table_association_summaries[0].update_time #=> Time
resp.configured_table_association_summaries[0].id #=> String
resp.configured_table_association_summaries[0].arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.

  • :next_token (String) —

    The token value retrieved from a previous call to access the next page of results.

  • :max_results (Integer) —

    The maximum size of the results that is returned per call.

Returns:

See Also:



1438
1439
1440
1441
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1438

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

#list_configured_tables(params = {}) ⇒ Types::ListConfiguredTablesOutput

Lists configured tables.

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_configured_tables({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.configured_table_summaries #=> Array
resp.configured_table_summaries[0].id #=> String
resp.configured_table_summaries[0].arn #=> String
resp.configured_table_summaries[0].name #=> String
resp.configured_table_summaries[0].create_time #=> Time
resp.configured_table_summaries[0].update_time #=> Time
resp.configured_table_summaries[0].analysis_rule_types #=> Array
resp.configured_table_summaries[0].analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST"
resp.configured_table_summaries[0].analysis_method #=> String, one of "DIRECT_QUERY"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token value retrieved from a previous call to access the next page of results.

  • :max_results (Integer) —

    The maximum size of the results that is returned per call.

Returns:

See Also:



1483
1484
1485
1486
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1483

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

#list_members(params = {}) ⇒ Types::ListMembersOutput

Lists all members within a collaboration.

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_members({
  collaboration_identifier: "CollaborationIdentifier", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.member_summaries #=> Array
resp.member_summaries[0]. #=> String
resp.member_summaries[0].status #=> String, one of "INVITED", "ACTIVE", "LEFT", "REMOVED"
resp.member_summaries[0].display_name #=> String
resp.member_summaries[0].abilities #=> Array
resp.member_summaries[0].abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS"
resp.member_summaries[0].create_time #=> Time
resp.member_summaries[0].update_time #=> Time
resp.member_summaries[0].membership_id #=> String
resp.member_summaries[0].membership_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    The identifier of the collaboration in which the members are listed.

  • :next_token (String) —

    The token value retrieved from a previous call to access the next page of results.

  • :max_results (Integer) —

    The maximum size of the results that is returned per call.

Returns:

See Also:



1533
1534
1535
1536
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1533

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

#list_memberships(params = {}) ⇒ Types::ListMembershipsOutput

Lists all memberships resources within the caller's account.

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_memberships({
  next_token: "PaginationToken",
  max_results: 1,
  status: "ACTIVE", # accepts ACTIVE, REMOVED, COLLABORATION_DELETED
})

Response structure


resp.next_token #=> String
resp.membership_summaries #=> Array
resp.membership_summaries[0].id #=> String
resp.membership_summaries[0].arn #=> String
resp.membership_summaries[0].collaboration_arn #=> String
resp.membership_summaries[0].collaboration_id #=> String
resp.membership_summaries[0]. #=> String
resp.membership_summaries[0].collaboration_creator_display_name #=> String
resp.membership_summaries[0].collaboration_name #=> String
resp.membership_summaries[0].create_time #=> Time
resp.membership_summaries[0].update_time #=> Time
resp.membership_summaries[0].status #=> String, one of "ACTIVE", "REMOVED", "COLLABORATION_DELETED"
resp.membership_summaries[0].member_abilities #=> Array
resp.membership_summaries[0].member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS"

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token value retrieved from a previous call to access the next page of results.

  • :max_results (Integer) —

    The maximum size of the results that is returned per call.

  • :status (String) —

    A filter which will return only memberships in the specified status.

Returns:

See Also:



1586
1587
1588
1589
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1586

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

#list_protected_queries(params = {}) ⇒ Types::ListProtectedQueriesOutput

Lists protected queries, sorted by the most recent query.

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_protected_queries({
  membership_identifier: "MembershipIdentifier", # required
  status: "SUBMITTED", # accepts SUBMITTED, STARTED, CANCELLED, CANCELLING, FAILED, SUCCESS, TIMED_OUT
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.protected_queries #=> Array
resp.protected_queries[0].id #=> String
resp.protected_queries[0].membership_id #=> String
resp.protected_queries[0].membership_arn #=> String
resp.protected_queries[0].create_time #=> Time
resp.protected_queries[0].status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS", "TIMED_OUT"

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The identifier for the membership in the collaboration.

  • :status (String) —

    A filter on the status of the protected query.

  • :next_token (String) —

    The token value retrieved from a previous call to access the next page of results.

  • :max_results (Integer) —

    The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service can return a nextToken even if the maximum results has not been met.

Returns:

See Also:



1638
1639
1640
1641
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1638

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

#list_schemas(params = {}) ⇒ Types::ListSchemasOutput

Lists the schemas for relations within a collaboration.

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_schemas({
  collaboration_identifier: "CollaborationIdentifier", # required
  schema_type: "TABLE", # accepts TABLE
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.schema_summaries #=> Array
resp.schema_summaries[0].name #=> String
resp.schema_summaries[0].type #=> String, one of "TABLE"
resp.schema_summaries[0]. #=> String
resp.schema_summaries[0].create_time #=> Time
resp.schema_summaries[0].update_time #=> Time
resp.schema_summaries[0].collaboration_id #=> String
resp.schema_summaries[0].collaboration_arn #=> String
resp.schema_summaries[0].analysis_rule_types #=> Array
resp.schema_summaries[0].analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST"
resp.schema_summaries[0].analysis_method #=> String, one of "DIRECT_QUERY"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.

  • :schema_type (String) —

    If present, filter schemas by schema type. The only valid schema type is currently TABLE.

  • :next_token (String) —

    The token value retrieved from a previous call to access the next page of results.

  • :max_results (Integer) —

    The maximum size of the results that is returned per call.

Returns:

See Also:



1695
1696
1697
1698
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1695

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

Lists all of the tags that have been added to a resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "CleanroomsArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) associated with the resource you want to list tags on.

Returns:

See Also:



1725
1726
1727
1728
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1725

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

#start_protected_query(params = {}) ⇒ Types::StartProtectedQueryOutput

Creates a protected query that is started by AWS Clean Rooms.

Examples:

Request syntax with placeholder values


resp = client.start_protected_query({
  type: "SQL", # required, accepts SQL
  membership_identifier: "MembershipIdentifier", # required
  sql_parameters: { # required
    query_string: "ProtectedQuerySQLParametersQueryStringString", # required
  },
  result_configuration: { # required
    output_configuration: { # required
      s3: {
        result_format: "CSV", # required, accepts CSV, PARQUET
        bucket: "ProtectedQueryS3OutputConfigurationBucketString", # required
        key_prefix: "KeyPrefix",
      },
    },
  },
})

Response structure


resp.protected_query.id #=> String
resp.protected_query.membership_id #=> String
resp.protected_query.membership_arn #=> String
resp.protected_query.create_time #=> Time
resp.protected_query.sql_parameters.query_string #=> String
resp.protected_query.status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS", "TIMED_OUT"
resp.protected_query.result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
resp.protected_query.result_configuration.output_configuration.s3.bucket #=> String
resp.protected_query.result_configuration.output_configuration.s3.key_prefix #=> String
resp.protected_query.statistics.total_duration_in_millis #=> Integer
resp.protected_query.result.output.s3.location #=> String
resp.protected_query.error.message #=> String
resp.protected_query.error.code #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :type (required, String) —

    The type of the protected query to be started.

  • :membership_identifier (required, String) —

    A unique identifier for the membership to run this query against. Currently accepts a membership ID.

  • :sql_parameters (required, Types::ProtectedQuerySQLParameters) —

    The protected SQL query parameters.

  • :result_configuration (required, Types::ProtectedQueryResultConfiguration) —

    The details needed to write the query results.

Returns:

See Also:



1788
1789
1790
1791
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1788

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

#tag_resource(params = {}) ⇒ Struct

Tags a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "CleanroomsArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) associated with the resource you want to tag.

  • :tags (required, Hash<String,String>) —

    A map of objects specifying each key name and value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1817
1818
1819
1820
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1817

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

#untag_resource(params = {}) ⇒ Struct

Removes a tag or list of tags from a resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.

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

    A list of key names of tags to be removed.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1844
1845
1846
1847
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1844

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

#update_collaboration(params = {}) ⇒ Types::UpdateCollaborationOutput

Updates collaboration metadata and can only be called by the collaboration owner.

Examples:

Request syntax with placeholder values


resp = client.update_collaboration({
  collaboration_identifier: "CollaborationIdentifier", # required
  name: "CollaborationName",
  description: "CollaborationDescription",
})

Response structure


resp.collaboration.id #=> String
resp.collaboration.arn #=> String
resp.collaboration.name #=> String
resp.collaboration.description #=> String
resp.collaboration. #=> String
resp.collaboration.creator_display_name #=> String
resp.collaboration.create_time #=> Time
resp.collaboration.update_time #=> Time
resp.collaboration.member_status #=> String, one of "INVITED", "ACTIVE", "LEFT", "REMOVED"
resp.collaboration.membership_id #=> String
resp.collaboration.membership_arn #=> String
resp.collaboration.data_encryption_metadata.allow_cleartext #=> Boolean
resp.collaboration.data_encryption_metadata.allow_duplicates #=> Boolean
resp.collaboration.data_encryption_metadata.allow_joins_on_columns_with_different_names #=> Boolean
resp.collaboration.data_encryption_metadata.preserve_nulls #=> Boolean
resp.collaboration.query_log_status #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    The identifier for the collaboration.

  • :name (String) —

    A human-readable identifier provided by the collaboration owner. Display names are not unique.

  • :description (String) —

    A description of the collaboration.

Returns:

See Also:



1897
1898
1899
1900
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1897

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

#update_configured_table(params = {}) ⇒ Types::UpdateConfiguredTableOutput

Updates a configured table.

Examples:

Request syntax with placeholder values


resp = client.update_configured_table({
  configured_table_identifier: "ConfiguredTableIdentifier", # required
  name: "DisplayName",
  description: "TableDescription",
})

Response structure


resp.configured_table.id #=> String
resp.configured_table.arn #=> String
resp.configured_table.name #=> String
resp.configured_table.description #=> String
resp.configured_table.table_reference.glue.table_name #=> String
resp.configured_table.table_reference.glue.database_name #=> String
resp.configured_table.create_time #=> Time
resp.configured_table.update_time #=> Time
resp.configured_table.analysis_rule_types #=> Array
resp.configured_table.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST"
resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY"
resp.configured_table.allowed_columns #=> Array
resp.configured_table.allowed_columns[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :configured_table_identifier (required, String) —

    The identifier for the configured table to update. Currently accepts the configured table ID.

  • :name (String) —

    A new name for the configured table.

  • :description (String) —

    A new description for the configured table.

Returns:

See Also:



1946
1947
1948
1949
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1946

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

#update_configured_table_analysis_rule(params = {}) ⇒ Types::UpdateConfiguredTableAnalysisRuleOutput

Updates a configured table analysis rule.

Examples:

Request syntax with placeholder values


resp = client.update_configured_table_analysis_rule({
  configured_table_identifier: "ConfiguredTableIdentifier", # required
  analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST
  analysis_rule_policy: { # required
    v1: {
      list: {
        join_columns: ["AnalysisRuleColumnName"], # required
        list_columns: ["AnalysisRuleColumnName"], # required
      },
      aggregation: {
        aggregate_columns: [ # required
          {
            column_names: ["AnalysisRuleColumnName"], # required
            function: "SUM", # required, accepts SUM, SUM_DISTINCT, COUNT, COUNT_DISTINCT, AVG
          },
        ],
        join_columns: ["AnalysisRuleColumnName"], # required
        join_required: "QUERY_RUNNER", # accepts QUERY_RUNNER
        dimension_columns: ["AnalysisRuleColumnName"], # required
        scalar_functions: ["TRUNC"], # required, accepts TRUNC, ABS, CEILING, FLOOR, LN, LOG, ROUND, SQRT, CAST, LOWER, RTRIM, UPPER, COALESCE
        output_constraints: [ # required
          {
            column_name: "AnalysisRuleColumnName", # required
            minimum: 1, # required
            type: "COUNT_DISTINCT", # required, accepts COUNT_DISTINCT
          },
        ],
      },
    },
  },
})

Response structure


resp.analysis_rule.configured_table_id #=> String
resp.analysis_rule.configured_table_arn #=> String
resp.analysis_rule.policy.v1.list.join_columns #=> Array
resp.analysis_rule.policy.v1.list.join_columns[0] #=> String
resp.analysis_rule.policy.v1.list.list_columns #=> Array
resp.analysis_rule.policy.v1.list.list_columns[0] #=> String
resp.analysis_rule.policy.v1.aggregation.aggregate_columns #=> Array
resp.analysis_rule.policy.v1.aggregation.aggregate_columns[0].column_names #=> Array
resp.analysis_rule.policy.v1.aggregation.aggregate_columns[0].column_names[0] #=> String
resp.analysis_rule.policy.v1.aggregation.aggregate_columns[0].function #=> String, one of "SUM", "SUM_DISTINCT", "COUNT", "COUNT_DISTINCT", "AVG"
resp.analysis_rule.policy.v1.aggregation.join_columns #=> Array
resp.analysis_rule.policy.v1.aggregation.join_columns[0] #=> String
resp.analysis_rule.policy.v1.aggregation.join_required #=> String, one of "QUERY_RUNNER"
resp.analysis_rule.policy.v1.aggregation.dimension_columns #=> Array
resp.analysis_rule.policy.v1.aggregation.dimension_columns[0] #=> String
resp.analysis_rule.policy.v1.aggregation.scalar_functions #=> Array
resp.analysis_rule.policy.v1.aggregation.scalar_functions[0] #=> String, one of "TRUNC", "ABS", "CEILING", "FLOOR", "LN", "LOG", "ROUND", "SQRT", "CAST", "LOWER", "RTRIM", "UPPER", "COALESCE"
resp.analysis_rule.policy.v1.aggregation.output_constraints #=> Array
resp.analysis_rule.policy.v1.aggregation.output_constraints[0].column_name #=> String
resp.analysis_rule.policy.v1.aggregation.output_constraints[0].minimum #=> Integer
resp.analysis_rule.policy.v1.aggregation.output_constraints[0].type #=> String, one of "COUNT_DISTINCT"
resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST"
resp.analysis_rule.create_time #=> Time
resp.analysis_rule.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :configured_table_identifier (required, String) —

    The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.

  • :analysis_rule_type (required, String) —

    The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

  • :analysis_rule_policy (required, Types::ConfiguredTableAnalysisRulePolicy) —

    The new analysis rule policy for the configured table analysis rule.

Returns:

See Also:



2034
2035
2036
2037
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2034

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

#update_configured_table_association(params = {}) ⇒ Types::UpdateConfiguredTableAssociationOutput

Updates a configured table association.

Examples:

Request syntax with placeholder values


resp = client.update_configured_table_association({
  configured_table_association_identifier: "ConfiguredTableAssociationIdentifier", # required
  membership_identifier: "MembershipIdentifier", # required
  description: "TableDescription",
  role_arn: "RoleArn",
})

Response structure


resp.configured_table_association.arn #=> String
resp.configured_table_association.id #=> String
resp.configured_table_association.configured_table_id #=> String
resp.configured_table_association.configured_table_arn #=> String
resp.configured_table_association.membership_id #=> String
resp.configured_table_association.membership_arn #=> String
resp.configured_table_association.role_arn #=> String
resp.configured_table_association.name #=> String
resp.configured_table_association.description #=> String
resp.configured_table_association.create_time #=> Time
resp.configured_table_association.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :configured_table_association_identifier (required, String) —

    The unique identifier for the configured table association to update. Currently accepts the configured table association ID.

  • :membership_identifier (required, String) —

    The unique ID for the membership that the configured table association belongs to.

  • :description (String) —

    A new description for the configured table association.

  • :role_arn (String) —

    The service will assume this role to access catalog metadata and query the table.

Returns:

See Also:



2087
2088
2089
2090
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2087

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

#update_membership(params = {}) ⇒ Types::UpdateMembershipOutput

Updates a membership.

Examples:

Request syntax with placeholder values


resp = client.update_membership({
  membership_identifier: "MembershipIdentifier", # required
  query_log_status: "ENABLED", # accepts ENABLED, DISABLED
})

Response structure


resp.membership.id #=> String
resp.membership.arn #=> String
resp.membership.collaboration_arn #=> String
resp.membership.collaboration_id #=> String
resp.membership. #=> String
resp.membership.collaboration_creator_display_name #=> String
resp.membership.collaboration_name #=> String
resp.membership.create_time #=> Time
resp.membership.update_time #=> Time
resp.membership.status #=> String, one of "ACTIVE", "REMOVED", "COLLABORATION_DELETED"
resp.membership.member_abilities #=> Array
resp.membership.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS"
resp.membership.query_log_status #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The unique identifier of the membership.

  • :query_log_status (String) —

    An indicator as to whether query logging has been enabled or disabled for the collaboration.

Returns:

See Also:



2132
2133
2134
2135
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2132

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

#update_protected_query(params = {}) ⇒ Types::UpdateProtectedQueryOutput

Updates the processing of a currently running query.

Examples:

Request syntax with placeholder values


resp = client.update_protected_query({
  membership_identifier: "MembershipIdentifier", # required
  protected_query_identifier: "ProtectedQueryIdentifier", # required
  target_status: "CANCELLED", # required, accepts CANCELLED
})

Response structure


resp.protected_query.id #=> String
resp.protected_query.membership_id #=> String
resp.protected_query.membership_arn #=> String
resp.protected_query.create_time #=> Time
resp.protected_query.sql_parameters.query_string #=> String
resp.protected_query.status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS", "TIMED_OUT"
resp.protected_query.result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
resp.protected_query.result_configuration.output_configuration.s3.bucket #=> String
resp.protected_query.result_configuration.output_configuration.s3.key_prefix #=> String
resp.protected_query.statistics.total_duration_in_millis #=> Integer
resp.protected_query.result.output.s3.location #=> String
resp.protected_query.error.message #=> String
resp.protected_query.error.code #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The identifier for a member of a protected query instance.

  • :protected_query_identifier (required, String) —

    The identifier for a protected query instance.

  • :target_status (required, String) —

    The target status of a query. Used to update the execution status of a currently running query.

Returns:

See Also:



2181
2182
2183
2184
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2181

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