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

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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::InstanceProfileCredentials 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)
  • :account_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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

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

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

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

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :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.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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_continue_timeout (Float) — default: 1 —

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

  • :http_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_open_timeout (Float) — default: 15 —

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

  • :http_proxy (URI::HTTP, String) —

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

  • :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_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



471
472
473
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#batch_get_collaboration_analysis_template(params = {}) ⇒ Types::BatchGetCollaborationAnalysisTemplateOutput

Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).

Examples:

Request syntax with placeholder values


resp = client.batch_get_collaboration_analysis_template({
  collaboration_identifier: "CollaborationIdentifier", # required
  analysis_template_arns: ["AnalysisTemplateArn"], # required
})

Response structure


resp.collaboration_analysis_templates #=> Array
resp.collaboration_analysis_templates[0].id #=> String
resp.collaboration_analysis_templates[0].arn #=> String
resp.collaboration_analysis_templates[0].collaboration_id #=> String
resp.collaboration_analysis_templates[0].collaboration_arn #=> String
resp.collaboration_analysis_templates[0].description #=> String
resp.collaboration_analysis_templates[0]. #=> String
resp.collaboration_analysis_templates[0].name #=> String
resp.collaboration_analysis_templates[0].create_time #=> Time
resp.collaboration_analysis_templates[0].update_time #=> Time
resp.collaboration_analysis_templates[0].schema.referenced_tables #=> Array
resp.collaboration_analysis_templates[0].schema.referenced_tables[0] #=> String
resp.collaboration_analysis_templates[0].format #=> String, one of "SQL", "PYSPARK_1_0"
resp.collaboration_analysis_templates[0].source.text #=> String
resp.collaboration_analysis_templates[0].source.artifacts.entry_point.location.bucket #=> String
resp.collaboration_analysis_templates[0].source.artifacts.entry_point.location.key #=> String
resp.collaboration_analysis_templates[0].source.artifacts.additional_artifacts #=> Array
resp.collaboration_analysis_templates[0].source.artifacts.additional_artifacts[0].location.bucket #=> String
resp.collaboration_analysis_templates[0].source.artifacts.additional_artifacts[0].location.key #=> String
resp.collaboration_analysis_templates[0].source.artifacts.role_arn #=> String
resp.collaboration_analysis_templates[0].source_metadata.artifacts.entry_point_hash.sha256 #=> String
resp.collaboration_analysis_templates[0].source_metadata.artifacts.additional_artifact_hashes #=> Array
resp.collaboration_analysis_templates[0].source_metadata.artifacts.additional_artifact_hashes[0].sha256 #=> String
resp.collaboration_analysis_templates[0].analysis_parameters #=> Array
resp.collaboration_analysis_templates[0].analysis_parameters[0].name #=> String
resp.collaboration_analysis_templates[0].analysis_parameters[0].type #=> String, one of "SMALLINT", "INTEGER", "BIGINT", "DECIMAL", "REAL", "DOUBLE_PRECISION", "BOOLEAN", "CHAR", "VARCHAR", "DATE", "TIMESTAMP", "TIMESTAMPTZ", "TIME", "TIMETZ", "VARBYTE", "BINARY", "BYTE", "CHARACTER", "DOUBLE", "FLOAT", "INT", "LONG", "NUMERIC", "SHORT", "STRING", "TIMESTAMP_LTZ", "TIMESTAMP_NTZ", "TINYINT"
resp.collaboration_analysis_templates[0].analysis_parameters[0].default_value #=> String
resp.collaboration_analysis_templates[0].validations #=> Array
resp.collaboration_analysis_templates[0].validations[0].type #=> String, one of "DIFFERENTIAL_PRIVACY"
resp.collaboration_analysis_templates[0].validations[0].status #=> String, one of "VALID", "INVALID", "UNABLE_TO_VALIDATE"
resp.collaboration_analysis_templates[0].validations[0].reasons #=> Array
resp.collaboration_analysis_templates[0].validations[0].reasons[0].message #=> String
resp.collaboration_analysis_templates[0].error_message_configuration.type #=> String, one of "DETAILED"
resp.collaboration_analysis_templates[0].synthetic_data_parameters.ml_synthetic_data_parameters.epsilon #=> Float
resp.collaboration_analysis_templates[0].synthetic_data_parameters.ml_synthetic_data_parameters.max_membership_inference_attack_score #=> Float
resp.collaboration_analysis_templates[0].synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping #=> Array
resp.collaboration_analysis_templates[0].synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].column_name #=> String
resp.collaboration_analysis_templates[0].synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].column_type #=> String, one of "CATEGORICAL", "NUMERICAL"
resp.collaboration_analysis_templates[0].synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].is_predictive_value #=> Boolean
resp.errors #=> Array
resp.errors[0].arn #=> 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 analysis templates belong to. Currently accepts collaboration ID.

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

    The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

Returns:

See Also:



550
551
552
553
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 550

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

#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", "CUSTOM", "ID_MAPPING_TABLE"
resp.schemas[0].analysis_method #=> String, one of "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE"
resp.schemas[0].selected_analysis_methods #=> Array
resp.schemas[0].selected_analysis_methods[0] #=> String, one of "DIRECT_QUERY", "DIRECT_JOB"
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", "ID_MAPPING_TABLE", "INTERMEDIATE_TABLE"
resp.schemas[0].schema_status_details #=> Array
resp.schemas[0].schema_status_details[0].status #=> String, one of "READY", "NOT_READY"
resp.schemas[0].schema_status_details[0].reasons #=> Array
resp.schemas[0].schema_status_details[0].reasons[0].code #=> String, one of "ANALYSIS_RULE_MISSING", "ANALYSIS_TEMPLATES_NOT_CONFIGURED", "ANALYSIS_PROVIDERS_NOT_CONFIGURED", "DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED", "ID_MAPPING_TABLE_NOT_POPULATED", "COLLABORATION_ANALYSIS_RULE_NOT_CONFIGURED", "ADDITIONAL_ANALYSES_NOT_CONFIGURED", "RESULT_RECEIVERS_NOT_CONFIGURED", "ADDITIONAL_ANALYSES_NOT_ALLOWED", "RESULT_RECEIVERS_NOT_ALLOWED", "ANALYSIS_RULE_TYPES_NOT_COMPATIBLE", "INTERMEDIATE_TABLE_NOT_POPULATED", "INTERMEDIATE_TABLE_ANALYSIS_RULE_MISSING", "INTERMEDIATE_TABLE_BASE_TABLE_REMOVED", "INTERMEDIATE_TABLE_INHERITED_CONSTRAINTS_VIOLATED", "INTERMEDIATE_TABLE_DISALLOWED_BY_DATA_PROVIDER", "INTERMEDIATE_TABLE_RETENTION_PERIOD_EXPIRED"
resp.schemas[0].schema_status_details[0].reasons[0].message #=> String
resp.schemas[0].schema_status_details[0].analysis_rule_type #=> String, one of "AGGREGATION", "LIST", "CUSTOM", "ID_MAPPING_TABLE"
resp.schemas[0].schema_status_details[0].configurations #=> Array
resp.schemas[0].schema_status_details[0].configurations[0] #=> String, one of "DIFFERENTIAL_PRIVACY"
resp.schemas[0].schema_status_details[0].analysis_type #=> String, one of "DIRECT_ANALYSIS", "ADDITIONAL_ANALYSIS"
resp.schemas[0].resource_arn #=> String
resp.schemas[0].schema_type_properties.id_mapping_table.id_mapping_table_input_source #=> Array
resp.schemas[0].schema_type_properties.id_mapping_table.id_mapping_table_input_source[0].id_namespace_association_id #=> String
resp.schemas[0].schema_type_properties.id_mapping_table.id_mapping_table_input_source[0].type #=> String, one of "SOURCE", "TARGET"
resp.schemas[0].schema_type_properties.id_mapping_table.id_mapping_table_id #=> String
resp.schemas[0].schema_type_properties.intermediate_table.intermediate_table_id #=> String
resp.schemas[0].schema_type_properties.configured_table_association.configured_table_association_id #=> String
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:



623
624
625
626
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 623

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

#batch_get_schema_analysis_rule(params = {}) ⇒ Types::BatchGetSchemaAnalysisRuleOutput

Retrieves multiple analysis rule schemas.

Examples:

Request syntax with placeholder values


resp = client.batch_get_schema_analysis_rule({
  collaboration_identifier: "CollaborationIdentifier", # required
  schema_analysis_rule_requests: [ # required
    {
      name: "TableAlias", # required
      type: "AGGREGATION", # required, accepts AGGREGATION, LIST, CUSTOM, ID_MAPPING_TABLE
    },
  ],
})

Response structure


resp.analysis_rules #=> Array
resp.analysis_rules[0].collaboration_id #=> String
resp.analysis_rules[0].type #=> String, one of "AGGREGATION", "LIST", "CUSTOM", "ID_MAPPING_TABLE"
resp.analysis_rules[0].name #=> String
resp.analysis_rules[0].create_time #=> Time
resp.analysis_rules[0].update_time #=> Time
resp.analysis_rules[0].policy.v1.list.join_columns #=> Array
resp.analysis_rules[0].policy.v1.list.join_columns[0] #=> String
resp.analysis_rules[0].policy.v1.list.allowed_join_operators #=> Array
resp.analysis_rules[0].policy.v1.list.allowed_join_operators[0] #=> String, one of "OR", "AND"
resp.analysis_rules[0].policy.v1.list.list_columns #=> Array
resp.analysis_rules[0].policy.v1.list.list_columns[0] #=> String
resp.analysis_rules[0].policy.v1.list.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rules[0].policy.v1.aggregation.aggregate_columns #=> Array
resp.analysis_rules[0].policy.v1.aggregation.aggregate_columns[0].column_names #=> Array
resp.analysis_rules[0].policy.v1.aggregation.aggregate_columns[0].column_names[0] #=> String
resp.analysis_rules[0].policy.v1.aggregation.aggregate_columns[0].function #=> String, one of "SUM", "SUM_DISTINCT", "COUNT", "COUNT_DISTINCT", "AVG"
resp.analysis_rules[0].policy.v1.aggregation.join_columns #=> Array
resp.analysis_rules[0].policy.v1.aggregation.join_columns[0] #=> String
resp.analysis_rules[0].policy.v1.aggregation.join_required #=> String, one of "QUERY_RUNNER"
resp.analysis_rules[0].policy.v1.aggregation.allowed_join_operators #=> Array
resp.analysis_rules[0].policy.v1.aggregation.allowed_join_operators[0] #=> String, one of "OR", "AND"
resp.analysis_rules[0].policy.v1.aggregation.dimension_columns #=> Array
resp.analysis_rules[0].policy.v1.aggregation.dimension_columns[0] #=> String
resp.analysis_rules[0].policy.v1.aggregation.scalar_functions #=> Array
resp.analysis_rules[0].policy.v1.aggregation.scalar_functions[0] #=> String, one of "ABS", "CAST", "CEILING", "COALESCE", "CONVERT", "CURRENT_DATE", "DATEADD", "EXTRACT", "FLOOR", "GETDATE", "LN", "LOG", "LOWER", "ROUND", "RTRIM", "SQRT", "SUBSTRING", "TO_CHAR", "TO_DATE", "TO_NUMBER", "TO_TIMESTAMP", "TRIM", "TRUNC", "UPPER"
resp.analysis_rules[0].policy.v1.aggregation.output_constraints #=> Array
resp.analysis_rules[0].policy.v1.aggregation.output_constraints[0].column_name #=> String
resp.analysis_rules[0].policy.v1.aggregation.output_constraints[0].minimum #=> Integer
resp.analysis_rules[0].policy.v1.aggregation.output_constraints[0].type #=> String, one of "COUNT_DISTINCT"
resp.analysis_rules[0].policy.v1.aggregation.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rules[0].policy.v1.custom.allowed_analyses #=> Array
resp.analysis_rules[0].policy.v1.custom.allowed_analyses[0] #=> String
resp.analysis_rules[0].policy.v1.custom.allowed_analysis_providers #=> Array
resp.analysis_rules[0].policy.v1.custom.allowed_analysis_providers[0] #=> String
resp.analysis_rules[0].policy.v1.custom.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rules[0].policy.v1.custom.disallowed_output_columns #=> Array
resp.analysis_rules[0].policy.v1.custom.disallowed_output_columns[0] #=> String
resp.analysis_rules[0].policy.v1.custom.differential_privacy.columns #=> Array
resp.analysis_rules[0].policy.v1.custom.differential_privacy.columns[0].name #=> String
resp.analysis_rules[0].policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rules[0].policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rules[0].policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rules[0].policy.v1.custom.allowed_additional_analyses[0] #=> String
resp.analysis_rules[0].policy.v1.id_mapping_table.join_columns #=> Array
resp.analysis_rules[0].policy.v1.id_mapping_table.join_columns[0] #=> String
resp.analysis_rules[0].policy.v1.id_mapping_table.query_constraints #=> Array
resp.analysis_rules[0].policy.v1.id_mapping_table.query_constraints[0].require_overlap.columns #=> Array
resp.analysis_rules[0].policy.v1.id_mapping_table.query_constraints[0].require_overlap.columns[0] #=> String
resp.analysis_rules[0].policy.v1.id_mapping_table.dimension_columns #=> Array
resp.analysis_rules[0].policy.v1.id_mapping_table.dimension_columns[0] #=> String
resp.analysis_rules[0].collaboration_policy.v1.list.allowed_result_receivers #=> Array
resp.analysis_rules[0].collaboration_policy.v1.list.allowed_result_receivers[0] #=> String
resp.analysis_rules[0].collaboration_policy.v1.list.allowed_additional_analyses #=> Array
resp.analysis_rules[0].collaboration_policy.v1.list.allowed_additional_analyses[0] #=> String
resp.analysis_rules[0].collaboration_policy.v1.aggregation.allowed_result_receivers #=> Array
resp.analysis_rules[0].collaboration_policy.v1.aggregation.allowed_result_receivers[0] #=> String
resp.analysis_rules[0].collaboration_policy.v1.aggregation.allowed_additional_analyses #=> Array
resp.analysis_rules[0].collaboration_policy.v1.aggregation.allowed_additional_analyses[0] #=> String
resp.analysis_rules[0].collaboration_policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rules[0].collaboration_policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rules[0].collaboration_policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rules[0].collaboration_policy.v1.custom.allowed_additional_analyses[0] #=> String
resp.analysis_rules[0].consolidated_policy.v1.list.join_columns #=> Array
resp.analysis_rules[0].consolidated_policy.v1.list.join_columns[0] #=> String
resp.analysis_rules[0].consolidated_policy.v1.list.allowed_join_operators #=> Array
resp.analysis_rules[0].consolidated_policy.v1.list.allowed_join_operators[0] #=> String, one of "OR", "AND"
resp.analysis_rules[0].consolidated_policy.v1.list.list_columns #=> Array
resp.analysis_rules[0].consolidated_policy.v1.list.list_columns[0] #=> String
resp.analysis_rules[0].consolidated_policy.v1.list.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rules[0].consolidated_policy.v1.list.allowed_result_receivers #=> Array
resp.analysis_rules[0].consolidated_policy.v1.list.allowed_result_receivers[0] #=> String
resp.analysis_rules[0].consolidated_policy.v1.list.allowed_additional_analyses #=> Array
resp.analysis_rules[0].consolidated_policy.v1.list.allowed_additional_analyses[0] #=> String
resp.analysis_rules[0].consolidated_policy.v1.aggregation.aggregate_columns #=> Array
resp.analysis_rules[0].consolidated_policy.v1.aggregation.aggregate_columns[0].column_names #=> Array
resp.analysis_rules[0].consolidated_policy.v1.aggregation.aggregate_columns[0].column_names[0] #=> String
resp.analysis_rules[0].consolidated_policy.v1.aggregation.aggregate_columns[0].function #=> String, one of "SUM", "SUM_DISTINCT", "COUNT", "COUNT_DISTINCT", "AVG"
resp.analysis_rules[0].consolidated_policy.v1.aggregation.join_columns #=> Array
resp.analysis_rules[0].consolidated_policy.v1.aggregation.join_columns[0] #=> String
resp.analysis_rules[0].consolidated_policy.v1.aggregation.join_required #=> String, one of "QUERY_RUNNER"
resp.analysis_rules[0].consolidated_policy.v1.aggregation.allowed_join_operators #=> Array
resp.analysis_rules[0].consolidated_policy.v1.aggregation.allowed_join_operators[0] #=> String, one of "OR", "AND"
resp.analysis_rules[0].consolidated_policy.v1.aggregation.dimension_columns #=> Array
resp.analysis_rules[0].consolidated_policy.v1.aggregation.dimension_columns[0] #=> String
resp.analysis_rules[0].consolidated_policy.v1.aggregation.scalar_functions #=> Array
resp.analysis_rules[0].consolidated_policy.v1.aggregation.scalar_functions[0] #=> String, one of "ABS", "CAST", "CEILING", "COALESCE", "CONVERT", "CURRENT_DATE", "DATEADD", "EXTRACT", "FLOOR", "GETDATE", "LN", "LOG", "LOWER", "ROUND", "RTRIM", "SQRT", "SUBSTRING", "TO_CHAR", "TO_DATE", "TO_NUMBER", "TO_TIMESTAMP", "TRIM", "TRUNC", "UPPER"
resp.analysis_rules[0].consolidated_policy.v1.aggregation.output_constraints #=> Array
resp.analysis_rules[0].consolidated_policy.v1.aggregation.output_constraints[0].column_name #=> String
resp.analysis_rules[0].consolidated_policy.v1.aggregation.output_constraints[0].minimum #=> Integer
resp.analysis_rules[0].consolidated_policy.v1.aggregation.output_constraints[0].type #=> String, one of "COUNT_DISTINCT"
resp.analysis_rules[0].consolidated_policy.v1.aggregation.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rules[0].consolidated_policy.v1.aggregation.allowed_result_receivers #=> Array
resp.analysis_rules[0].consolidated_policy.v1.aggregation.allowed_result_receivers[0] #=> String
resp.analysis_rules[0].consolidated_policy.v1.aggregation.allowed_additional_analyses #=> Array
resp.analysis_rules[0].consolidated_policy.v1.aggregation.allowed_additional_analyses[0] #=> String
resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_analyses #=> Array
resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_analyses[0] #=> String
resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_analysis_providers #=> Array
resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_analysis_providers[0] #=> String
resp.analysis_rules[0].consolidated_policy.v1.custom.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rules[0].consolidated_policy.v1.custom.disallowed_output_columns #=> Array
resp.analysis_rules[0].consolidated_policy.v1.custom.disallowed_output_columns[0] #=> String
resp.analysis_rules[0].consolidated_policy.v1.custom.differential_privacy.columns #=> Array
resp.analysis_rules[0].consolidated_policy.v1.custom.differential_privacy.columns[0].name #=> String
resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_additional_analyses[0] #=> String
resp.errors #=> Array
resp.errors[0].name #=> String
resp.errors[0].type #=> String, one of "AGGREGATION", "LIST", "CUSTOM", "ID_MAPPING_TABLE"
resp.errors[0].code #=> String
resp.errors[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    The unique identifier of the collaboration that contains the schema analysis rule.

  • :schema_analysis_rule_requests (required, Array<Types::SchemaAnalysisRuleRequest>) —

    The information that's necessary to retrieve a schema analysis rule.

Returns:

See Also:



775
776
777
778
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 775

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

#create_analysis_template(params = {}) ⇒ Types::CreateAnalysisTemplateOutput

Creates a new analysis template.

Examples:

Request syntax with placeholder values


resp = client.create_analysis_template({
  description: "ResourceDescription",
  membership_identifier: "MembershipIdentifier", # required
  name: "TableAlias", # required
  format: "SQL", # required, accepts SQL, PYSPARK_1_0
  source: { # required
    text: "AnalysisTemplateText",
    artifacts: {
      entry_point: { # required
        location: { # required
          bucket: "S3LocationBucketString", # required
          key: "S3LocationKeyString", # required
        },
      },
      additional_artifacts: [
        {
          location: { # required
            bucket: "S3LocationBucketString", # required
            key: "S3LocationKeyString", # required
          },
        },
      ],
      role_arn: "RoleArn", # required
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
  analysis_parameters: [
    {
      name: "ParameterName", # required
      type: "SMALLINT", # required, accepts SMALLINT, INTEGER, BIGINT, DECIMAL, REAL, DOUBLE_PRECISION, BOOLEAN, CHAR, VARCHAR, DATE, TIMESTAMP, TIMESTAMPTZ, TIME, TIMETZ, VARBYTE, BINARY, BYTE, CHARACTER, DOUBLE, FLOAT, INT, LONG, NUMERIC, SHORT, STRING, TIMESTAMP_LTZ, TIMESTAMP_NTZ, TINYINT
      default_value: "ParameterValue",
    },
  ],
  schema: {
    referenced_tables: ["TableAlias"],
  },
  error_message_configuration: {
    type: "DETAILED", # required, accepts DETAILED
  },
  synthetic_data_parameters: {
    ml_synthetic_data_parameters: {
      epsilon: 1.0, # required
      max_membership_inference_attack_score: 1.0, # required
      column_classification: { # required
        column_mapping: [ # required
          {
            column_name: "SyntheticDataColumnName", # required
            column_type: "CATEGORICAL", # required, accepts CATEGORICAL, NUMERICAL
            is_predictive_value: false, # required
          },
        ],
      },
    },
  },
})

Response structure


resp.analysis_template.id #=> String
resp.analysis_template.arn #=> String
resp.analysis_template.collaboration_id #=> String
resp.analysis_template.collaboration_arn #=> String
resp.analysis_template.membership_id #=> String
resp.analysis_template.membership_arn #=> String
resp.analysis_template.description #=> String
resp.analysis_template.name #=> String
resp.analysis_template.create_time #=> Time
resp.analysis_template.update_time #=> Time
resp.analysis_template.schema.referenced_tables #=> Array
resp.analysis_template.schema.referenced_tables[0] #=> String
resp.analysis_template.format #=> String, one of "SQL", "PYSPARK_1_0"
resp.analysis_template.source.text #=> String
resp.analysis_template.source.artifacts.entry_point.location.bucket #=> String
resp.analysis_template.source.artifacts.entry_point.location.key #=> String
resp.analysis_template.source.artifacts.additional_artifacts #=> Array
resp.analysis_template.source.artifacts.additional_artifacts[0].location.bucket #=> String
resp.analysis_template.source.artifacts.additional_artifacts[0].location.key #=> String
resp.analysis_template.source.artifacts.role_arn #=> String
resp.analysis_template.source_metadata.artifacts.entry_point_hash.sha256 #=> String
resp.analysis_template.source_metadata.artifacts.additional_artifact_hashes #=> Array
resp.analysis_template.source_metadata.artifacts.additional_artifact_hashes[0].sha256 #=> String
resp.analysis_template.analysis_parameters #=> Array
resp.analysis_template.analysis_parameters[0].name #=> String
resp.analysis_template.analysis_parameters[0].type #=> String, one of "SMALLINT", "INTEGER", "BIGINT", "DECIMAL", "REAL", "DOUBLE_PRECISION", "BOOLEAN", "CHAR", "VARCHAR", "DATE", "TIMESTAMP", "TIMESTAMPTZ", "TIME", "TIMETZ", "VARBYTE", "BINARY", "BYTE", "CHARACTER", "DOUBLE", "FLOAT", "INT", "LONG", "NUMERIC", "SHORT", "STRING", "TIMESTAMP_LTZ", "TIMESTAMP_NTZ", "TINYINT"
resp.analysis_template.analysis_parameters[0].default_value #=> String
resp.analysis_template.validations #=> Array
resp.analysis_template.validations[0].type #=> String, one of "DIFFERENTIAL_PRIVACY"
resp.analysis_template.validations[0].status #=> String, one of "VALID", "INVALID", "UNABLE_TO_VALIDATE"
resp.analysis_template.validations[0].reasons #=> Array
resp.analysis_template.validations[0].reasons[0].message #=> String
resp.analysis_template.error_message_configuration.type #=> String, one of "DETAILED"
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.epsilon #=> Float
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.max_membership_inference_attack_score #=> Float
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping #=> Array
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].column_name #=> String
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].column_type #=> String, one of "CATEGORICAL", "NUMERICAL"
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].is_predictive_value #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    The description of the analysis template.

  • :membership_identifier (required, String) —

    The identifier for a membership resource.

  • :name (required, String) —

    The name of the analysis template.

  • :format (required, String) —

    The format of the analysis template.

  • :source (required, Types::AnalysisSource) —

    The information in the analysis template.

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

  • :analysis_parameters (Array<Types::AnalysisParameter>) —

    The parameters of the analysis template.

  • :schema (Types::AnalysisSchema) —

    A relation within an analysis.

  • :error_message_configuration (Types::ErrorMessageConfiguration) —

    The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to DETAILED, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.

  • :synthetic_data_parameters (Types::SyntheticDataParameters) —

    The parameters for generating synthetic data when running the analysis template.

Returns:

See Also:



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

def create_analysis_template(params = {}, options = {})
  req = build_request(:create_analysis_template, 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, CAN_RUN_JOB
      ml_member_abilities: {
        custom_ml_member_abilities: ["CAN_RECEIVE_MODEL_OUTPUT"], # required, accepts CAN_RECEIVE_MODEL_OUTPUT, CAN_RECEIVE_INFERENCE_OUTPUT
      },
      display_name: "DisplayName", # required
      payment_configuration: {
        query_compute: { # required
          is_responsible: false, # required
        },
        machine_learning: {
          model_training: {
            is_responsible: false, # required
          },
          model_inference: {
            is_responsible: false, # required
          },
          synthetic_data_generation: {
            is_responsible: false, # required
          },
        },
        job_compute: {
          is_responsible: false, # required
        },
      },
    },
  ],
  name: "CollaborationName", # required
  description: "CollaborationDescription",
  creator_member_abilities: ["CAN_QUERY"], # required, accepts CAN_QUERY, CAN_RECEIVE_RESULTS, CAN_RUN_JOB
  creator_ml_member_abilities: {
    custom_ml_member_abilities: ["CAN_RECEIVE_MODEL_OUTPUT"], # required, accepts CAN_RECEIVE_MODEL_OUTPUT, CAN_RECEIVE_INFERENCE_OUTPUT
  },
  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
  job_log_status: "ENABLED", # accepts ENABLED, DISABLED
  tags: {
    "TagKey" => "TagValue",
  },
  creator_payment_configuration: {
    query_compute: { # required
      is_responsible: false, # required
    },
    machine_learning: {
      model_training: {
        is_responsible: false, # required
      },
      model_inference: {
        is_responsible: false, # required
      },
      synthetic_data_generation: {
        is_responsible: false, # required
      },
    },
    job_compute: {
      is_responsible: false, # required
    },
  },
  analytics_engine: "SPARK", # accepts SPARK, CLEAN_ROOMS_SQL
  auto_approved_change_request_types: ["ADD_MEMBER"], # accepts ADD_MEMBER, GRANT_RECEIVE_RESULTS_ABILITY, REVOKE_RECEIVE_RESULTS_ABILITY
  allowed_result_regions: ["us-west-1"], # accepts us-west-1, us-west-2, us-east-1, us-east-2, af-south-1, ap-east-1, ap-east-2, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-southeast-4, ap-southeast-7, ap-south-1, ap-northeast-3, ap-northeast-1, ap-northeast-2, ca-central-1, ca-west-1, eu-south-1, eu-west-3, eu-south-2, eu-central-2, eu-central-1, eu-north-1, eu-west-1, eu-west-2, me-south-1, me-central-1, il-central-1, sa-east-1, mx-central-1
  is_metrics_enabled: false,
})

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"
resp.collaboration.job_log_status #=> String, one of "ENABLED", "DISABLED"
resp.collaboration.analytics_engine #=> String, one of "SPARK", "CLEAN_ROOMS_SQL"
resp.collaboration.auto_approved_change_types #=> Array
resp.collaboration.auto_approved_change_types[0] #=> String, one of "ADD_MEMBER", "GRANT_RECEIVE_RESULTS_ABILITY", "REVOKE_RECEIVE_RESULTS_ABILITY"
resp.collaboration.allowed_result_regions #=> Array
resp.collaboration.allowed_result_regions[0] #=> String, one of "us-west-1", "us-west-2", "us-east-1", "us-east-2", "af-south-1", "ap-east-1", "ap-east-2", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-5", "ap-southeast-4", "ap-southeast-7", "ap-south-1", "ap-northeast-3", "ap-northeast-1", "ap-northeast-2", "ca-central-1", "ca-west-1", "eu-south-1", "eu-west-3", "eu-south-2", "eu-central-2", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "me-south-1", "me-central-1", "il-central-1", "sa-east-1", "mx-central-1"
resp.collaboration.is_metrics_enabled #=> Boolean

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 (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_ml_member_abilities (Types::MLMemberAbilities) —

    The ML 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.

    When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

  • :job_log_status (String) —

    Specifies whether job logs are enabled for this collaboration.

    When ENABLED, Clean Rooms logs details about jobs run within this collaboration; those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

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

  • :creator_payment_configuration (Types::PaymentConfiguration) —

    The collaboration creator's payment responsibilities set by the collaboration creator.

    If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.

  • :analytics_engine (String) —

    The analytics engine.

    After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

  • :auto_approved_change_request_types (Array<String>) —

    The types of change requests that are automatically approved for this collaboration.

  • :allowed_result_regions (Array<String>) —

    The Amazon Web Services Regions where collaboration query results can be stored. When specified, results can only be written to these Regions. This parameter enables you to meet your compliance and data governance requirements, and implement regional data governance policies.

  • :is_metrics_enabled (Boolean) —

    An indicator as to whether metrics have been enabled or disabled for the collaboration.

    When true, collaboration members can opt in to Amazon CloudWatch metrics for their membership queries. The default value is false.

Returns:

See Also:



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

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

#create_collaboration_change_request(params = {}) ⇒ Types::CreateCollaborationChangeRequestOutput

Creates a new change request to modify an existing collaboration. This enables post-creation modifications to collaborations through a structured API-driven approach.

Examples:

Request syntax with placeholder values


resp = client.create_collaboration_change_request({
  collaboration_identifier: "CollaborationIdentifier", # required
  changes: [ # required
    {
      specification_type: "MEMBER", # required, accepts MEMBER, COLLABORATION
      specification: { # required
        member: {
          account_id: "AccountId", # required
          member_abilities: ["CAN_QUERY"], # required, accepts CAN_QUERY, CAN_RECEIVE_RESULTS, CAN_RUN_JOB
          ml_member_abilities: {
            custom_ml_member_abilities: ["CAN_RECEIVE_MODEL_OUTPUT"], # required, accepts CAN_RECEIVE_MODEL_OUTPUT, CAN_RECEIVE_INFERENCE_OUTPUT
          },
          payment_configuration: {
            query_compute: { # required
              is_responsible: false, # required
            },
            machine_learning: {
              model_training: {
                is_responsible: false, # required
              },
              model_inference: {
                is_responsible: false, # required
              },
              synthetic_data_generation: {
                is_responsible: false, # required
              },
            },
            job_compute: {
              is_responsible: false, # required
            },
          },
          display_name: "DisplayName",
        },
        collaboration: {
          auto_approved_change_types: ["ADD_MEMBER"], # accepts ADD_MEMBER, GRANT_RECEIVE_RESULTS_ABILITY, REVOKE_RECEIVE_RESULTS_ABILITY
        },
      },
    },
  ],
})

Response structure


resp.collaboration_change_request.id #=> String
resp.collaboration_change_request.collaboration_id #=> String
resp.collaboration_change_request.create_time #=> Time
resp.collaboration_change_request.update_time #=> Time
resp.collaboration_change_request.status #=> String, one of "PENDING", "APPROVED", "CANCELLED", "DENIED", "COMMITTED"
resp.collaboration_change_request.is_auto_approved #=> Boolean
resp.collaboration_change_request.changes #=> Array
resp.collaboration_change_request.changes[0].specification_type #=> String, one of "MEMBER", "COLLABORATION"
resp.collaboration_change_request.changes[0].specification.member. #=> String
resp.collaboration_change_request.changes[0].specification.member.member_abilities #=> Array
resp.collaboration_change_request.changes[0].specification.member.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS", "CAN_RUN_JOB"
resp.collaboration_change_request.changes[0].specification.member.ml_member_abilities.custom_ml_member_abilities #=> Array
resp.collaboration_change_request.changes[0].specification.member.ml_member_abilities.custom_ml_member_abilities[0] #=> String, one of "CAN_RECEIVE_MODEL_OUTPUT", "CAN_RECEIVE_INFERENCE_OUTPUT"
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.query_compute.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.machine_learning.model_training.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.machine_learning.model_inference.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.machine_learning.synthetic_data_generation.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.job_compute.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.display_name #=> String
resp.collaboration_change_request.changes[0].specification.collaboration.auto_approved_change_types #=> Array
resp.collaboration_change_request.changes[0].specification.collaboration.auto_approved_change_types[0] #=> String, one of "ADD_MEMBER", "GRANT_RECEIVE_RESULTS_ABILITY", "REVOKE_RECEIVE_RESULTS_ABILITY"
resp.collaboration_change_request.changes[0].types #=> Array
resp.collaboration_change_request.changes[0].types[0] #=> String, one of "ADD_MEMBER", "GRANT_RECEIVE_RESULTS_ABILITY", "REVOKE_RECEIVE_RESULTS_ABILITY", "EDIT_AUTO_APPROVED_CHANGE_TYPES", "ADD_PAYER_CANDIDATE", "REMOVE_PAYER_CANDIDATE", "GRANT_CAN_RECEIVE_MODEL_OUTPUT", "GRANT_CAN_RECEIVE_INFERENCE_OUTPUT", "REVOKE_CAN_RECEIVE_MODEL_OUTPUT", "REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT"
resp.collaboration_change_request.approvals #=> Hash
resp.collaboration_change_request.approvals["AccountId"].status #=> String, one of "APPROVED", "DENIED", "PENDING"

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    The identifier of the collaboration that the change request is made against.

  • :changes (required, Array<Types::ChangeInput>) —

    The list of changes to apply to the collaboration. Each change specifies the type of modification and the details of what should be changed.

Returns:

See Also:



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

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

#create_configured_audience_model_association(params = {}) ⇒ Types::CreateConfiguredAudienceModelAssociationOutput

Provides the details necessary to create a configured audience model association.

Examples:

Request syntax with placeholder values


resp = client.create_configured_audience_model_association({
  membership_identifier: "MembershipIdentifier", # required
  configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
  configured_audience_model_association_name: "ConfiguredAudienceModelAssociationName", # required
  manage_resource_policies: false, # required
  tags: {
    "TagKey" => "TagValue",
  },
  description: "ResourceDescription",
})

Response structure


resp.configured_audience_model_association.id #=> String
resp.configured_audience_model_association.arn #=> String
resp.configured_audience_model_association.configured_audience_model_arn #=> String
resp.configured_audience_model_association.membership_id #=> String
resp.configured_audience_model_association.membership_arn #=> String
resp.configured_audience_model_association.collaboration_id #=> String
resp.configured_audience_model_association.collaboration_arn #=> String
resp.configured_audience_model_association.name #=> String
resp.configured_audience_model_association.manage_resource_policies #=> Boolean
resp.configured_audience_model_association.description #=> String
resp.configured_audience_model_association.create_time #=> Time
resp.configured_audience_model_association.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    A unique identifier for one of your memberships for a collaboration. The configured audience model is associated to the collaboration that this membership belongs to. Accepts a membership ID.

  • :configured_audience_model_arn (required, String) —

    A unique identifier for the configured audience model that you want to associate.

  • :configured_audience_model_association_name (required, String) —

    The name of the configured audience model association.

  • :manage_resource_policies (required, Boolean) —

    When TRUE, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.

    Setting this to TRUE requires you to have permissions to create, update, and delete the resource policy for the cleanrooms-ml resource when you call the DeleteConfiguredAudienceModelAssociation resource. In addition, if you are the collaboration creator and specify TRUE, you must have the same permissions when you call the DeleteMember and DeleteCollaboration APIs.

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

  • :description (String) —

    A description of the configured audience model association.

Returns:

See Also:



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

def create_configured_audience_model_association(params = {}, options = {})
  req = build_request(:create_configured_audience_model_association, 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: {
      region: "us-west-1", # accepts us-west-1, us-west-2, us-east-1, us-east-2, af-south-1, ap-east-1, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-southeast-4, ap-southeast-7, ap-south-1, ap-northeast-3, ap-northeast-1, ap-northeast-2, ca-central-1, ca-west-1, eu-south-1, eu-west-3, eu-south-2, eu-central-2, eu-central-1, eu-north-1, eu-west-1, eu-west-2, me-south-1, me-central-1, il-central-1, sa-east-1, mx-central-1, ap-east-2
      table_name: "GlueTableName", # required
      database_name: "GlueDatabaseName", # required
    },
    snowflake: {
      secret_arn: "SecretsManagerArn", # required
      account_identifier: "SnowflakeAccountIdentifier", # required
      database_name: "SnowflakeDatabaseName", # required
      table_name: "SnowflakeTableName", # required
      schema_name: "SnowflakeSchemaName", # required
      table_schema: { # required
        v1: [
          {
            column_name: "ColumnName", # required
            column_type: "ColumnTypeString", # required
          },
        ],
      },
    },
    athena: {
      region: "us-west-1", # accepts us-west-1, us-west-2, us-east-1, us-east-2, af-south-1, ap-east-1, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-southeast-4, ap-southeast-7, ap-south-1, ap-northeast-3, ap-northeast-1, ap-northeast-2, ca-central-1, ca-west-1, eu-south-1, eu-west-3, eu-south-2, eu-central-2, eu-central-1, eu-north-1, eu-west-1, eu-west-2, me-south-1, me-central-1, il-central-1, sa-east-1, mx-central-1, ap-east-2
      work_group: "AthenaWorkGroup", # required
      output_location: "AthenaOutputLocation",
      database_name: "AthenaDatabaseName", # required
      table_name: "AthenaTableName", # required
      catalog_name: "AthenaCatalogName",
    },
  },
  allowed_columns: ["ColumnName"], # required
  analysis_method: "DIRECT_QUERY", # required, accepts DIRECT_QUERY, DIRECT_JOB, MULTIPLE
  selected_analysis_methods: ["DIRECT_QUERY"], # accepts DIRECT_QUERY, DIRECT_JOB
  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.region #=> String, one of "us-west-1", "us-west-2", "us-east-1", "us-east-2", "af-south-1", "ap-east-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-5", "ap-southeast-4", "ap-southeast-7", "ap-south-1", "ap-northeast-3", "ap-northeast-1", "ap-northeast-2", "ca-central-1", "ca-west-1", "eu-south-1", "eu-west-3", "eu-south-2", "eu-central-2", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "me-south-1", "me-central-1", "il-central-1", "sa-east-1", "mx-central-1", "ap-east-2"
resp.configured_table.table_reference.glue.table_name #=> String
resp.configured_table.table_reference.glue.database_name #=> String
resp.configured_table.table_reference.snowflake.secret_arn #=> String
resp.configured_table.table_reference.snowflake. #=> String
resp.configured_table.table_reference.snowflake.database_name #=> String
resp.configured_table.table_reference.snowflake.table_name #=> String
resp.configured_table.table_reference.snowflake.schema_name #=> String
resp.configured_table.table_reference.snowflake.table_schema.v1 #=> Array
resp.configured_table.table_reference.snowflake.table_schema.v1[0].column_name #=> String
resp.configured_table.table_reference.snowflake.table_schema.v1[0].column_type #=> String
resp.configured_table.table_reference.athena.region #=> String, one of "us-west-1", "us-west-2", "us-east-1", "us-east-2", "af-south-1", "ap-east-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-5", "ap-southeast-4", "ap-southeast-7", "ap-south-1", "ap-northeast-3", "ap-northeast-1", "ap-northeast-2", "ca-central-1", "ca-west-1", "eu-south-1", "eu-west-3", "eu-south-2", "eu-central-2", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "me-south-1", "me-central-1", "il-central-1", "sa-east-1", "mx-central-1", "ap-east-2"
resp.configured_table.table_reference.athena.work_group #=> String
resp.configured_table.table_reference.athena.output_location #=> String
resp.configured_table.table_reference.athena.database_name #=> String
resp.configured_table.table_reference.athena.table_name #=> String
resp.configured_table.table_reference.athena.catalog_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", "CUSTOM"
resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE"
resp.configured_table.allowed_columns #=> Array
resp.configured_table.allowed_columns[0] #=> String
resp.configured_table.selected_analysis_methods #=> Array
resp.configured_table.selected_analysis_methods[0] #=> String, one of "DIRECT_QUERY", "DIRECT_JOB"

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 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 allowed for the configured tables.

    DIRECT_QUERY allows SQL queries to be run directly on this table.

    DIRECT_JOB allows PySpark jobs to be run directly on this table.

    MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

  • :selected_analysis_methods (Array<String>) —

    The analysis methods to enable for the configured table. When configured, you must specify at least two analysis methods.

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



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

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, CUSTOM
  analysis_rule_policy: { # required
    v1: {
      list: {
        join_columns: ["AnalysisRuleColumnName"], # required
        allowed_join_operators: ["OR"], # accepts OR, AND
        list_columns: ["AnalysisRuleColumnName"], # required
        additional_analyses: "ALLOWED", # accepts ALLOWED, REQUIRED, NOT_ALLOWED
      },
      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
        allowed_join_operators: ["OR"], # accepts OR, AND
        dimension_columns: ["AnalysisRuleColumnName"], # required
        scalar_functions: ["ABS"], # required, accepts ABS, CAST, CEILING, COALESCE, CONVERT, CURRENT_DATE, DATEADD, EXTRACT, FLOOR, GETDATE, LN, LOG, LOWER, ROUND, RTRIM, SQRT, SUBSTRING, TO_CHAR, TO_DATE, TO_NUMBER, TO_TIMESTAMP, TRIM, TRUNC, UPPER
        output_constraints: [ # required
          {
            column_name: "AnalysisRuleColumnName", # required
            minimum: 1, # required
            type: "COUNT_DISTINCT", # required, accepts COUNT_DISTINCT
          },
        ],
        additional_analyses: "ALLOWED", # accepts ALLOWED, REQUIRED, NOT_ALLOWED
      },
      custom: {
        allowed_analyses: ["AnalysisTemplateArnOrQueryWildcard"], # required
        allowed_analysis_providers: ["AccountId"],
        additional_analyses: "ALLOWED", # accepts ALLOWED, REQUIRED, NOT_ALLOWED
        disallowed_output_columns: ["AnalysisRuleColumnName"],
        differential_privacy: {
          columns: [ # required
            {
              name: "ColumnName", # required
            },
          ],
        },
        allowed_result_receivers: ["AccountId"],
        allowed_additional_analyses: ["AdditionalAnalysesResourceArn"],
      },
    },
  },
})

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.allowed_join_operators #=> Array
resp.analysis_rule.policy.v1.list.allowed_join_operators[0] #=> String, one of "OR", "AND"
resp.analysis_rule.policy.v1.list.list_columns #=> Array
resp.analysis_rule.policy.v1.list.list_columns[0] #=> String
resp.analysis_rule.policy.v1.list.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
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.allowed_join_operators #=> Array
resp.analysis_rule.policy.v1.aggregation.allowed_join_operators[0] #=> String, one of "OR", "AND"
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 "ABS", "CAST", "CEILING", "COALESCE", "CONVERT", "CURRENT_DATE", "DATEADD", "EXTRACT", "FLOOR", "GETDATE", "LN", "LOG", "LOWER", "ROUND", "RTRIM", "SQRT", "SUBSTRING", "TO_CHAR", "TO_DATE", "TO_NUMBER", "TO_TIMESTAMP", "TRIM", "TRUNC", "UPPER"
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.policy.v1.aggregation.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rule.policy.v1.custom.allowed_analyses #=> Array
resp.analysis_rule.policy.v1.custom.allowed_analyses[0] #=> String
resp.analysis_rule.policy.v1.custom.allowed_analysis_providers #=> Array
resp.analysis_rule.policy.v1.custom.allowed_analysis_providers[0] #=> String
resp.analysis_rule.policy.v1.custom.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rule.policy.v1.custom.disallowed_output_columns #=> Array
resp.analysis_rule.policy.v1.custom.disallowed_output_columns[0] #=> String
resp.analysis_rule.policy.v1.custom.differential_privacy.columns #=> Array
resp.analysis_rule.policy.v1.custom.differential_privacy.columns[0].name #=> String
resp.analysis_rule.policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rule.policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rule.policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rule.policy.v1.custom.allowed_additional_analyses[0] #=> String
resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
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.

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

    The analysis rule policy that was created for the configured table.

Returns:

See Also:



1551
1552
1553
1554
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1551

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.analysis_rule_types #=> Array
resp.configured_table_association.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
resp.configured_table_association.create_time #=> Time
resp.configured_table_association.update_time #=> Time
resp.configured_table_association.child_resources #=> Array
resp.configured_table_association.child_resources[0].resource_id #=> String
resp.configured_table_association.child_resources[0].resource_type #=> String, one of "INTERMEDIATE_TABLE"
resp.configured_table_association.child_resources[0].resource_name #=> String
resp.configured_table_association.child_resources[0]. #=> String
resp.configured_table_association.child_resources[0].resource_status #=> String, one of "CREATED", "POPULATE_STARTED", "POPULATE_SUCCESS", "POPULATE_FAILED", "DISALLOWED_BY_DATA_PROVIDER", "BASE_TABLE_REMOVED", "RETENTION_PERIOD_EXPIRED"

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:



1628
1629
1630
1631
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1628

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

#create_configured_table_association_analysis_rule(params = {}) ⇒ Types::CreateConfiguredTableAssociationAnalysisRuleOutput

Creates a new analysis rule for an associated configured table.

Examples:

Request syntax with placeholder values


resp = client.create_configured_table_association_analysis_rule({
  membership_identifier: "MembershipIdentifier", # required
  configured_table_association_identifier: "ConfiguredTableAssociationIdentifier", # required
  analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST, CUSTOM
  analysis_rule_policy: { # required
    v1: {
      list: {
        allowed_result_receivers: ["AccountId"],
        allowed_additional_analyses: ["AdditionalAnalysesResourceArn"],
      },
      aggregation: {
        allowed_result_receivers: ["AccountId"],
        allowed_additional_analyses: ["AdditionalAnalysesResourceArn"],
      },
      custom: {
        allowed_result_receivers: ["AccountId"],
        allowed_additional_analyses: ["AdditionalAnalysesResourceArn"],
      },
    },
  },
})

Response structure


resp.analysis_rule.membership_identifier #=> String
resp.analysis_rule.configured_table_association_id #=> String
resp.analysis_rule.configured_table_association_arn #=> String
resp.analysis_rule.policy.v1.list.allowed_result_receivers #=> Array
resp.analysis_rule.policy.v1.list.allowed_result_receivers[0] #=> String
resp.analysis_rule.policy.v1.list.allowed_additional_analyses #=> Array
resp.analysis_rule.policy.v1.list.allowed_additional_analyses[0] #=> String
resp.analysis_rule.policy.v1.aggregation.allowed_result_receivers #=> Array
resp.analysis_rule.policy.v1.aggregation.allowed_result_receivers[0] #=> String
resp.analysis_rule.policy.v1.aggregation.allowed_additional_analyses #=> Array
resp.analysis_rule.policy.v1.aggregation.allowed_additional_analyses[0] #=> String
resp.analysis_rule.policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rule.policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rule.policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rule.policy.v1.custom.allowed_additional_analyses[0] #=> String
resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
resp.analysis_rule.create_time #=> Time
resp.analysis_rule.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

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

  • :configured_table_association_identifier (required, String) —

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

  • :analysis_rule_type (required, String) —

    The type of analysis rule.

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

    The analysis rule policy that was created for the configured table association.

Returns:

See Also:



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

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

#create_id_mapping_table(params = {}) ⇒ Types::CreateIdMappingTableOutput

Creates an ID mapping table.

Examples:

Request syntax with placeholder values


resp = client.create_id_mapping_table({
  membership_identifier: "MembershipIdentifier", # required
  name: "ResourceAlias", # required
  description: "ResourceDescription",
  input_reference_config: { # required
    input_reference_arn: "IdMappingTableInputReferenceArn", # required
    manage_resource_policies: false, # required
  },
  tags: {
    "TagKey" => "TagValue",
  },
  kms_key_arn: "KMSKeyArn",
})

Response structure


resp.id_mapping_table.id #=> String
resp.id_mapping_table.arn #=> String
resp.id_mapping_table.input_reference_config.input_reference_arn #=> String
resp.id_mapping_table.input_reference_config.manage_resource_policies #=> Boolean
resp.id_mapping_table.membership_id #=> String
resp.id_mapping_table.membership_arn #=> String
resp.id_mapping_table.collaboration_id #=> String
resp.id_mapping_table.collaboration_arn #=> String
resp.id_mapping_table.description #=> String
resp.id_mapping_table.name #=> String
resp.id_mapping_table.create_time #=> Time
resp.id_mapping_table.update_time #=> Time
resp.id_mapping_table.input_reference_properties.id_mapping_table_input_source #=> Array
resp.id_mapping_table.input_reference_properties.id_mapping_table_input_source[0].id_namespace_association_id #=> String
resp.id_mapping_table.input_reference_properties.id_mapping_table_input_source[0].type #=> String, one of "SOURCE", "TARGET"
resp.id_mapping_table.kms_key_arn #=> String
resp.id_mapping_table.child_resources #=> Array
resp.id_mapping_table.child_resources[0].resource_id #=> String
resp.id_mapping_table.child_resources[0].resource_type #=> String, one of "INTERMEDIATE_TABLE"
resp.id_mapping_table.child_resources[0].resource_name #=> String
resp.id_mapping_table.child_resources[0]. #=> String
resp.id_mapping_table.child_resources[0].resource_status #=> String, one of "CREATED", "POPULATE_STARTED", "POPULATE_SUCCESS", "POPULATE_FAILED", "DISALLOWED_BY_DATA_PROVIDER", "BASE_TABLE_REMOVED", "RETENTION_PERIOD_EXPIRED"

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the ID mapping table.

  • :name (required, String) —

    A name for the ID mapping table.

  • :description (String) —

    A description of the ID mapping table.

  • :input_reference_config (required, Types::IdMappingTableInputReferenceConfig) —

    The input reference configuration needed to create the ID mapping 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.

  • :kms_key_arn (String) —

    The Amazon Resource Name (ARN) of the Amazon Web Services KMS key. This value is used to encrypt the mapping table data that is stored by Clean Rooms.

Returns:

See Also:



1784
1785
1786
1787
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1784

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

#create_id_namespace_association(params = {}) ⇒ Types::CreateIdNamespaceAssociationOutput

Creates an ID namespace association.

Examples:

Request syntax with placeholder values


resp = client.create_id_namespace_association({
  membership_identifier: "MembershipIdentifier", # required
  input_reference_config: { # required
    input_reference_arn: "IdNamespaceAssociationInputReferenceArn", # required
    manage_resource_policies: false, # required
  },
  tags: {
    "TagKey" => "TagValue",
  },
  name: "GenericResourceName", # required
  description: "ResourceDescription",
  id_mapping_config: {
    allow_use_as_dimension_column: false, # required
  },
})

Response structure


resp.id_namespace_association.id #=> String
resp.id_namespace_association.arn #=> String
resp.id_namespace_association.membership_id #=> String
resp.id_namespace_association.membership_arn #=> String
resp.id_namespace_association.collaboration_id #=> String
resp.id_namespace_association.collaboration_arn #=> String
resp.id_namespace_association.name #=> String
resp.id_namespace_association.description #=> String
resp.id_namespace_association.create_time #=> Time
resp.id_namespace_association.update_time #=> Time
resp.id_namespace_association.input_reference_config.input_reference_arn #=> String
resp.id_namespace_association.input_reference_config.manage_resource_policies #=> Boolean
resp.id_namespace_association.input_reference_properties.id_namespace_type #=> String, one of "SOURCE", "TARGET"
resp.id_namespace_association.input_reference_properties.id_mapping_workflows_supported #=> Array
resp.id_namespace_association.id_mapping_config.allow_use_as_dimension_column #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the ID namespace association.

  • :input_reference_config (required, Types::IdNamespaceAssociationInputReferenceConfig) —

    The input reference configuration needed to create the ID namespace association.

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

  • :name (required, String) —

    The name for the ID namespace association.

  • :description (String) —

    The description of the ID namespace association.

  • :id_mapping_config (Types::IdMappingConfig) —

    The configuration settings for the ID mapping table.

Returns:

See Also:



1858
1859
1860
1861
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 1858

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

#create_intermediate_table(params = {}) ⇒ Types::CreateIntermediateTableOutput

Creates an intermediate table in a membership. An intermediate table stores a query definition that you can execute later using PopulateIntermediateTable to materialize cached results. The intermediate table is owned by the member with the CAN_QUERY ability. This operation does not execute the stored query.

Examples:

Request syntax with placeholder values


resp = client.create_intermediate_table({
  membership_identifier: "MembershipIdentifier", # required
  name: "DisplayName", # required
  description: "ResourceDescription",
  population_analysis_configuration: { # required
    sql_parameters: {
      query_string: "PopulationAnalysisSqlParametersQueryStringString",
      analysis_template_arn: "AnalysisTemplateArn",
    },
  },
  kms_key_arn: "KMSKeyArn",
  retention_in_days: 1,
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.intermediate_table.id #=> String
resp.intermediate_table.arn #=> String
resp.intermediate_table.name #=> String
resp.intermediate_table.description #=> String
resp.intermediate_table.membership_arn #=> String
resp.intermediate_table.membership_id #=> String
resp.intermediate_table.collaboration_arn #=> String
resp.intermediate_table.collaboration_id #=> String
resp.intermediate_table.child_resources #=> Array
resp.intermediate_table.child_resources[0].resource_id #=> String
resp.intermediate_table.child_resources[0].resource_type #=> String, one of "INTERMEDIATE_TABLE"
resp.intermediate_table.child_resources[0].resource_name #=> String
resp.intermediate_table.child_resources[0]. #=> String
resp.intermediate_table.child_resources[0].resource_status #=> String, one of "CREATED", "POPULATE_STARTED", "POPULATE_SUCCESS", "POPULATE_FAILED", "DISALLOWED_BY_DATA_PROVIDER", "BASE_TABLE_REMOVED", "RETENTION_PERIOD_EXPIRED"
resp.intermediate_table.create_time #=> Time
resp.intermediate_table.update_time #=> Time
resp.intermediate_table.status #=> String, one of "CREATED", "POPULATE_STARTED", "POPULATE_SUCCESS", "POPULATE_FAILED", "DISALLOWED_BY_DATA_PROVIDER", "BASE_TABLE_REMOVED", "RETENTION_PERIOD_EXPIRED"
resp.intermediate_table.status_reason #=> String
resp.intermediate_table.kms_key_arn #=> String
resp.intermediate_table.population_analysis_configuration.sql_parameters.query_string #=> String
resp.intermediate_table.population_analysis_configuration.sql_parameters.analysis_template_arn #=> String
resp.intermediate_table.retention_in_days #=> Integer
resp.intermediate_table.table_dependencies #=> Array
resp.intermediate_table.table_dependencies[0].id #=> String
resp.intermediate_table.table_dependencies[0].name #=> String
resp.intermediate_table.table_dependencies[0].type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.table_dependencies[0].parent_type #=> String, one of "DIRECT", "INDIRECT"
resp.intermediate_table.table_dependencies[0]. #=> String
resp.intermediate_table.intermediate_table_version.version_id #=> String
resp.intermediate_table.intermediate_table_version.analysis_id #=> String
resp.intermediate_table.intermediate_table_version.analysis_type #=> String, one of "QUERY"
resp.intermediate_table.intermediate_table_version.kms_key_arn #=> String
resp.intermediate_table.intermediate_table_version.parameters #=> Hash
resp.intermediate_table.intermediate_table_version.parameters["ParameterName"] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.value #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0].name #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0].id #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0].type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0].value #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0]. #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].name #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].id #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0]. #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].name #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].id #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0]. #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].column #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].source_column #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].source_name #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].source_id #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].source_type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0]. #=> String
resp.intermediate_table.intermediate_table_version.expiration_time #=> Time
resp.intermediate_table.analysis_rule_types #=> Array
resp.intermediate_table.analysis_rule_types[0] #=> String, one of "CUSTOM"
resp.intermediate_table.schema.columns #=> Array
resp.intermediate_table.schema.columns[0].name #=> String
resp.intermediate_table.schema.columns[0].type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The unique identifier of the membership where the intermediate table is created.

  • :name (required, String) —

    The display name for the intermediate table.

  • :description (String) —

    A description of the intermediate table.

  • :population_analysis_configuration (required, Types::PopulationAnalysisConfiguration) —

    The configuration that defines the analysis used to populate the intermediate table. This configuration contains the SQL query or analysis template reference.

  • :kms_key_arn (String) —

    The Amazon Resource Name (ARN) of the customer-managed KMS key used to encrypt the intermediate table data.

  • :retention_in_days (Integer) —

    The number of days to retain populated data versions. Minimum value of 1, maximum value of 365.

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



2002
2003
2004
2005
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2002

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

#create_intermediate_table_analysis_rule(params = {}) ⇒ Types::CreateIntermediateTableAnalysisRuleOutput

Creates an analysis rule for an intermediate table. Only the CUSTOM analysis rule type is supported. The service automatically determines whether the rule is first-party or multi-party restricted based on the intermediate table's inherited constraints. Only the intermediate table owner can call this operation.

Examples:

Request syntax with placeholder values


resp = client.create_intermediate_table_analysis_rule({
  membership_identifier: "MembershipIdentifier", # required
  intermediate_table_identifier: "IntermediateTableIdentifier", # required
  analysis_rule_type: "CUSTOM", # required, accepts CUSTOM
  analysis_rule_policy: { # required
    v1: {
      custom: {
        allowed_analyses: ["AnalysisTemplateArnOrQueryWildcard"],
        additional_analyses: "ALLOWED", # accepts ALLOWED, REQUIRED, NOT_ALLOWED
        allowed_additional_analyses: ["AdditionalAnalysesResourceArn"],
        allowed_analysis_providers: ["AccountId"],
        allowed_result_receivers: ["AccountId"],
        differential_privacy: {
          columns: [ # required
            {
              name: "ColumnName", # required
            },
          ],
        },
        disallowed_output_columns: ["AnalysisRuleColumnName"],
      },
    },
  },
})

Response structure


resp.analysis_rule.intermediate_table_identifier #=> String
resp.analysis_rule.intermediate_table_arn #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_analyses #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_analyses[0] #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_additional_analyses[0] #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_analysis_providers #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_analysis_providers[0] #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.differential_privacy.columns #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.differential_privacy.columns[0].name #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.disallowed_output_columns #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.disallowed_output_columns[0] #=> String
resp.analysis_rule.analysis_rule_type #=> String, one of "CUSTOM"
resp.analysis_rule.create_time #=> Time
resp.analysis_rule.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the intermediate table.

  • :intermediate_table_identifier (required, String) —

    The unique identifier of the intermediate table for which to create the analysis rule.

  • :analysis_rule_type (required, String) —

    The type of analysis rule to create. Currently, only CUSTOM is supported.

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

    The analysis rule policy to apply to the intermediate table.

Returns:

See Also:



2084
2085
2086
2087
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2084

def create_intermediate_table_analysis_rule(params = {}, options = {})
  req = build_request(:create_intermediate_table_analysis_rule, 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
  job_log_status: "ENABLED", # accepts ENABLED, DISABLED
  tags: {
    "TagKey" => "TagValue",
  },
  default_result_configuration: {
    output_configuration: { # required
      s3: {
        result_format: "CSV", # required, accepts CSV, PARQUET
        bucket: "ProtectedQueryS3OutputConfigurationBucketString", # required
        key_prefix: "KeyPrefix",
        single_file_output: false,
      },
    },
    role_arn: "RoleArn",
  },
  default_job_result_configuration: {
    output_configuration: { # required
      s3: {
        bucket: "ProtectedJobS3OutputConfigurationInputBucketString", # required
        key_prefix: "KeyPrefix",
      },
    },
    role_arn: "RoleArn", # required
  },
  payment_configuration: {
    query_compute: { # required
      is_responsible: false, # required
    },
    machine_learning: {
      model_training: {
        is_responsible: false, # required
      },
      model_inference: {
        is_responsible: false, # required
      },
      synthetic_data_generation: {
        is_responsible: false, # required
      },
    },
    job_compute: {
      is_responsible: false, # required
    },
  },
  is_metrics_enabled: false,
})

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", "CAN_RUN_JOB"
resp.membership.ml_member_abilities.custom_ml_member_abilities #=> Array
resp.membership.ml_member_abilities.custom_ml_member_abilities[0] #=> String, one of "CAN_RECEIVE_MODEL_OUTPUT", "CAN_RECEIVE_INFERENCE_OUTPUT"
resp.membership.query_log_status #=> String, one of "ENABLED", "DISABLED"
resp.membership.job_log_status #=> String, one of "ENABLED", "DISABLED"
resp.membership.default_result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
resp.membership.default_result_configuration.output_configuration.s3.bucket #=> String
resp.membership.default_result_configuration.output_configuration.s3.key_prefix #=> String
resp.membership.default_result_configuration.output_configuration.s3.single_file_output #=> Boolean
resp.membership.default_result_configuration.role_arn #=> String
resp.membership.default_job_result_configuration.output_configuration.s3.bucket #=> String
resp.membership.default_job_result_configuration.output_configuration.s3.key_prefix #=> String
resp.membership.default_job_result_configuration.role_arn #=> String
resp.membership.payment_configuration.query_compute.is_responsible #=> Boolean
resp.membership.payment_configuration.machine_learning.model_training.is_responsible #=> Boolean
resp.membership.payment_configuration.machine_learning.model_inference.is_responsible #=> Boolean
resp.membership.payment_configuration.machine_learning.synthetic_data_generation.is_responsible #=> Boolean
resp.membership.payment_configuration.job_compute.is_responsible #=> Boolean
resp.membership.is_metrics_enabled #=> Boolean

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

    When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

  • :job_log_status (String) —

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

    When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

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

  • :default_result_configuration (Types::MembershipProtectedQueryResultConfiguration) —

    The default protected query result configuration as specified by the member who can receive results.

  • :default_job_result_configuration (Types::MembershipProtectedJobResultConfiguration) —

    The default job result configuration that determines how job results are protected and managed within this membership. This configuration applies to all jobs.

  • :payment_configuration (Types::MembershipPaymentConfiguration) —

    The payment responsibilities accepted by the collaboration member.

    Not required if the collaboration member has the member ability to run queries.

    Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator.

  • :is_metrics_enabled (Boolean) —

    An indicator as to whether Amazon CloudWatch metrics have been enabled or disabled for the membership.

    Amazon CloudWatch metrics are only available when the collaboration has metrics enabled. This option can be set by collaboration members who have the ability to run queries (analysis runners) or by members who are configured as payers.

    When true, metrics about query execution are collected in Amazon CloudWatch. The default value is false.

Returns:

See Also:



2240
2241
2242
2243
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2240

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

#create_privacy_budget_template(params = {}) ⇒ Types::CreatePrivacyBudgetTemplateOutput

Creates a privacy budget template for a specified collaboration. Each collaboration can have only one privacy budget template. If you need to change the privacy budget template, use the UpdatePrivacyBudgetTemplate operation.

Examples:

Request syntax with placeholder values


resp = client.create_privacy_budget_template({
  membership_identifier: "MembershipIdentifier", # required
  auto_refresh: "CALENDAR_MONTH", # accepts CALENDAR_MONTH, NONE
  privacy_budget_type: "DIFFERENTIAL_PRIVACY", # required, accepts DIFFERENTIAL_PRIVACY, ACCESS_BUDGET
  parameters: { # required
    differential_privacy: {
      epsilon: 1, # required
      users_noise_per_query: 1, # required
    },
    access_budget: {
      budget_parameters: [ # required
        {
          type: "CALENDAR_DAY", # required, accepts CALENDAR_DAY, CALENDAR_MONTH, CALENDAR_WEEK, LIFETIME
          budget: 1, # required
          auto_refresh: "ENABLED", # accepts ENABLED, DISABLED
        },
      ],
      resource_arn: "BudgetedResourceArn", # required
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.privacy_budget_template.id #=> String
resp.privacy_budget_template.arn #=> String
resp.privacy_budget_template.membership_id #=> String
resp.privacy_budget_template.membership_arn #=> String
resp.privacy_budget_template.collaboration_id #=> String
resp.privacy_budget_template.collaboration_arn #=> String
resp.privacy_budget_template.create_time #=> Time
resp.privacy_budget_template.update_time #=> Time
resp.privacy_budget_template.privacy_budget_type #=> String, one of "DIFFERENTIAL_PRIVACY", "ACCESS_BUDGET"
resp.privacy_budget_template.auto_refresh #=> String, one of "CALENDAR_MONTH", "NONE"
resp.privacy_budget_template.parameters.differential_privacy.epsilon #=> Integer
resp.privacy_budget_template.parameters.differential_privacy.users_noise_per_query #=> Integer
resp.privacy_budget_template.parameters.access_budget.budget_parameters #=> Array
resp.privacy_budget_template.parameters.access_budget.budget_parameters[0].type #=> String, one of "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_WEEK", "LIFETIME"
resp.privacy_budget_template.parameters.access_budget.budget_parameters[0].budget #=> Integer
resp.privacy_budget_template.parameters.access_budget.budget_parameters[0].auto_refresh #=> String, one of "ENABLED", "DISABLED"
resp.privacy_budget_template.parameters.access_budget.resource_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.

  • :auto_refresh (String) —

    How often the privacy budget refreshes.

    If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

  • :privacy_budget_type (required, String) —

    Specifies the type of the privacy budget template.

  • :parameters (required, Types::PrivacyBudgetTemplateParametersInput) —

    Specifies your parameters for the privacy budget template.

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



2332
2333
2334
2335
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2332

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

#delete_analysis_template(params = {}) ⇒ Struct

Deletes an analysis template.

Examples:

Request syntax with placeholder values


resp = client.delete_analysis_template({
  membership_identifier: "MembershipIdentifier", # required
  analysis_template_identifier: "AnalysisTemplateIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The identifier for a membership resource.

  • :analysis_template_identifier (required, String) —

    The identifier for the analysis template resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2358
2359
2360
2361
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2358

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



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

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

#delete_configured_audience_model_association(params = {}) ⇒ Struct

Provides the information necessary to delete a configured audience model association.

Examples:

Request syntax with placeholder values


resp = client.delete_configured_audience_model_association({
  configured_audience_model_association_identifier: "ConfiguredAudienceModelAssociationIdentifier", # required
  membership_identifier: "MembershipIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :configured_audience_model_association_identifier (required, String) —

    A unique identifier of the configured audience model association that you want to delete.

  • :membership_identifier (required, String) —

    A unique identifier of the membership that contains the audience model association that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2410
2411
2412
2413
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2410

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



2432
2433
2434
2435
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2432

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, CUSTOM
})

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:



2461
2462
2463
2464
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2461

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:



2489
2490
2491
2492
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2489

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

#delete_configured_table_association_analysis_rule(params = {}) ⇒ Struct

Deletes an analysis rule for a configured table association.

Examples:

Request syntax with placeholder values


resp = client.delete_configured_table_association_analysis_rule({
  membership_identifier: "MembershipIdentifier", # required
  configured_table_association_identifier: "ConfiguredTableAssociationIdentifier", # required
  analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST, CUSTOM
})

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

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

  • :configured_table_association_identifier (required, String) —

    The identifier for the configured table association that's related to the analysis rule that you want to delete.

  • :analysis_rule_type (required, String) —

    The type of the analysis rule that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_id_mapping_table(params = {}) ⇒ Struct

Deletes an ID mapping table.

Examples:

Request syntax with placeholder values


resp = client.delete_id_mapping_table({
  id_mapping_table_identifier: "UUID", # required
  membership_identifier: "MembershipIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id_mapping_table_identifier (required, String) —

    The unique identifier of the ID mapping table that you want to delete.

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the ID mapping table that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2548
2549
2550
2551
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2548

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

#delete_id_namespace_association(params = {}) ⇒ Struct

Deletes an ID namespace association.

Examples:

Request syntax with placeholder values


resp = client.delete_id_namespace_association({
  id_namespace_association_identifier: "IdNamespaceAssociationIdentifier", # required
  membership_identifier: "MembershipIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id_namespace_association_identifier (required, String) —

    The unique identifier of the ID namespace association that you want to delete.

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the ID namespace association that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2576
2577
2578
2579
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2576

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

#delete_intermediate_table(params = {}) ⇒ Struct

Deletes an intermediate table. When you delete the table, the service marks it as DELETED, removes its analysis rule and schema, and triggers storage cleanup. This operation is idempotent. Only the intermediate table owner can call this operation.

Examples:

Request syntax with placeholder values


resp = client.delete_intermediate_table({
  membership_identifier: "MembershipIdentifier", # required
  intermediate_table_identifier: "IntermediateTableIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the intermediate table.

  • :intermediate_table_identifier (required, String) —

    The unique identifier of the intermediate table to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2606
2607
2608
2609
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2606

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

#delete_intermediate_table_analysis_rule(params = {}) ⇒ Struct

Deletes an analysis rule from an intermediate table. After the analysis rule is deleted, the intermediate table becomes unqueryable until a new analysis rule is attached. Only the intermediate table owner can call this operation.

Examples:

Request syntax with placeholder values


resp = client.delete_intermediate_table_analysis_rule({
  membership_identifier: "MembershipIdentifier", # required
  intermediate_table_identifier: "IntermediateTableIdentifier", # required
  analysis_rule_type: "CUSTOM", # required, accepts CUSTOM
})

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the intermediate table.

  • :intermediate_table_identifier (required, String) —

    The unique identifier of the intermediate table from which to delete the analysis rule.

  • :analysis_rule_type (required, String) —

    The type of analysis rule to delete. Currently, only CUSTOM is supported.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2642
2643
2644
2645
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2642

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



2671
2672
2673
2674
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2671

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:



2694
2695
2696
2697
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2694

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

#delete_privacy_budget_template(params = {}) ⇒ Struct

Deletes a privacy budget template for a specified collaboration.

Examples:

Request syntax with placeholder values


resp = client.delete_privacy_budget_template({
  membership_identifier: "MembershipIdentifier", # required
  privacy_budget_template_identifier: "PrivacyBudgetTemplateIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    A unique identifier for one of your memberships for a collaboration. The privacy budget template is deleted from the collaboration that this membership belongs to. Accepts a membership ID.

  • :privacy_budget_template_identifier (required, String) —

    A unique identifier for your privacy budget template.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2722
2723
2724
2725
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2722

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

#disallow_intermediate_table(params = {}) ⇒ Struct

Invalidates a specific intermediate table that references the caller's base table. The data provider (base table owner) calls this operation, not the intermediate table owner. By default, invalidation cascades to descendant intermediate tables.

Examples:

Request syntax with placeholder values


resp = client.disallow_intermediate_table({
  membership_identifier: "MembershipIdentifier", # required
  intermediate_table_name: "DisplayName", # required
  include_descendants: false,
})

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the intermediate table to disallow.

  • :intermediate_table_name (required, String) —

    The name of the intermediate table to disallow.

  • :include_descendants (Boolean) —

    Specifies whether to cascade the disallow action to descendant intermediate tables. Default is true.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2757
2758
2759
2760
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2757

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

#get_analysis_template(params = {}) ⇒ Types::GetAnalysisTemplateOutput

Retrieves an analysis template.

Examples:

Request syntax with placeholder values


resp = client.get_analysis_template({
  membership_identifier: "MembershipIdentifier", # required
  analysis_template_identifier: "AnalysisTemplateIdentifier", # required
})

Response structure


resp.analysis_template.id #=> String
resp.analysis_template.arn #=> String
resp.analysis_template.collaboration_id #=> String
resp.analysis_template.collaboration_arn #=> String
resp.analysis_template.membership_id #=> String
resp.analysis_template.membership_arn #=> String
resp.analysis_template.description #=> String
resp.analysis_template.name #=> String
resp.analysis_template.create_time #=> Time
resp.analysis_template.update_time #=> Time
resp.analysis_template.schema.referenced_tables #=> Array
resp.analysis_template.schema.referenced_tables[0] #=> String
resp.analysis_template.format #=> String, one of "SQL", "PYSPARK_1_0"
resp.analysis_template.source.text #=> String
resp.analysis_template.source.artifacts.entry_point.location.bucket #=> String
resp.analysis_template.source.artifacts.entry_point.location.key #=> String
resp.analysis_template.source.artifacts.additional_artifacts #=> Array
resp.analysis_template.source.artifacts.additional_artifacts[0].location.bucket #=> String
resp.analysis_template.source.artifacts.additional_artifacts[0].location.key #=> String
resp.analysis_template.source.artifacts.role_arn #=> String
resp.analysis_template.source_metadata.artifacts.entry_point_hash.sha256 #=> String
resp.analysis_template.source_metadata.artifacts.additional_artifact_hashes #=> Array
resp.analysis_template.source_metadata.artifacts.additional_artifact_hashes[0].sha256 #=> String
resp.analysis_template.analysis_parameters #=> Array
resp.analysis_template.analysis_parameters[0].name #=> String
resp.analysis_template.analysis_parameters[0].type #=> String, one of "SMALLINT", "INTEGER", "BIGINT", "DECIMAL", "REAL", "DOUBLE_PRECISION", "BOOLEAN", "CHAR", "VARCHAR", "DATE", "TIMESTAMP", "TIMESTAMPTZ", "TIME", "TIMETZ", "VARBYTE", "BINARY", "BYTE", "CHARACTER", "DOUBLE", "FLOAT", "INT", "LONG", "NUMERIC", "SHORT", "STRING", "TIMESTAMP_LTZ", "TIMESTAMP_NTZ", "TINYINT"
resp.analysis_template.analysis_parameters[0].default_value #=> String
resp.analysis_template.validations #=> Array
resp.analysis_template.validations[0].type #=> String, one of "DIFFERENTIAL_PRIVACY"
resp.analysis_template.validations[0].status #=> String, one of "VALID", "INVALID", "UNABLE_TO_VALIDATE"
resp.analysis_template.validations[0].reasons #=> Array
resp.analysis_template.validations[0].reasons[0].message #=> String
resp.analysis_template.error_message_configuration.type #=> String, one of "DETAILED"
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.epsilon #=> Float
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.max_membership_inference_attack_score #=> Float
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping #=> Array
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].column_name #=> String
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].column_type #=> String, one of "CATEGORICAL", "NUMERICAL"
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].is_predictive_value #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The identifier for a membership resource.

  • :analysis_template_identifier (required, String) —

    The identifier for the analysis template resource.

Returns:

See Also:



2827
2828
2829
2830
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2827

def get_analysis_template(params = {}, options = {})
  req = build_request(:get_analysis_template, 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"
resp.collaboration.job_log_status #=> String, one of "ENABLED", "DISABLED"
resp.collaboration.analytics_engine #=> String, one of "SPARK", "CLEAN_ROOMS_SQL"
resp.collaboration.auto_approved_change_types #=> Array
resp.collaboration.auto_approved_change_types[0] #=> String, one of "ADD_MEMBER", "GRANT_RECEIVE_RESULTS_ABILITY", "REVOKE_RECEIVE_RESULTS_ABILITY"
resp.collaboration.allowed_result_regions #=> Array
resp.collaboration.allowed_result_regions[0] #=> String, one of "us-west-1", "us-west-2", "us-east-1", "us-east-2", "af-south-1", "ap-east-1", "ap-east-2", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-5", "ap-southeast-4", "ap-southeast-7", "ap-south-1", "ap-northeast-3", "ap-northeast-1", "ap-northeast-2", "ca-central-1", "ca-west-1", "eu-south-1", "eu-west-3", "eu-south-2", "eu-central-2", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "me-south-1", "me-central-1", "il-central-1", "sa-east-1", "mx-central-1"
resp.collaboration.is_metrics_enabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    The identifier for the collaboration.

Returns:

See Also:



2877
2878
2879
2880
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2877

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

#get_collaboration_analysis_template(params = {}) ⇒ Types::GetCollaborationAnalysisTemplateOutput

Retrieves an analysis template within a collaboration.

Examples:

Request syntax with placeholder values


resp = client.get_collaboration_analysis_template({
  collaboration_identifier: "CollaborationIdentifier", # required
  analysis_template_arn: "AnalysisTemplateArn", # required
})

Response structure


resp.collaboration_analysis_template.id #=> String
resp.collaboration_analysis_template.arn #=> String
resp.collaboration_analysis_template.collaboration_id #=> String
resp.collaboration_analysis_template.collaboration_arn #=> String
resp.collaboration_analysis_template.description #=> String
resp.collaboration_analysis_template. #=> String
resp.collaboration_analysis_template.name #=> String
resp.collaboration_analysis_template.create_time #=> Time
resp.collaboration_analysis_template.update_time #=> Time
resp.collaboration_analysis_template.schema.referenced_tables #=> Array
resp.collaboration_analysis_template.schema.referenced_tables[0] #=> String
resp.collaboration_analysis_template.format #=> String, one of "SQL", "PYSPARK_1_0"
resp.collaboration_analysis_template.source.text #=> String
resp.collaboration_analysis_template.source.artifacts.entry_point.location.bucket #=> String
resp.collaboration_analysis_template.source.artifacts.entry_point.location.key #=> String
resp.collaboration_analysis_template.source.artifacts.additional_artifacts #=> Array
resp.collaboration_analysis_template.source.artifacts.additional_artifacts[0].location.bucket #=> String
resp.collaboration_analysis_template.source.artifacts.additional_artifacts[0].location.key #=> String
resp.collaboration_analysis_template.source.artifacts.role_arn #=> String
resp.collaboration_analysis_template.source_metadata.artifacts.entry_point_hash.sha256 #=> String
resp.collaboration_analysis_template.source_metadata.artifacts.additional_artifact_hashes #=> Array
resp.collaboration_analysis_template.source_metadata.artifacts.additional_artifact_hashes[0].sha256 #=> String
resp.collaboration_analysis_template.analysis_parameters #=> Array
resp.collaboration_analysis_template.analysis_parameters[0].name #=> String
resp.collaboration_analysis_template.analysis_parameters[0].type #=> String, one of "SMALLINT", "INTEGER", "BIGINT", "DECIMAL", "REAL", "DOUBLE_PRECISION", "BOOLEAN", "CHAR", "VARCHAR", "DATE", "TIMESTAMP", "TIMESTAMPTZ", "TIME", "TIMETZ", "VARBYTE", "BINARY", "BYTE", "CHARACTER", "DOUBLE", "FLOAT", "INT", "LONG", "NUMERIC", "SHORT", "STRING", "TIMESTAMP_LTZ", "TIMESTAMP_NTZ", "TINYINT"
resp.collaboration_analysis_template.analysis_parameters[0].default_value #=> String
resp.collaboration_analysis_template.validations #=> Array
resp.collaboration_analysis_template.validations[0].type #=> String, one of "DIFFERENTIAL_PRIVACY"
resp.collaboration_analysis_template.validations[0].status #=> String, one of "VALID", "INVALID", "UNABLE_TO_VALIDATE"
resp.collaboration_analysis_template.validations[0].reasons #=> Array
resp.collaboration_analysis_template.validations[0].reasons[0].message #=> String
resp.collaboration_analysis_template.error_message_configuration.type #=> String, one of "DETAILED"
resp.collaboration_analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.epsilon #=> Float
resp.collaboration_analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.max_membership_inference_attack_score #=> Float
resp.collaboration_analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping #=> Array
resp.collaboration_analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].column_name #=> String
resp.collaboration_analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].column_type #=> String, one of "CATEGORICAL", "NUMERICAL"
resp.collaboration_analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].is_predictive_value #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

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

  • :analysis_template_arn (required, String) —

    The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

Returns:

See Also:



2948
2949
2950
2951
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 2948

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

#get_collaboration_change_request(params = {}) ⇒ Types::GetCollaborationChangeRequestOutput

Retrieves detailed information about a specific collaboration change request.

Examples:

Request syntax with placeholder values


resp = client.get_collaboration_change_request({
  collaboration_identifier: "CollaborationIdentifier", # required
  change_request_identifier: "CollaborationChangeRequestIdentifier", # required
})

Response structure


resp.collaboration_change_request.id #=> String
resp.collaboration_change_request.collaboration_id #=> String
resp.collaboration_change_request.create_time #=> Time
resp.collaboration_change_request.update_time #=> Time
resp.collaboration_change_request.status #=> String, one of "PENDING", "APPROVED", "CANCELLED", "DENIED", "COMMITTED"
resp.collaboration_change_request.is_auto_approved #=> Boolean
resp.collaboration_change_request.changes #=> Array
resp.collaboration_change_request.changes[0].specification_type #=> String, one of "MEMBER", "COLLABORATION"
resp.collaboration_change_request.changes[0].specification.member. #=> String
resp.collaboration_change_request.changes[0].specification.member.member_abilities #=> Array
resp.collaboration_change_request.changes[0].specification.member.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS", "CAN_RUN_JOB"
resp.collaboration_change_request.changes[0].specification.member.ml_member_abilities.custom_ml_member_abilities #=> Array
resp.collaboration_change_request.changes[0].specification.member.ml_member_abilities.custom_ml_member_abilities[0] #=> String, one of "CAN_RECEIVE_MODEL_OUTPUT", "CAN_RECEIVE_INFERENCE_OUTPUT"
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.query_compute.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.machine_learning.model_training.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.machine_learning.model_inference.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.machine_learning.synthetic_data_generation.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.job_compute.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.display_name #=> String
resp.collaboration_change_request.changes[0].specification.collaboration.auto_approved_change_types #=> Array
resp.collaboration_change_request.changes[0].specification.collaboration.auto_approved_change_types[0] #=> String, one of "ADD_MEMBER", "GRANT_RECEIVE_RESULTS_ABILITY", "REVOKE_RECEIVE_RESULTS_ABILITY"
resp.collaboration_change_request.changes[0].types #=> Array
resp.collaboration_change_request.changes[0].types[0] #=> String, one of "ADD_MEMBER", "GRANT_RECEIVE_RESULTS_ABILITY", "REVOKE_RECEIVE_RESULTS_ABILITY", "EDIT_AUTO_APPROVED_CHANGE_TYPES", "ADD_PAYER_CANDIDATE", "REMOVE_PAYER_CANDIDATE", "GRANT_CAN_RECEIVE_MODEL_OUTPUT", "GRANT_CAN_RECEIVE_INFERENCE_OUTPUT", "REVOKE_CAN_RECEIVE_MODEL_OUTPUT", "REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT"
resp.collaboration_change_request.approvals #=> Hash
resp.collaboration_change_request.approvals["AccountId"].status #=> String, one of "APPROVED", "DENIED", "PENDING"

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    The identifier of the collaboration that the change request is made against.

  • :change_request_identifier (required, String) —

    A unique identifier for the change request to retrieve.

Returns:

See Also:



3006
3007
3008
3009
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3006

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

#get_collaboration_configured_audience_model_association(params = {}) ⇒ Types::GetCollaborationConfiguredAudienceModelAssociationOutput

Retrieves a configured audience model association within a collaboration.

Examples:

Request syntax with placeholder values


resp = client.get_collaboration_configured_audience_model_association({
  collaboration_identifier: "CollaborationIdentifier", # required
  configured_audience_model_association_identifier: "ConfiguredAudienceModelAssociationIdentifier", # required
})

Response structure


resp.collaboration_configured_audience_model_association.id #=> String
resp.collaboration_configured_audience_model_association.arn #=> String
resp.collaboration_configured_audience_model_association.collaboration_id #=> String
resp.collaboration_configured_audience_model_association.collaboration_arn #=> String
resp.collaboration_configured_audience_model_association.configured_audience_model_arn #=> String
resp.collaboration_configured_audience_model_association.name #=> String
resp.collaboration_configured_audience_model_association.description #=> String
resp.collaboration_configured_audience_model_association. #=> String
resp.collaboration_configured_audience_model_association.create_time #=> Time
resp.collaboration_configured_audience_model_association.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.

  • :configured_audience_model_association_identifier (required, String) —

    A unique identifier for the configured audience model association that you want to retrieve.

Returns:

See Also:



3050
3051
3052
3053
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3050

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

#get_collaboration_id_namespace_association(params = {}) ⇒ Types::GetCollaborationIdNamespaceAssociationOutput

Retrieves an ID namespace association from a specific collaboration.

Examples:

Request syntax with placeholder values


resp = client.get_collaboration_id_namespace_association({
  collaboration_identifier: "CollaborationIdentifier", # required
  id_namespace_association_identifier: "IdNamespaceAssociationIdentifier", # required
})

Response structure


resp.collaboration_id_namespace_association.id #=> String
resp.collaboration_id_namespace_association.arn #=> String
resp.collaboration_id_namespace_association.collaboration_id #=> String
resp.collaboration_id_namespace_association.collaboration_arn #=> String
resp.collaboration_id_namespace_association.name #=> String
resp.collaboration_id_namespace_association.description #=> String
resp.collaboration_id_namespace_association. #=> String
resp.collaboration_id_namespace_association.create_time #=> Time
resp.collaboration_id_namespace_association.update_time #=> Time
resp.collaboration_id_namespace_association.input_reference_config.input_reference_arn #=> String
resp.collaboration_id_namespace_association.input_reference_config.manage_resource_policies #=> Boolean
resp.collaboration_id_namespace_association.input_reference_properties.id_namespace_type #=> String, one of "SOURCE", "TARGET"
resp.collaboration_id_namespace_association.input_reference_properties.id_mapping_workflows_supported #=> Array
resp.collaboration_id_namespace_association.id_mapping_config.allow_use_as_dimension_column #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    The unique identifier of the collaboration that contains the ID namespace association that you want to retrieve.

  • :id_namespace_association_identifier (required, String) —

    The unique identifier of the ID namespace association that you want to retrieve.

Returns:

See Also:



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

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

#get_collaboration_privacy_budget_template(params = {}) ⇒ Types::GetCollaborationPrivacyBudgetTemplateOutput

Returns details about a specified privacy budget template.

Examples:

Request syntax with placeholder values


resp = client.get_collaboration_privacy_budget_template({
  collaboration_identifier: "CollaborationIdentifier", # required
  privacy_budget_template_identifier: "PrivacyBudgetTemplateIdentifier", # required
})

Response structure


resp.collaboration_privacy_budget_template.id #=> String
resp.collaboration_privacy_budget_template.arn #=> String
resp.collaboration_privacy_budget_template.collaboration_id #=> String
resp.collaboration_privacy_budget_template.collaboration_arn #=> String
resp.collaboration_privacy_budget_template. #=> String
resp.collaboration_privacy_budget_template.create_time #=> Time
resp.collaboration_privacy_budget_template.update_time #=> Time
resp.collaboration_privacy_budget_template.privacy_budget_type #=> String, one of "DIFFERENTIAL_PRIVACY", "ACCESS_BUDGET"
resp.collaboration_privacy_budget_template.auto_refresh #=> String, one of "CALENDAR_MONTH", "NONE"
resp.collaboration_privacy_budget_template.parameters.differential_privacy.epsilon #=> Integer
resp.collaboration_privacy_budget_template.parameters.differential_privacy.users_noise_per_query #=> Integer
resp.collaboration_privacy_budget_template.parameters.access_budget.budget_parameters #=> Array
resp.collaboration_privacy_budget_template.parameters.access_budget.budget_parameters[0].type #=> String, one of "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_WEEK", "LIFETIME"
resp.collaboration_privacy_budget_template.parameters.access_budget.budget_parameters[0].budget #=> Integer
resp.collaboration_privacy_budget_template.parameters.access_budget.budget_parameters[0].auto_refresh #=> String, one of "ENABLED", "DISABLED"
resp.collaboration_privacy_budget_template.parameters.access_budget.resource_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    A unique identifier for one of your collaborations.

  • :privacy_budget_template_identifier (required, String) —

    A unique identifier for one of your privacy budget templates.

Returns:

See Also:



3144
3145
3146
3147
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3144

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

#get_configured_audience_model_association(params = {}) ⇒ Types::GetConfiguredAudienceModelAssociationOutput

Returns information about a configured audience model association.

Examples:

Request syntax with placeholder values


resp = client.get_configured_audience_model_association({
  configured_audience_model_association_identifier: "ConfiguredAudienceModelAssociationIdentifier", # required
  membership_identifier: "MembershipIdentifier", # required
})

Response structure


resp.configured_audience_model_association.id #=> String
resp.configured_audience_model_association.arn #=> String
resp.configured_audience_model_association.configured_audience_model_arn #=> String
resp.configured_audience_model_association.membership_id #=> String
resp.configured_audience_model_association.membership_arn #=> String
resp.configured_audience_model_association.collaboration_id #=> String
resp.configured_audience_model_association.collaboration_arn #=> String
resp.configured_audience_model_association.name #=> String
resp.configured_audience_model_association.manage_resource_policies #=> Boolean
resp.configured_audience_model_association.description #=> String
resp.configured_audience_model_association.create_time #=> Time
resp.configured_audience_model_association.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :configured_audience_model_association_identifier (required, String) —

    A unique identifier for the configured audience model association that you want to retrieve.

  • :membership_identifier (required, String) —

    A unique identifier for the membership that contains the configured audience model association that you want to retrieve.

Returns:

See Also:



3189
3190
3191
3192
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3189

def get_configured_audience_model_association(params = {}, options = {})
  req = build_request(:get_configured_audience_model_association, 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.region #=> String, one of "us-west-1", "us-west-2", "us-east-1", "us-east-2", "af-south-1", "ap-east-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-5", "ap-southeast-4", "ap-southeast-7", "ap-south-1", "ap-northeast-3", "ap-northeast-1", "ap-northeast-2", "ca-central-1", "ca-west-1", "eu-south-1", "eu-west-3", "eu-south-2", "eu-central-2", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "me-south-1", "me-central-1", "il-central-1", "sa-east-1", "mx-central-1", "ap-east-2"
resp.configured_table.table_reference.glue.table_name #=> String
resp.configured_table.table_reference.glue.database_name #=> String
resp.configured_table.table_reference.snowflake.secret_arn #=> String
resp.configured_table.table_reference.snowflake. #=> String
resp.configured_table.table_reference.snowflake.database_name #=> String
resp.configured_table.table_reference.snowflake.table_name #=> String
resp.configured_table.table_reference.snowflake.schema_name #=> String
resp.configured_table.table_reference.snowflake.table_schema.v1 #=> Array
resp.configured_table.table_reference.snowflake.table_schema.v1[0].column_name #=> String
resp.configured_table.table_reference.snowflake.table_schema.v1[0].column_type #=> String
resp.configured_table.table_reference.athena.region #=> String, one of "us-west-1", "us-west-2", "us-east-1", "us-east-2", "af-south-1", "ap-east-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-5", "ap-southeast-4", "ap-southeast-7", "ap-south-1", "ap-northeast-3", "ap-northeast-1", "ap-northeast-2", "ca-central-1", "ca-west-1", "eu-south-1", "eu-west-3", "eu-south-2", "eu-central-2", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "me-south-1", "me-central-1", "il-central-1", "sa-east-1", "mx-central-1", "ap-east-2"
resp.configured_table.table_reference.athena.work_group #=> String
resp.configured_table.table_reference.athena.output_location #=> String
resp.configured_table.table_reference.athena.database_name #=> String
resp.configured_table.table_reference.athena.table_name #=> String
resp.configured_table.table_reference.athena.catalog_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", "CUSTOM"
resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE"
resp.configured_table.allowed_columns #=> Array
resp.configured_table.allowed_columns[0] #=> String
resp.configured_table.selected_analysis_methods #=> Array
resp.configured_table.selected_analysis_methods[0] #=> String, one of "DIRECT_QUERY", "DIRECT_JOB"

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:



3246
3247
3248
3249
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3246

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, CUSTOM
})

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.allowed_join_operators #=> Array
resp.analysis_rule.policy.v1.list.allowed_join_operators[0] #=> String, one of "OR", "AND"
resp.analysis_rule.policy.v1.list.list_columns #=> Array
resp.analysis_rule.policy.v1.list.list_columns[0] #=> String
resp.analysis_rule.policy.v1.list.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
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.allowed_join_operators #=> Array
resp.analysis_rule.policy.v1.aggregation.allowed_join_operators[0] #=> String, one of "OR", "AND"
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 "ABS", "CAST", "CEILING", "COALESCE", "CONVERT", "CURRENT_DATE", "DATEADD", "EXTRACT", "FLOOR", "GETDATE", "LN", "LOG", "LOWER", "ROUND", "RTRIM", "SQRT", "SUBSTRING", "TO_CHAR", "TO_DATE", "TO_NUMBER", "TO_TIMESTAMP", "TRIM", "TRUNC", "UPPER"
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.policy.v1.aggregation.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rule.policy.v1.custom.allowed_analyses #=> Array
resp.analysis_rule.policy.v1.custom.allowed_analyses[0] #=> String
resp.analysis_rule.policy.v1.custom.allowed_analysis_providers #=> Array
resp.analysis_rule.policy.v1.custom.allowed_analysis_providers[0] #=> String
resp.analysis_rule.policy.v1.custom.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rule.policy.v1.custom.disallowed_output_columns #=> Array
resp.analysis_rule.policy.v1.custom.disallowed_output_columns[0] #=> String
resp.analysis_rule.policy.v1.custom.differential_privacy.columns #=> Array
resp.analysis_rule.policy.v1.custom.differential_privacy.columns[0].name #=> String
resp.analysis_rule.policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rule.policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rule.policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rule.policy.v1.custom.allowed_additional_analyses[0] #=> String
resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
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:



3323
3324
3325
3326
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3323

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.analysis_rule_types #=> Array
resp.configured_table_association.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
resp.configured_table_association.create_time #=> Time
resp.configured_table_association.update_time #=> Time
resp.configured_table_association.child_resources #=> Array
resp.configured_table_association.child_resources[0].resource_id #=> String
resp.configured_table_association.child_resources[0].resource_type #=> String, one of "INTERMEDIATE_TABLE"
resp.configured_table_association.child_resources[0].resource_name #=> String
resp.configured_table_association.child_resources[0]. #=> String
resp.configured_table_association.child_resources[0].resource_status #=> String, one of "CREATED", "POPULATE_STARTED", "POPULATE_SUCCESS", "POPULATE_FAILED", "DISALLOWED_BY_DATA_PROVIDER", "BASE_TABLE_REMOVED", "RETENTION_PERIOD_EXPIRED"

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:



3375
3376
3377
3378
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3375

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

#get_configured_table_association_analysis_rule(params = {}) ⇒ Types::GetConfiguredTableAssociationAnalysisRuleOutput

Retrieves the analysis rule for a configured table association.

Examples:

Request syntax with placeholder values


resp = client.get_configured_table_association_analysis_rule({
  membership_identifier: "MembershipIdentifier", # required
  configured_table_association_identifier: "ConfiguredTableAssociationIdentifier", # required
  analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST, CUSTOM
})

Response structure


resp.analysis_rule.membership_identifier #=> String
resp.analysis_rule.configured_table_association_id #=> String
resp.analysis_rule.configured_table_association_arn #=> String
resp.analysis_rule.policy.v1.list.allowed_result_receivers #=> Array
resp.analysis_rule.policy.v1.list.allowed_result_receivers[0] #=> String
resp.analysis_rule.policy.v1.list.allowed_additional_analyses #=> Array
resp.analysis_rule.policy.v1.list.allowed_additional_analyses[0] #=> String
resp.analysis_rule.policy.v1.aggregation.allowed_result_receivers #=> Array
resp.analysis_rule.policy.v1.aggregation.allowed_result_receivers[0] #=> String
resp.analysis_rule.policy.v1.aggregation.allowed_additional_analyses #=> Array
resp.analysis_rule.policy.v1.aggregation.allowed_additional_analyses[0] #=> String
resp.analysis_rule.policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rule.policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rule.policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rule.policy.v1.custom.allowed_additional_analyses[0] #=> String
resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
resp.analysis_rule.create_time #=> Time
resp.analysis_rule.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

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

  • :configured_table_association_identifier (required, String) —

    The identifier for the configured table association that's related to the analysis rule.

  • :analysis_rule_type (required, String) —

    The type of analysis rule that you want to retrieve.

Returns:

See Also:



3430
3431
3432
3433
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3430

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

#get_id_mapping_table(params = {}) ⇒ Types::GetIdMappingTableOutput

Retrieves an ID mapping table.

Examples:

Request syntax with placeholder values


resp = client.get_id_mapping_table({
  id_mapping_table_identifier: "UUID", # required
  membership_identifier: "MembershipIdentifier", # required
})

Response structure


resp.id_mapping_table.id #=> String
resp.id_mapping_table.arn #=> String
resp.id_mapping_table.input_reference_config.input_reference_arn #=> String
resp.id_mapping_table.input_reference_config.manage_resource_policies #=> Boolean
resp.id_mapping_table.membership_id #=> String
resp.id_mapping_table.membership_arn #=> String
resp.id_mapping_table.collaboration_id #=> String
resp.id_mapping_table.collaboration_arn #=> String
resp.id_mapping_table.description #=> String
resp.id_mapping_table.name #=> String
resp.id_mapping_table.create_time #=> Time
resp.id_mapping_table.update_time #=> Time
resp.id_mapping_table.input_reference_properties.id_mapping_table_input_source #=> Array
resp.id_mapping_table.input_reference_properties.id_mapping_table_input_source[0].id_namespace_association_id #=> String
resp.id_mapping_table.input_reference_properties.id_mapping_table_input_source[0].type #=> String, one of "SOURCE", "TARGET"
resp.id_mapping_table.kms_key_arn #=> String
resp.id_mapping_table.child_resources #=> Array
resp.id_mapping_table.child_resources[0].resource_id #=> String
resp.id_mapping_table.child_resources[0].resource_type #=> String, one of "INTERMEDIATE_TABLE"
resp.id_mapping_table.child_resources[0].resource_name #=> String
resp.id_mapping_table.child_resources[0]. #=> String
resp.id_mapping_table.child_resources[0].resource_status #=> String, one of "CREATED", "POPULATE_STARTED", "POPULATE_SUCCESS", "POPULATE_FAILED", "DISALLOWED_BY_DATA_PROVIDER", "BASE_TABLE_REMOVED", "RETENTION_PERIOD_EXPIRED"

Parameters:

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

    ({})

Options Hash (params):

  • :id_mapping_table_identifier (required, String) —

    The unique identifier of the ID mapping table identifier that you want to retrieve.

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the ID mapping table that you want to retrieve.

Returns:

See Also:



3485
3486
3487
3488
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3485

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

#get_id_namespace_association(params = {}) ⇒ Types::GetIdNamespaceAssociationOutput

Retrieves an ID namespace association.

Examples:

Request syntax with placeholder values


resp = client.get_id_namespace_association({
  id_namespace_association_identifier: "IdNamespaceAssociationIdentifier", # required
  membership_identifier: "MembershipIdentifier", # required
})

Response structure


resp.id_namespace_association.id #=> String
resp.id_namespace_association.arn #=> String
resp.id_namespace_association.membership_id #=> String
resp.id_namespace_association.membership_arn #=> String
resp.id_namespace_association.collaboration_id #=> String
resp.id_namespace_association.collaboration_arn #=> String
resp.id_namespace_association.name #=> String
resp.id_namespace_association.description #=> String
resp.id_namespace_association.create_time #=> Time
resp.id_namespace_association.update_time #=> Time
resp.id_namespace_association.input_reference_config.input_reference_arn #=> String
resp.id_namespace_association.input_reference_config.manage_resource_policies #=> Boolean
resp.id_namespace_association.input_reference_properties.id_namespace_type #=> String, one of "SOURCE", "TARGET"
resp.id_namespace_association.input_reference_properties.id_mapping_workflows_supported #=> Array
resp.id_namespace_association.id_mapping_config.allow_use_as_dimension_column #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :id_namespace_association_identifier (required, String) —

    The unique identifier of the ID namespace association that you want to retrieve.

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the ID namespace association that you want to retrieve.

Returns:

See Also:



3533
3534
3535
3536
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3533

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

#get_intermediate_table(params = {}) ⇒ Types::GetIntermediateTableOutput

Retrieves an intermediate table. Returns the full details of the intermediate table, including schema, table dependencies, inherited constraints, child resources, and status. Only the intermediate table owner can call this operation.

Examples:

Request syntax with placeholder values


resp = client.get_intermediate_table({
  intermediate_table_identifier: "IntermediateTableIdentifier", # required
  membership_identifier: "MembershipIdentifier", # required
})

Response structure


resp.intermediate_table.id #=> String
resp.intermediate_table.arn #=> String
resp.intermediate_table.name #=> String
resp.intermediate_table.description #=> String
resp.intermediate_table.membership_arn #=> String
resp.intermediate_table.membership_id #=> String
resp.intermediate_table.collaboration_arn #=> String
resp.intermediate_table.collaboration_id #=> String
resp.intermediate_table.child_resources #=> Array
resp.intermediate_table.child_resources[0].resource_id #=> String
resp.intermediate_table.child_resources[0].resource_type #=> String, one of "INTERMEDIATE_TABLE"
resp.intermediate_table.child_resources[0].resource_name #=> String
resp.intermediate_table.child_resources[0]. #=> String
resp.intermediate_table.child_resources[0].resource_status #=> String, one of "CREATED", "POPULATE_STARTED", "POPULATE_SUCCESS", "POPULATE_FAILED", "DISALLOWED_BY_DATA_PROVIDER", "BASE_TABLE_REMOVED", "RETENTION_PERIOD_EXPIRED"
resp.intermediate_table.create_time #=> Time
resp.intermediate_table.update_time #=> Time
resp.intermediate_table.status #=> String, one of "CREATED", "POPULATE_STARTED", "POPULATE_SUCCESS", "POPULATE_FAILED", "DISALLOWED_BY_DATA_PROVIDER", "BASE_TABLE_REMOVED", "RETENTION_PERIOD_EXPIRED"
resp.intermediate_table.status_reason #=> String
resp.intermediate_table.kms_key_arn #=> String
resp.intermediate_table.population_analysis_configuration.sql_parameters.query_string #=> String
resp.intermediate_table.population_analysis_configuration.sql_parameters.analysis_template_arn #=> String
resp.intermediate_table.retention_in_days #=> Integer
resp.intermediate_table.table_dependencies #=> Array
resp.intermediate_table.table_dependencies[0].id #=> String
resp.intermediate_table.table_dependencies[0].name #=> String
resp.intermediate_table.table_dependencies[0].type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.table_dependencies[0].parent_type #=> String, one of "DIRECT", "INDIRECT"
resp.intermediate_table.table_dependencies[0]. #=> String
resp.intermediate_table.intermediate_table_version.version_id #=> String
resp.intermediate_table.intermediate_table_version.analysis_id #=> String
resp.intermediate_table.intermediate_table_version.analysis_type #=> String, one of "QUERY"
resp.intermediate_table.intermediate_table_version.kms_key_arn #=> String
resp.intermediate_table.intermediate_table_version.parameters #=> Hash
resp.intermediate_table.intermediate_table_version.parameters["ParameterName"] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.value #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0].name #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0].id #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0].type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0].value #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0]. #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].name #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].id #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0]. #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].name #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].id #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0]. #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].column #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].source_column #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].source_name #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].source_id #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].source_type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0]. #=> String
resp.intermediate_table.intermediate_table_version.expiration_time #=> Time
resp.intermediate_table.analysis_rule_types #=> Array
resp.intermediate_table.analysis_rule_types[0] #=> String, one of "CUSTOM"
resp.intermediate_table.schema.columns #=> Array
resp.intermediate_table.schema.columns[0].name #=> String
resp.intermediate_table.schema.columns[0].type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :intermediate_table_identifier (required, String) —

    The unique identifier of the intermediate table to retrieve.

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the intermediate table.

Returns:

See Also:



3642
3643
3644
3645
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3642

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

#get_intermediate_table_analysis_rule(params = {}) ⇒ Types::GetIntermediateTableAnalysisRuleOutput

Retrieves the analysis rule for an intermediate table.

Examples:

Request syntax with placeholder values


resp = client.get_intermediate_table_analysis_rule({
  membership_identifier: "MembershipIdentifier", # required
  intermediate_table_identifier: "IntermediateTableIdentifier", # required
  analysis_rule_type: "CUSTOM", # required, accepts CUSTOM
})

Response structure


resp.analysis_rule.intermediate_table_identifier #=> String
resp.analysis_rule.intermediate_table_arn #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_analyses #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_analyses[0] #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_additional_analyses[0] #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_analysis_providers #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_analysis_providers[0] #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.differential_privacy.columns #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.differential_privacy.columns[0].name #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.disallowed_output_columns #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.disallowed_output_columns[0] #=> String
resp.analysis_rule.analysis_rule_type #=> String, one of "CUSTOM"
resp.analysis_rule.create_time #=> Time
resp.analysis_rule.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the intermediate table.

  • :intermediate_table_identifier (required, String) —

    The unique identifier of the intermediate table for which to retrieve the analysis rule.

  • :analysis_rule_type (required, String) —

    The type of analysis rule to retrieve. Currently, only CUSTOM is supported.

Returns:

See Also:



3698
3699
3700
3701
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3698

def get_intermediate_table_analysis_rule(params = {}, options = {})
  req = build_request(:get_intermediate_table_analysis_rule, 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", "CAN_RUN_JOB"
resp.membership.ml_member_abilities.custom_ml_member_abilities #=> Array
resp.membership.ml_member_abilities.custom_ml_member_abilities[0] #=> String, one of "CAN_RECEIVE_MODEL_OUTPUT", "CAN_RECEIVE_INFERENCE_OUTPUT"
resp.membership.query_log_status #=> String, one of "ENABLED", "DISABLED"
resp.membership.job_log_status #=> String, one of "ENABLED", "DISABLED"
resp.membership.default_result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
resp.membership.default_result_configuration.output_configuration.s3.bucket #=> String
resp.membership.default_result_configuration.output_configuration.s3.key_prefix #=> String
resp.membership.default_result_configuration.output_configuration.s3.single_file_output #=> Boolean
resp.membership.default_result_configuration.role_arn #=> String
resp.membership.default_job_result_configuration.output_configuration.s3.bucket #=> String
resp.membership.default_job_result_configuration.output_configuration.s3.key_prefix #=> String
resp.membership.default_job_result_configuration.role_arn #=> String
resp.membership.payment_configuration.query_compute.is_responsible #=> Boolean
resp.membership.payment_configuration.machine_learning.model_training.is_responsible #=> Boolean
resp.membership.payment_configuration.machine_learning.model_inference.is_responsible #=> Boolean
resp.membership.payment_configuration.machine_learning.synthetic_data_generation.is_responsible #=> Boolean
resp.membership.payment_configuration.job_compute.is_responsible #=> Boolean
resp.membership.is_metrics_enabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The identifier for a membership resource.

Returns:

See Also:



3755
3756
3757
3758
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3755

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

#get_privacy_budget_template(params = {}) ⇒ Types::GetPrivacyBudgetTemplateOutput

Returns details for a specified privacy budget template.

Examples:

Request syntax with placeholder values


resp = client.get_privacy_budget_template({
  membership_identifier: "MembershipIdentifier", # required
  privacy_budget_template_identifier: "PrivacyBudgetTemplateIdentifier", # required
})

Response structure


resp.privacy_budget_template.id #=> String
resp.privacy_budget_template.arn #=> String
resp.privacy_budget_template.membership_id #=> String
resp.privacy_budget_template.membership_arn #=> String
resp.privacy_budget_template.collaboration_id #=> String
resp.privacy_budget_template.collaboration_arn #=> String
resp.privacy_budget_template.create_time #=> Time
resp.privacy_budget_template.update_time #=> Time
resp.privacy_budget_template.privacy_budget_type #=> String, one of "DIFFERENTIAL_PRIVACY", "ACCESS_BUDGET"
resp.privacy_budget_template.auto_refresh #=> String, one of "CALENDAR_MONTH", "NONE"
resp.privacy_budget_template.parameters.differential_privacy.epsilon #=> Integer
resp.privacy_budget_template.parameters.differential_privacy.users_noise_per_query #=> Integer
resp.privacy_budget_template.parameters.access_budget.budget_parameters #=> Array
resp.privacy_budget_template.parameters.access_budget.budget_parameters[0].type #=> String, one of "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_WEEK", "LIFETIME"
resp.privacy_budget_template.parameters.access_budget.budget_parameters[0].budget #=> Integer
resp.privacy_budget_template.parameters.access_budget.budget_parameters[0].auto_refresh #=> String, one of "ENABLED", "DISABLED"
resp.privacy_budget_template.parameters.access_budget.resource_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    A unique identifier for one of your memberships for a collaboration. The privacy budget template is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.

  • :privacy_budget_template_identifier (required, String) —

    A unique identifier for your privacy budget template.

Returns:

See Also:



3805
3806
3807
3808
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3805

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

#get_protected_job(params = {}) ⇒ Types::GetProtectedJobOutput

Returns job processing metadata.

Examples:

Request syntax with placeholder values


resp = client.get_protected_job({
  membership_identifier: "MembershipIdentifier", # required
  protected_job_identifier: "ProtectedJobIdentifier", # required
})

Response structure


resp.protected_job.id #=> String
resp.protected_job.membership_id #=> String
resp.protected_job.membership_arn #=> String
resp.protected_job.create_time #=> Time
resp.protected_job.job_parameters.analysis_template_arn #=> String
resp.protected_job.job_parameters.parameters #=> Hash
resp.protected_job.job_parameters.parameters["JobParameterName"] #=> String
resp.protected_job.status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS"
resp.protected_job.result_configuration.output_configuration.s3.bucket #=> String
resp.protected_job.result_configuration.output_configuration.s3.key_prefix #=> String
resp.protected_job.result_configuration.output_configuration.member. #=> String
resp.protected_job.statistics.total_duration_in_millis #=> Integer
resp.protected_job.statistics.billed_resource_utilization.units #=> Float
resp.protected_job.result.output.s3.location #=> String
resp.protected_job.result.output.member_list #=> Array
resp.protected_job.result.output.member_list[0]. #=> String
resp.protected_job.error.message #=> String
resp.protected_job.error.code #=> String
resp.protected_job.compute_configuration.worker.type #=> String, one of "CR.1X", "CR.4X"
resp.protected_job.compute_configuration.worker.number #=> Integer
resp.protected_job.compute_configuration.worker.properties.spark #=> Hash
resp.protected_job.compute_configuration.worker.properties.spark["SparkPropertyKey"] #=> String
resp.protected_job. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The identifier for a membership in a protected job instance.

  • :protected_job_identifier (required, String) —

    The identifier for the protected job instance.

Returns:

See Also:



3859
3860
3861
3862
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3859

def get_protected_job(params = {}, options = {})
  req = build_request(:get_protected_job, 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.sql_parameters.analysis_template_arn #=> String
resp.protected_query.sql_parameters.parameters #=> Hash
resp.protected_query.sql_parameters.parameters["ParameterName"] #=> 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.result_configuration.output_configuration.s3.single_file_output #=> Boolean
resp.protected_query.result_configuration.output_configuration.member. #=> String
resp.protected_query.result_configuration.output_configuration.distribute.locations #=> Array
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].s3.result_format #=> String, one of "CSV", "PARQUET"
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].s3.bucket #=> String
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].s3.key_prefix #=> String
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].s3.single_file_output #=> Boolean
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].member. #=> String
resp.protected_query.result_configuration.output_configuration.intermediate_table.id #=> String
resp.protected_query.result_configuration.output_configuration.intermediate_table.arn #=> String
resp.protected_query.result_configuration.output_configuration.intermediate_table.name #=> String
resp.protected_query.statistics.total_duration_in_millis #=> Integer
resp.protected_query.statistics.billed_resource_utilization.units #=> Float
resp.protected_query.result.output.s3.location #=> String
resp.protected_query.result.output.member_list #=> Array
resp.protected_query.result.output.member_list[0]. #=> String
resp.protected_query.result.output.distribute.s3.location #=> String
resp.protected_query.result.output.distribute.member_list #=> Array
resp.protected_query.result.output.distribute.member_list[0]. #=> String
resp.protected_query.error.message #=> String
resp.protected_query.error.code #=> String
resp.protected_query.differential_privacy.sensitivity_parameters #=> Array
resp.protected_query.differential_privacy.sensitivity_parameters[0].aggregation_type #=> String, one of "AVG", "COUNT", "COUNT_DISTINCT", "SUM", "STDDEV"
resp.protected_query.differential_privacy.sensitivity_parameters[0].aggregation_expression #=> String
resp.protected_query.differential_privacy.sensitivity_parameters[0].user_contribution_limit #=> Integer
resp.protected_query.differential_privacy.sensitivity_parameters[0].min_column_value #=> Float
resp.protected_query.differential_privacy.sensitivity_parameters[0].max_column_value #=> Float
resp.protected_query.compute_configuration.worker.type #=> String, one of "CR.1X", "CR.4X"
resp.protected_query.compute_configuration.worker.number #=> Integer
resp.protected_query.compute_configuration.worker.properties.spark #=> Hash
resp.protected_query.compute_configuration.worker.properties.spark["SparkPropertyKey"] #=> String
resp.protected_query. #=> 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:



3934
3935
3936
3937
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 3934

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", "CUSTOM", "ID_MAPPING_TABLE"
resp.schema.analysis_method #=> String, one of "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE"
resp.schema.selected_analysis_methods #=> Array
resp.schema.selected_analysis_methods[0] #=> String, one of "DIRECT_QUERY", "DIRECT_JOB"
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", "ID_MAPPING_TABLE", "INTERMEDIATE_TABLE"
resp.schema.schema_status_details #=> Array
resp.schema.schema_status_details[0].status #=> String, one of "READY", "NOT_READY"
resp.schema.schema_status_details[0].reasons #=> Array
resp.schema.schema_status_details[0].reasons[0].code #=> String, one of "ANALYSIS_RULE_MISSING", "ANALYSIS_TEMPLATES_NOT_CONFIGURED", "ANALYSIS_PROVIDERS_NOT_CONFIGURED", "DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED", "ID_MAPPING_TABLE_NOT_POPULATED", "COLLABORATION_ANALYSIS_RULE_NOT_CONFIGURED", "ADDITIONAL_ANALYSES_NOT_CONFIGURED", "RESULT_RECEIVERS_NOT_CONFIGURED", "ADDITIONAL_ANALYSES_NOT_ALLOWED", "RESULT_RECEIVERS_NOT_ALLOWED", "ANALYSIS_RULE_TYPES_NOT_COMPATIBLE", "INTERMEDIATE_TABLE_NOT_POPULATED", "INTERMEDIATE_TABLE_ANALYSIS_RULE_MISSING", "INTERMEDIATE_TABLE_BASE_TABLE_REMOVED", "INTERMEDIATE_TABLE_INHERITED_CONSTRAINTS_VIOLATED", "INTERMEDIATE_TABLE_DISALLOWED_BY_DATA_PROVIDER", "INTERMEDIATE_TABLE_RETENTION_PERIOD_EXPIRED"
resp.schema.schema_status_details[0].reasons[0].message #=> String
resp.schema.schema_status_details[0].analysis_rule_type #=> String, one of "AGGREGATION", "LIST", "CUSTOM", "ID_MAPPING_TABLE"
resp.schema.schema_status_details[0].configurations #=> Array
resp.schema.schema_status_details[0].configurations[0] #=> String, one of "DIFFERENTIAL_PRIVACY"
resp.schema.schema_status_details[0].analysis_type #=> String, one of "DIRECT_ANALYSIS", "ADDITIONAL_ANALYSIS"
resp.schema.resource_arn #=> String
resp.schema.schema_type_properties.id_mapping_table.id_mapping_table_input_source #=> Array
resp.schema.schema_type_properties.id_mapping_table.id_mapping_table_input_source[0].id_namespace_association_id #=> String
resp.schema.schema_type_properties.id_mapping_table.id_mapping_table_input_source[0].type #=> String, one of "SOURCE", "TARGET"
resp.schema.schema_type_properties.id_mapping_table.id_mapping_table_id #=> String
resp.schema.schema_type_properties.intermediate_table.intermediate_table_id #=> String
resp.schema.schema_type_properties.configured_table_association.configured_table_association_id #=> 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.

  • :name (required, String) —

    The name of the relation to retrieve the schema for.

Returns:

See Also:



4001
4002
4003
4004
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4001

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, CUSTOM, ID_MAPPING_TABLE
})

Response structure


resp.analysis_rule.collaboration_id #=> String
resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST", "CUSTOM", "ID_MAPPING_TABLE"
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.allowed_join_operators #=> Array
resp.analysis_rule.policy.v1.list.allowed_join_operators[0] #=> String, one of "OR", "AND"
resp.analysis_rule.policy.v1.list.list_columns #=> Array
resp.analysis_rule.policy.v1.list.list_columns[0] #=> String
resp.analysis_rule.policy.v1.list.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
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.allowed_join_operators #=> Array
resp.analysis_rule.policy.v1.aggregation.allowed_join_operators[0] #=> String, one of "OR", "AND"
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 "ABS", "CAST", "CEILING", "COALESCE", "CONVERT", "CURRENT_DATE", "DATEADD", "EXTRACT", "FLOOR", "GETDATE", "LN", "LOG", "LOWER", "ROUND", "RTRIM", "SQRT", "SUBSTRING", "TO_CHAR", "TO_DATE", "TO_NUMBER", "TO_TIMESTAMP", "TRIM", "TRUNC", "UPPER"
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.policy.v1.aggregation.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rule.policy.v1.custom.allowed_analyses #=> Array
resp.analysis_rule.policy.v1.custom.allowed_analyses[0] #=> String
resp.analysis_rule.policy.v1.custom.allowed_analysis_providers #=> Array
resp.analysis_rule.policy.v1.custom.allowed_analysis_providers[0] #=> String
resp.analysis_rule.policy.v1.custom.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rule.policy.v1.custom.disallowed_output_columns #=> Array
resp.analysis_rule.policy.v1.custom.disallowed_output_columns[0] #=> String
resp.analysis_rule.policy.v1.custom.differential_privacy.columns #=> Array
resp.analysis_rule.policy.v1.custom.differential_privacy.columns[0].name #=> String
resp.analysis_rule.policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rule.policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rule.policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rule.policy.v1.custom.allowed_additional_analyses[0] #=> String
resp.analysis_rule.policy.v1.id_mapping_table.join_columns #=> Array
resp.analysis_rule.policy.v1.id_mapping_table.join_columns[0] #=> String
resp.analysis_rule.policy.v1.id_mapping_table.query_constraints #=> Array
resp.analysis_rule.policy.v1.id_mapping_table.query_constraints[0].require_overlap.columns #=> Array
resp.analysis_rule.policy.v1.id_mapping_table.query_constraints[0].require_overlap.columns[0] #=> String
resp.analysis_rule.policy.v1.id_mapping_table.dimension_columns #=> Array
resp.analysis_rule.policy.v1.id_mapping_table.dimension_columns[0] #=> String
resp.analysis_rule.collaboration_policy.v1.list.allowed_result_receivers #=> Array
resp.analysis_rule.collaboration_policy.v1.list.allowed_result_receivers[0] #=> String
resp.analysis_rule.collaboration_policy.v1.list.allowed_additional_analyses #=> Array
resp.analysis_rule.collaboration_policy.v1.list.allowed_additional_analyses[0] #=> String
resp.analysis_rule.collaboration_policy.v1.aggregation.allowed_result_receivers #=> Array
resp.analysis_rule.collaboration_policy.v1.aggregation.allowed_result_receivers[0] #=> String
resp.analysis_rule.collaboration_policy.v1.aggregation.allowed_additional_analyses #=> Array
resp.analysis_rule.collaboration_policy.v1.aggregation.allowed_additional_analyses[0] #=> String
resp.analysis_rule.collaboration_policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rule.collaboration_policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rule.collaboration_policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rule.collaboration_policy.v1.custom.allowed_additional_analyses[0] #=> String
resp.analysis_rule.consolidated_policy.v1.list.join_columns #=> Array
resp.analysis_rule.consolidated_policy.v1.list.join_columns[0] #=> String
resp.analysis_rule.consolidated_policy.v1.list.allowed_join_operators #=> Array
resp.analysis_rule.consolidated_policy.v1.list.allowed_join_operators[0] #=> String, one of "OR", "AND"
resp.analysis_rule.consolidated_policy.v1.list.list_columns #=> Array
resp.analysis_rule.consolidated_policy.v1.list.list_columns[0] #=> String
resp.analysis_rule.consolidated_policy.v1.list.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rule.consolidated_policy.v1.list.allowed_result_receivers #=> Array
resp.analysis_rule.consolidated_policy.v1.list.allowed_result_receivers[0] #=> String
resp.analysis_rule.consolidated_policy.v1.list.allowed_additional_analyses #=> Array
resp.analysis_rule.consolidated_policy.v1.list.allowed_additional_analyses[0] #=> String
resp.analysis_rule.consolidated_policy.v1.aggregation.aggregate_columns #=> Array
resp.analysis_rule.consolidated_policy.v1.aggregation.aggregate_columns[0].column_names #=> Array
resp.analysis_rule.consolidated_policy.v1.aggregation.aggregate_columns[0].column_names[0] #=> String
resp.analysis_rule.consolidated_policy.v1.aggregation.aggregate_columns[0].function #=> String, one of "SUM", "SUM_DISTINCT", "COUNT", "COUNT_DISTINCT", "AVG"
resp.analysis_rule.consolidated_policy.v1.aggregation.join_columns #=> Array
resp.analysis_rule.consolidated_policy.v1.aggregation.join_columns[0] #=> String
resp.analysis_rule.consolidated_policy.v1.aggregation.join_required #=> String, one of "QUERY_RUNNER"
resp.analysis_rule.consolidated_policy.v1.aggregation.allowed_join_operators #=> Array
resp.analysis_rule.consolidated_policy.v1.aggregation.allowed_join_operators[0] #=> String, one of "OR", "AND"
resp.analysis_rule.consolidated_policy.v1.aggregation.dimension_columns #=> Array
resp.analysis_rule.consolidated_policy.v1.aggregation.dimension_columns[0] #=> String
resp.analysis_rule.consolidated_policy.v1.aggregation.scalar_functions #=> Array
resp.analysis_rule.consolidated_policy.v1.aggregation.scalar_functions[0] #=> String, one of "ABS", "CAST", "CEILING", "COALESCE", "CONVERT", "CURRENT_DATE", "DATEADD", "EXTRACT", "FLOOR", "GETDATE", "LN", "LOG", "LOWER", "ROUND", "RTRIM", "SQRT", "SUBSTRING", "TO_CHAR", "TO_DATE", "TO_NUMBER", "TO_TIMESTAMP", "TRIM", "TRUNC", "UPPER"
resp.analysis_rule.consolidated_policy.v1.aggregation.output_constraints #=> Array
resp.analysis_rule.consolidated_policy.v1.aggregation.output_constraints[0].column_name #=> String
resp.analysis_rule.consolidated_policy.v1.aggregation.output_constraints[0].minimum #=> Integer
resp.analysis_rule.consolidated_policy.v1.aggregation.output_constraints[0].type #=> String, one of "COUNT_DISTINCT"
resp.analysis_rule.consolidated_policy.v1.aggregation.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rule.consolidated_policy.v1.aggregation.allowed_result_receivers #=> Array
resp.analysis_rule.consolidated_policy.v1.aggregation.allowed_result_receivers[0] #=> String
resp.analysis_rule.consolidated_policy.v1.aggregation.allowed_additional_analyses #=> Array
resp.analysis_rule.consolidated_policy.v1.aggregation.allowed_additional_analyses[0] #=> String
resp.analysis_rule.consolidated_policy.v1.custom.allowed_analyses #=> Array
resp.analysis_rule.consolidated_policy.v1.custom.allowed_analyses[0] #=> String
resp.analysis_rule.consolidated_policy.v1.custom.allowed_analysis_providers #=> Array
resp.analysis_rule.consolidated_policy.v1.custom.allowed_analysis_providers[0] #=> String
resp.analysis_rule.consolidated_policy.v1.custom.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rule.consolidated_policy.v1.custom.disallowed_output_columns #=> Array
resp.analysis_rule.consolidated_policy.v1.custom.disallowed_output_columns[0] #=> String
resp.analysis_rule.consolidated_policy.v1.custom.differential_privacy.columns #=> Array
resp.analysis_rule.consolidated_policy.v1.custom.differential_privacy.columns[0].name #=> String
resp.analysis_rule.consolidated_policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rule.consolidated_policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rule.consolidated_policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rule.consolidated_policy.v1.custom.allowed_additional_analyses[0] #=> 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.

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



4147
4148
4149
4150
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4147

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

#list_analysis_templates(params = {}) ⇒ Types::ListAnalysisTemplatesOutput

Lists analysis templates that the caller owns.

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

Response structure


resp.next_token #=> String
resp.analysis_template_summaries #=> Array
resp.analysis_template_summaries[0].arn #=> String
resp.analysis_template_summaries[0].create_time #=> Time
resp.analysis_template_summaries[0].id #=> String
resp.analysis_template_summaries[0].name #=> String
resp.analysis_template_summaries[0].update_time #=> Time
resp.analysis_template_summaries[0].membership_arn #=> String
resp.analysis_template_summaries[0].membership_id #=> String
resp.analysis_template_summaries[0].collaboration_arn #=> String
resp.analysis_template_summaries[0].collaboration_id #=> String
resp.analysis_template_summaries[0].description #=> String
resp.analysis_template_summaries[0].is_synthetic_data #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The identifier for a membership resource.

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Returns:

See Also:



4201
4202
4203
4204
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4201

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

#list_collaboration_analysis_templates(params = {}) ⇒ Types::ListCollaborationAnalysisTemplatesOutput

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

Response structure


resp.next_token #=> String
resp.collaboration_analysis_template_summaries #=> Array
resp.collaboration_analysis_template_summaries[0].arn #=> String
resp.collaboration_analysis_template_summaries[0].create_time #=> Time
resp.collaboration_analysis_template_summaries[0].id #=> String
resp.collaboration_analysis_template_summaries[0].name #=> String
resp.collaboration_analysis_template_summaries[0].update_time #=> Time
resp.collaboration_analysis_template_summaries[0].collaboration_arn #=> String
resp.collaboration_analysis_template_summaries[0].collaboration_id #=> String
resp.collaboration_analysis_template_summaries[0]. #=> String
resp.collaboration_analysis_template_summaries[0].description #=> String
resp.collaboration_analysis_template_summaries[0].is_synthetic_data #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

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

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Returns:

See Also:



4255
4256
4257
4258
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4255

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

#list_collaboration_change_requests(params = {}) ⇒ Types::ListCollaborationChangeRequestsOutput

Lists all change requests for a collaboration with pagination support. Returns change requests sorted by creation time.

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_collaboration_change_requests({
  collaboration_identifier: "CollaborationIdentifier", # required
  status: "PENDING", # accepts PENDING, APPROVED, CANCELLED, DENIED, COMMITTED
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.collaboration_change_request_summaries #=> Array
resp.collaboration_change_request_summaries[0].id #=> String
resp.collaboration_change_request_summaries[0].collaboration_id #=> String
resp.collaboration_change_request_summaries[0].create_time #=> Time
resp.collaboration_change_request_summaries[0].update_time #=> Time
resp.collaboration_change_request_summaries[0].status #=> String, one of "PENDING", "APPROVED", "CANCELLED", "DENIED", "COMMITTED"
resp.collaboration_change_request_summaries[0].is_auto_approved #=> Boolean
resp.collaboration_change_request_summaries[0].changes #=> Array
resp.collaboration_change_request_summaries[0].changes[0].specification_type #=> String, one of "MEMBER", "COLLABORATION"
resp.collaboration_change_request_summaries[0].changes[0].specification.member. #=> String
resp.collaboration_change_request_summaries[0].changes[0].specification.member.member_abilities #=> Array
resp.collaboration_change_request_summaries[0].changes[0].specification.member.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS", "CAN_RUN_JOB"
resp.collaboration_change_request_summaries[0].changes[0].specification.member.ml_member_abilities.custom_ml_member_abilities #=> Array
resp.collaboration_change_request_summaries[0].changes[0].specification.member.ml_member_abilities.custom_ml_member_abilities[0] #=> String, one of "CAN_RECEIVE_MODEL_OUTPUT", "CAN_RECEIVE_INFERENCE_OUTPUT"
resp.collaboration_change_request_summaries[0].changes[0].specification.member.payment_configuration.query_compute.is_responsible #=> Boolean
resp.collaboration_change_request_summaries[0].changes[0].specification.member.payment_configuration.machine_learning.model_training.is_responsible #=> Boolean
resp.collaboration_change_request_summaries[0].changes[0].specification.member.payment_configuration.machine_learning.model_inference.is_responsible #=> Boolean
resp.collaboration_change_request_summaries[0].changes[0].specification.member.payment_configuration.machine_learning.synthetic_data_generation.is_responsible #=> Boolean
resp.collaboration_change_request_summaries[0].changes[0].specification.member.payment_configuration.job_compute.is_responsible #=> Boolean
resp.collaboration_change_request_summaries[0].changes[0].specification.member.display_name #=> String
resp.collaboration_change_request_summaries[0].changes[0].specification.collaboration.auto_approved_change_types #=> Array
resp.collaboration_change_request_summaries[0].changes[0].specification.collaboration.auto_approved_change_types[0] #=> String, one of "ADD_MEMBER", "GRANT_RECEIVE_RESULTS_ABILITY", "REVOKE_RECEIVE_RESULTS_ABILITY"
resp.collaboration_change_request_summaries[0].changes[0].types #=> Array
resp.collaboration_change_request_summaries[0].changes[0].types[0] #=> String, one of "ADD_MEMBER", "GRANT_RECEIVE_RESULTS_ABILITY", "REVOKE_RECEIVE_RESULTS_ABILITY", "EDIT_AUTO_APPROVED_CHANGE_TYPES", "ADD_PAYER_CANDIDATE", "REMOVE_PAYER_CANDIDATE", "GRANT_CAN_RECEIVE_MODEL_OUTPUT", "GRANT_CAN_RECEIVE_INFERENCE_OUTPUT", "REVOKE_CAN_RECEIVE_MODEL_OUTPUT", "REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT"
resp.collaboration_change_request_summaries[0].approvals #=> Hash
resp.collaboration_change_request_summaries[0].approvals["AccountId"].status #=> String, one of "APPROVED", "DENIED", "PENDING"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    The identifier of the collaboration that the change request is made against.

  • :status (String) —

    A filter to only return change requests with the specified status.

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call.

Returns:

See Also:



4327
4328
4329
4330
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4327

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

#list_collaboration_configured_audience_model_associations(params = {}) ⇒ Types::ListCollaborationConfiguredAudienceModelAssociationsOutput

Lists configured audience model associations 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_collaboration_configured_audience_model_associations({
  collaboration_identifier: "CollaborationIdentifier", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.collaboration_configured_audience_model_association_summaries #=> Array
resp.collaboration_configured_audience_model_association_summaries[0].arn #=> String
resp.collaboration_configured_audience_model_association_summaries[0].create_time #=> Time
resp.collaboration_configured_audience_model_association_summaries[0].id #=> String
resp.collaboration_configured_audience_model_association_summaries[0].name #=> String
resp.collaboration_configured_audience_model_association_summaries[0].update_time #=> Time
resp.collaboration_configured_audience_model_association_summaries[0].collaboration_arn #=> String
resp.collaboration_configured_audience_model_association_summaries[0].collaboration_id #=> String
resp.collaboration_configured_audience_model_association_summaries[0]. #=> String
resp.collaboration_configured_audience_model_association_summaries[0].description #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Returns:

See Also:



4380
4381
4382
4383
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4380

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

#list_collaboration_id_namespace_associations(params = {}) ⇒ Types::ListCollaborationIdNamespaceAssociationsOutput

Returns a list of the ID namespace associations in 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_collaboration_id_namespace_associations({
  collaboration_identifier: "CollaborationIdentifier", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.collaboration_id_namespace_association_summaries #=> Array
resp.collaboration_id_namespace_association_summaries[0].arn #=> String
resp.collaboration_id_namespace_association_summaries[0].create_time #=> Time
resp.collaboration_id_namespace_association_summaries[0].id #=> String
resp.collaboration_id_namespace_association_summaries[0].update_time #=> Time
resp.collaboration_id_namespace_association_summaries[0].collaboration_arn #=> String
resp.collaboration_id_namespace_association_summaries[0].collaboration_id #=> String
resp.collaboration_id_namespace_association_summaries[0]. #=> String
resp.collaboration_id_namespace_association_summaries[0].input_reference_config.input_reference_arn #=> String
resp.collaboration_id_namespace_association_summaries[0].input_reference_config.manage_resource_policies #=> Boolean
resp.collaboration_id_namespace_association_summaries[0].name #=> String
resp.collaboration_id_namespace_association_summaries[0].description #=> String
resp.collaboration_id_namespace_association_summaries[0].input_reference_properties.id_namespace_type #=> String, one of "SOURCE", "TARGET"

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    The unique identifier of the collaboration that contains the ID namespace associations that you want to retrieve.

  • :next_token (String) —

    The pagination token that's used to fetch the next set 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.>

Returns:

See Also:



4435
4436
4437
4438
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4435

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

#list_collaboration_privacy_budget_templates(params = {}) ⇒ Types::ListCollaborationPrivacyBudgetTemplatesOutput

Returns an array that summarizes each privacy budget template in a specified 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_collaboration_privacy_budget_templates({
  collaboration_identifier: "CollaborationIdentifier", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.collaboration_privacy_budget_template_summaries #=> Array
resp.collaboration_privacy_budget_template_summaries[0].id #=> String
resp.collaboration_privacy_budget_template_summaries[0].arn #=> String
resp.collaboration_privacy_budget_template_summaries[0].collaboration_id #=> String
resp.collaboration_privacy_budget_template_summaries[0].collaboration_arn #=> String
resp.collaboration_privacy_budget_template_summaries[0]. #=> String
resp.collaboration_privacy_budget_template_summaries[0].privacy_budget_type #=> String, one of "DIFFERENTIAL_PRIVACY", "ACCESS_BUDGET"
resp.collaboration_privacy_budget_template_summaries[0].create_time #=> Time
resp.collaboration_privacy_budget_template_summaries[0].update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    A unique identifier for one of your collaborations.

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Returns:

See Also:



4487
4488
4489
4490
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4487

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

#list_collaboration_privacy_budgets(params = {}) ⇒ Types::ListCollaborationPrivacyBudgetsOutput

Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.

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_collaboration_privacy_budgets({
  collaboration_identifier: "CollaborationIdentifier", # required
  privacy_budget_type: "DIFFERENTIAL_PRIVACY", # required, accepts DIFFERENTIAL_PRIVACY, ACCESS_BUDGET
  max_results: 1,
  next_token: "PaginationToken",
  access_budget_resource_arn: "BudgetedResourceArn",
})

Response structure


resp.collaboration_privacy_budget_summaries #=> Array
resp.collaboration_privacy_budget_summaries[0].id #=> String
resp.collaboration_privacy_budget_summaries[0].privacy_budget_template_id #=> String
resp.collaboration_privacy_budget_summaries[0].privacy_budget_template_arn #=> String
resp.collaboration_privacy_budget_summaries[0].collaboration_id #=> String
resp.collaboration_privacy_budget_summaries[0].collaboration_arn #=> String
resp.collaboration_privacy_budget_summaries[0]. #=> String
resp.collaboration_privacy_budget_summaries[0].type #=> String, one of "DIFFERENTIAL_PRIVACY", "ACCESS_BUDGET"
resp.collaboration_privacy_budget_summaries[0].create_time #=> Time
resp.collaboration_privacy_budget_summaries[0].update_time #=> Time
resp.collaboration_privacy_budget_summaries[0].budget.differential_privacy.aggregations #=> Array
resp.collaboration_privacy_budget_summaries[0].budget.differential_privacy.aggregations[0].type #=> String, one of "AVG", "COUNT", "COUNT_DISTINCT", "SUM", "STDDEV"
resp.collaboration_privacy_budget_summaries[0].budget.differential_privacy.aggregations[0].max_count #=> Integer
resp.collaboration_privacy_budget_summaries[0].budget.differential_privacy.aggregations[0].remaining_count #=> Integer
resp.collaboration_privacy_budget_summaries[0].budget.differential_privacy.epsilon #=> Integer
resp.collaboration_privacy_budget_summaries[0].budget.access_budget.resource_arn #=> String
resp.collaboration_privacy_budget_summaries[0].budget.access_budget.details #=> Array
resp.collaboration_privacy_budget_summaries[0].budget.access_budget.details[0].start_time #=> Time
resp.collaboration_privacy_budget_summaries[0].budget.access_budget.details[0].end_time #=> Time
resp.collaboration_privacy_budget_summaries[0].budget.access_budget.details[0].remaining_budget #=> Integer
resp.collaboration_privacy_budget_summaries[0].budget.access_budget.details[0].budget #=> Integer
resp.collaboration_privacy_budget_summaries[0].budget.access_budget.details[0].budget_type #=> String, one of "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_WEEK", "LIFETIME"
resp.collaboration_privacy_budget_summaries[0].budget.access_budget.details[0].auto_refresh #=> String, one of "ENABLED", "DISABLED"
resp.collaboration_privacy_budget_summaries[0].budget.access_budget.aggregate_remaining_budget #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    A unique identifier for one of your collaborations.

  • :privacy_budget_type (required, String) —

    Specifies the type of the privacy budget.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :access_budget_resource_arn (String) —

    The Amazon Resource Name (ARN) of the Configured Table Association (ConfiguredTableAssociation) used to filter privacy budgets.

Returns:

See Also:



4564
4565
4566
4567
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4564

def list_collaboration_privacy_budgets(params = {}, options = {})
  req = build_request(:list_collaboration_privacy_budgets, 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
resp.collaboration_list[0].analytics_engine #=> String, one of "SPARK", "CLEAN_ROOMS_SQL"

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

  • :member_status (String) —

    The caller's status in a collaboration.

Returns:

See Also:



4619
4620
4621
4622
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4619

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

#list_configured_audience_model_associations(params = {}) ⇒ Types::ListConfiguredAudienceModelAssociationsOutput

Lists information about requested configured audience model associations.

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

Response structure


resp.configured_audience_model_association_summaries #=> Array
resp.configured_audience_model_association_summaries[0].membership_id #=> String
resp.configured_audience_model_association_summaries[0].membership_arn #=> String
resp.configured_audience_model_association_summaries[0].collaboration_arn #=> String
resp.configured_audience_model_association_summaries[0].collaboration_id #=> String
resp.configured_audience_model_association_summaries[0].create_time #=> Time
resp.configured_audience_model_association_summaries[0].update_time #=> Time
resp.configured_audience_model_association_summaries[0].id #=> String
resp.configured_audience_model_association_summaries[0].arn #=> String
resp.configured_audience_model_association_summaries[0].name #=> String
resp.configured_audience_model_association_summaries[0].configured_audience_model_arn #=> String
resp.configured_audience_model_association_summaries[0].description #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    A unique identifier for a membership that contains the configured audience model associations that you want to retrieve.

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Returns:

See Also:



4675
4676
4677
4678
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4675

def list_configured_audience_model_associations(params = {}, options = {})
  req = build_request(:list_configured_audience_model_associations, 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.configured_table_association_summaries[0].analysis_rule_types #=> Array
resp.configured_table_association_summaries[0].analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
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 pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Returns:

See Also:



4729
4730
4731
4732
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4729

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", "CUSTOM"
resp.configured_table_summaries[0].analysis_method #=> String, one of "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE"
resp.configured_table_summaries[0].selected_analysis_methods #=> Array
resp.configured_table_summaries[0].selected_analysis_methods[0] #=> String, one of "DIRECT_QUERY", "DIRECT_JOB"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Returns:

See Also:



4778
4779
4780
4781
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4778

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

#list_id_mapping_tables(params = {}) ⇒ Types::ListIdMappingTablesOutput

Returns a list of ID mapping 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_id_mapping_tables({
  membership_identifier: "MembershipIdentifier", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.id_mapping_table_summaries #=> Array
resp.id_mapping_table_summaries[0].collaboration_arn #=> String
resp.id_mapping_table_summaries[0].collaboration_id #=> String
resp.id_mapping_table_summaries[0].membership_id #=> String
resp.id_mapping_table_summaries[0].membership_arn #=> String
resp.id_mapping_table_summaries[0].create_time #=> Time
resp.id_mapping_table_summaries[0].update_time #=> Time
resp.id_mapping_table_summaries[0].id #=> String
resp.id_mapping_table_summaries[0].arn #=> String
resp.id_mapping_table_summaries[0].description #=> String
resp.id_mapping_table_summaries[0].input_reference_config.input_reference_arn #=> String
resp.id_mapping_table_summaries[0].input_reference_config.manage_resource_policies #=> Boolean
resp.id_mapping_table_summaries[0].name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the ID mapping tables that you want to view.

  • :next_token (String) —

    The pagination token that's used to fetch the next set 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.

Returns:

See Also:



4833
4834
4835
4836
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4833

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

#list_id_namespace_associations(params = {}) ⇒ Types::ListIdNamespaceAssociationsOutput

Returns a list of ID namespace associations.

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

Response structure


resp.next_token #=> String
resp.id_namespace_association_summaries #=> Array
resp.id_namespace_association_summaries[0].membership_id #=> String
resp.id_namespace_association_summaries[0].membership_arn #=> String
resp.id_namespace_association_summaries[0].collaboration_arn #=> String
resp.id_namespace_association_summaries[0].collaboration_id #=> String
resp.id_namespace_association_summaries[0].create_time #=> Time
resp.id_namespace_association_summaries[0].update_time #=> Time
resp.id_namespace_association_summaries[0].id #=> String
resp.id_namespace_association_summaries[0].arn #=> String
resp.id_namespace_association_summaries[0].input_reference_config.input_reference_arn #=> String
resp.id_namespace_association_summaries[0].input_reference_config.manage_resource_policies #=> Boolean
resp.id_namespace_association_summaries[0].name #=> String
resp.id_namespace_association_summaries[0].description #=> String
resp.id_namespace_association_summaries[0].input_reference_properties.id_namespace_type #=> String, one of "SOURCE", "TARGET"

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the ID namespace association that you want to view.

  • :next_token (String) —

    The pagination token that's used to fetch the next set 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.

Returns:

See Also:



4889
4890
4891
4892
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4889

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

#list_intermediate_table_versions(params = {}) ⇒ Types::ListIntermediateTableVersionsOutput

Lists the version history of an intermediate table. Each call to PopulateIntermediateTable creates a new version. We recommend using pagination to ensure that the operation returns quickly and successfully.

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

Response structure


resp.intermediate_table_version_summaries #=> Array
resp.intermediate_table_version_summaries[0].version_id #=> String
resp.intermediate_table_version_summaries[0].table_id #=> String
resp.intermediate_table_version_summaries[0].create_time #=> Time
resp.intermediate_table_version_summaries[0].analysis_id #=> String
resp.intermediate_table_version_summaries[0].status #=> String, one of "POPULATE_STARTED", "POPULATE_SUCCESS", "POPULATE_FAILED", "RETENTION_PERIOD_EXPIRED"
resp.intermediate_table_version_summaries[0].analysis_type #=> String, one of "QUERY"
resp.intermediate_table_version_summaries[0].kms_key_arn #=> String
resp.intermediate_table_version_summaries[0].expiration_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the intermediate table.

  • :intermediate_table_identifier (required, String) —

    The unique identifier of the intermediate table for which to list versions.

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Returns:

See Also:



4949
4950
4951
4952
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 4949

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

#list_intermediate_tables(params = {}) ⇒ Types::ListIntermediateTablesOutput

Lists intermediate tables owned by the caller in a membership. We recommend using pagination to ensure that the operation returns quickly and successfully.

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

Response structure


resp.intermediate_table_summaries #=> Array
resp.intermediate_table_summaries[0].id #=> String
resp.intermediate_table_summaries[0].arn #=> String
resp.intermediate_table_summaries[0].name #=> String
resp.intermediate_table_summaries[0].description #=> String
resp.intermediate_table_summaries[0].membership_arn #=> String
resp.intermediate_table_summaries[0].membership_id #=> String
resp.intermediate_table_summaries[0].collaboration_arn #=> String
resp.intermediate_table_summaries[0].collaboration_id #=> String
resp.intermediate_table_summaries[0].create_time #=> Time
resp.intermediate_table_summaries[0].update_time #=> Time
resp.intermediate_table_summaries[0].status #=> String, one of "CREATED", "POPULATE_STARTED", "POPULATE_SUCCESS", "POPULATE_FAILED", "DISALLOWED_BY_DATA_PROVIDER", "BASE_TABLE_REMOVED", "RETENTION_PERIOD_EXPIRED"
resp.intermediate_table_summaries[0].retention_in_days #=> Integer
resp.intermediate_table_summaries[0].analysis_rule_types #=> Array
resp.intermediate_table_summaries[0].analysis_rule_types[0] #=> String, one of "CUSTOM"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The unique identifier of the membership for which to list intermediate tables.

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Returns:

See Also:



5009
5010
5011
5012
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5009

def list_intermediate_tables(params = {}, options = {})
  req = build_request(:list_intermediate_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", "CAN_RUN_JOB"
resp.member_summaries[0].ml_abilities.custom_ml_member_abilities #=> Array
resp.member_summaries[0].ml_abilities.custom_ml_member_abilities[0] #=> String, one of "CAN_RECEIVE_MODEL_OUTPUT", "CAN_RECEIVE_INFERENCE_OUTPUT"
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
resp.member_summaries[0].payment_configuration.query_compute.is_responsible #=> Boolean
resp.member_summaries[0].payment_configuration.machine_learning.model_training.is_responsible #=> Boolean
resp.member_summaries[0].payment_configuration.machine_learning.model_inference.is_responsible #=> Boolean
resp.member_summaries[0].payment_configuration.machine_learning.synthetic_data_generation.is_responsible #=> Boolean
resp.member_summaries[0].payment_configuration.job_compute.is_responsible #=> Boolean

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 pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Returns:

See Also:



5068
5069
5070
5071
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5068

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", "CAN_RUN_JOB"
resp.membership_summaries[0].ml_member_abilities.custom_ml_member_abilities #=> Array
resp.membership_summaries[0].ml_member_abilities.custom_ml_member_abilities[0] #=> String, one of "CAN_RECEIVE_MODEL_OUTPUT", "CAN_RECEIVE_INFERENCE_OUTPUT"
resp.membership_summaries[0].payment_configuration.query_compute.is_responsible #=> Boolean
resp.membership_summaries[0].payment_configuration.machine_learning.model_training.is_responsible #=> Boolean
resp.membership_summaries[0].payment_configuration.machine_learning.model_inference.is_responsible #=> Boolean
resp.membership_summaries[0].payment_configuration.machine_learning.synthetic_data_generation.is_responsible #=> Boolean
resp.membership_summaries[0].payment_configuration.job_compute.is_responsible #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

  • :status (String) —

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

Returns:

See Also:



5130
5131
5132
5133
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5130

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

#list_privacy_budget_templates(params = {}) ⇒ Types::ListPrivacyBudgetTemplatesOutput

Returns detailed information about the privacy budget templates in a specified 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_privacy_budget_templates({
  membership_identifier: "MembershipIdentifier", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.privacy_budget_template_summaries #=> Array
resp.privacy_budget_template_summaries[0].id #=> String
resp.privacy_budget_template_summaries[0].arn #=> String
resp.privacy_budget_template_summaries[0].membership_id #=> String
resp.privacy_budget_template_summaries[0].membership_arn #=> String
resp.privacy_budget_template_summaries[0].collaboration_id #=> String
resp.privacy_budget_template_summaries[0].collaboration_arn #=> String
resp.privacy_budget_template_summaries[0].privacy_budget_type #=> String, one of "DIFFERENTIAL_PRIVACY", "ACCESS_BUDGET"
resp.privacy_budget_template_summaries[0].create_time #=> Time
resp.privacy_budget_template_summaries[0].update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    A unique identifier for one of your memberships for a collaboration. The privacy budget templates are retrieved from the collaboration that this membership belongs to. Accepts a membership ID.

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Returns:

See Also:



5185
5186
5187
5188
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5185

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

#list_privacy_budgets(params = {}) ⇒ Types::ListPrivacyBudgetsOutput

Returns detailed information about the privacy budgets in a specified 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_privacy_budgets({
  membership_identifier: "MembershipIdentifier", # required
  privacy_budget_type: "DIFFERENTIAL_PRIVACY", # required, accepts DIFFERENTIAL_PRIVACY, ACCESS_BUDGET
  next_token: "PaginationToken",
  max_results: 1,
  access_budget_resource_arn: "BudgetedResourceArn",
})

Response structure


resp.privacy_budget_summaries #=> Array
resp.privacy_budget_summaries[0].id #=> String
resp.privacy_budget_summaries[0].privacy_budget_template_id #=> String
resp.privacy_budget_summaries[0].privacy_budget_template_arn #=> String
resp.privacy_budget_summaries[0].membership_id #=> String
resp.privacy_budget_summaries[0].membership_arn #=> String
resp.privacy_budget_summaries[0].collaboration_id #=> String
resp.privacy_budget_summaries[0].collaboration_arn #=> String
resp.privacy_budget_summaries[0].type #=> String, one of "DIFFERENTIAL_PRIVACY", "ACCESS_BUDGET"
resp.privacy_budget_summaries[0].create_time #=> Time
resp.privacy_budget_summaries[0].update_time #=> Time
resp.privacy_budget_summaries[0].budget.differential_privacy.aggregations #=> Array
resp.privacy_budget_summaries[0].budget.differential_privacy.aggregations[0].type #=> String, one of "AVG", "COUNT", "COUNT_DISTINCT", "SUM", "STDDEV"
resp.privacy_budget_summaries[0].budget.differential_privacy.aggregations[0].max_count #=> Integer
resp.privacy_budget_summaries[0].budget.differential_privacy.aggregations[0].remaining_count #=> Integer
resp.privacy_budget_summaries[0].budget.differential_privacy.epsilon #=> Integer
resp.privacy_budget_summaries[0].budget.access_budget.resource_arn #=> String
resp.privacy_budget_summaries[0].budget.access_budget.details #=> Array
resp.privacy_budget_summaries[0].budget.access_budget.details[0].start_time #=> Time
resp.privacy_budget_summaries[0].budget.access_budget.details[0].end_time #=> Time
resp.privacy_budget_summaries[0].budget.access_budget.details[0].remaining_budget #=> Integer
resp.privacy_budget_summaries[0].budget.access_budget.details[0].budget #=> Integer
resp.privacy_budget_summaries[0].budget.access_budget.details[0].budget_type #=> String, one of "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_WEEK", "LIFETIME"
resp.privacy_budget_summaries[0].budget.access_budget.details[0].auto_refresh #=> String, one of "ENABLED", "DISABLED"
resp.privacy_budget_summaries[0].budget.access_budget.aggregate_remaining_budget #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    A unique identifier for one of your memberships for a collaboration. The privacy budget is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.

  • :privacy_budget_type (required, String) —

    The privacy budget type.

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

  • :access_budget_resource_arn (String) —

    The Amazon Resource Name (ARN) of the access budget resource to filter privacy budgets by.

Returns:

See Also:



5264
5265
5266
5267
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5264

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

#list_protected_jobs(params = {}) ⇒ Types::ListProtectedJobsOutput

Lists protected jobs, sorted by most recent job.

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

Response structure


resp.next_token #=> String
resp.protected_jobs #=> Array
resp.protected_jobs[0].id #=> String
resp.protected_jobs[0].membership_id #=> String
resp.protected_jobs[0].membership_arn #=> String
resp.protected_jobs[0].create_time #=> Time
resp.protected_jobs[0].status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS"
resp.protected_jobs[0].receiver_configurations #=> Array
resp.protected_jobs[0].receiver_configurations[0].analysis_type #=> String, one of "DIRECT_ANALYSIS"
resp.protected_jobs[0].receiver_configurations[0].configuration_details.direct_analysis_configuration_details. #=> Array
resp.protected_jobs[0].receiver_configurations[0].configuration_details.direct_analysis_configuration_details.[0] #=> String
resp.protected_jobs[0]. #=> String

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

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Returns:

See Also:



5321
5322
5323
5324
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5321

def list_protected_jobs(params = {}, options = {})
  req = build_request(:list_protected_jobs, 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"
resp.protected_queries[0].receiver_configurations #=> Array
resp.protected_queries[0].receiver_configurations[0].analysis_type #=> String, one of "DIRECT_ANALYSIS", "ADDITIONAL_ANALYSIS"
resp.protected_queries[0].receiver_configurations[0].configuration_details.direct_analysis_configuration_details. #=> Array
resp.protected_queries[0].receiver_configurations[0].configuration_details.direct_analysis_configuration_details.[0] #=> String
resp.protected_queries[0]. #=> String
resp.protected_queries[0].intermediate_table_configuration.id #=> String
resp.protected_queries[0].intermediate_table_configuration.arn #=> String
resp.protected_queries[0].intermediate_table_configuration.name #=> String

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 pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Returns:

See Also:



5381
5382
5383
5384
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5381

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, ID_MAPPING_TABLE, INTERMEDIATE_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", "ID_MAPPING_TABLE", "INTERMEDIATE_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", "CUSTOM", "ID_MAPPING_TABLE"
resp.schema_summaries[0].analysis_method #=> String, one of "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE"
resp.schema_summaries[0].resource_arn #=> String
resp.schema_summaries[0].selected_analysis_methods #=> Array
resp.schema_summaries[0].selected_analysis_methods[0] #=> String, one of "DIRECT_QUERY", "DIRECT_JOB"
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.

  • :next_token (String) —

    The pagination token that's used to fetch the next set of results.

  • :max_results (Integer) —

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Returns:

See Also:



5442
5443
5444
5445
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5442

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:



5472
5473
5474
5475
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5472

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

#populate_id_mapping_table(params = {}) ⇒ Types::PopulateIdMappingTableOutput

Defines the information that's necessary to populate an ID mapping table.

Examples:

Request syntax with placeholder values


resp = client.populate_id_mapping_table({
  id_mapping_table_identifier: "UUID", # required
  membership_identifier: "MembershipIdentifier", # required
  job_type: "BATCH", # accepts BATCH, INCREMENTAL, DELETE_ONLY
})

Response structure


resp.id_mapping_job_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id_mapping_table_identifier (required, String) —

    The unique identifier of the ID mapping table that you want to populate.

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the ID mapping table that you want to populate.

  • :job_type (String) —

    The job type of the rule-based ID mapping job. Valid values include:

    INCREMENTAL: Processes only new or changed data since the last job run. This is the default job type if the ID mapping workflow was created in Entity Resolution with incrementalRunConfig specified.

    BATCH: Processes all data from the input source, regardless of previous job runs. This is the default job type if the ID mapping workflow was created in Entity Resolution but incrementalRunConfig wasn't specified.

    DELETE_ONLY: Processes only deletion requests from BatchDeleteUniqueId, which is set in Entity Resolution.

    For more information about incrementalRunConfig and BatchDeleteUniqueId, see the Entity Resolution API Reference.

Returns:

See Also:



5530
5531
5532
5533
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5530

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

#populate_intermediate_table(params = {}) ⇒ Types::PopulateIntermediateTableOutput

Executes the stored query of an intermediate table to materialize data into managed storage. With this operation, you can perform initial population and subsequent refreshes. Each call creates a new version. The returned analysis ID can be tracked using GetProtectedQuery. Only the intermediate table owner can call this operation.

Examples:

Request syntax with placeholder values


resp = client.populate_intermediate_table({
  intermediate_table_identifier: "IntermediateTableIdentifier", # required
  membership_identifier: "MembershipIdentifier", # required
  parameters: {
    "ParameterName" => "ParameterValue",
  },
  compute_configuration: {
    query_compute_configuration: {
      type: "CR.1X", # accepts CR.1X, CR.4X
      number: 1,
      properties: {
        spark: {
          "SparkPropertyKey" => "SparkPropertyValue",
        },
      },
    },
  },
  analysis_payer_account_id: "AccountId",
})

Response structure


resp.analysis_id #=> String
resp.analysis_type #=> String, one of "QUERY"
resp.version_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :intermediate_table_identifier (required, String) —

    The unique identifier of the intermediate table to populate.

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the intermediate table.

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

    The runtime parameter values that override the defaults in the stored query.

  • :compute_configuration (Types::IntermediateTableComputeConfiguration) —

    The compute configuration for the population query execution.

  • :analysis_payer_account_id (String) —

    The account ID of the member that pays for the analysis compute costs.

Returns:

See Also:



5596
5597
5598
5599
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5596

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

#preview_privacy_impact(params = {}) ⇒ Types::PreviewPrivacyImpactOutput

An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.

Examples:

Request syntax with placeholder values


resp = client.preview_privacy_impact({
  membership_identifier: "MembershipIdentifier", # required
  parameters: { # required
    differential_privacy: {
      epsilon: 1, # required
      users_noise_per_query: 1, # required
    },
  },
})

Response structure


resp.privacy_impact.differential_privacy.aggregations #=> Array
resp.privacy_impact.differential_privacy.aggregations[0].type #=> String, one of "AVG", "COUNT", "COUNT_DISTINCT", "SUM", "STDDEV"
resp.privacy_impact.differential_privacy.aggregations[0].max_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    A unique identifier for one of your memberships for a collaboration. Accepts a membership ID.

  • :parameters (required, Types::PreviewPrivacyImpactParametersInput) —

    Specifies the desired epsilon and noise parameters to preview.

Returns:

See Also:



5637
5638
5639
5640
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5637

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

#start_protected_job(params = {}) ⇒ Types::StartProtectedJobOutput

Creates a protected job that is started by Clean Rooms.

Examples:

Request syntax with placeholder values


resp = client.start_protected_job({
  type: "PYSPARK", # required, accepts PYSPARK
  membership_identifier: "MembershipIdentifier", # required
  job_parameters: { # required
    analysis_template_arn: "AnalysisTemplateArn", # required
    parameters: {
      "JobParameterName" => "JobParameterValue",
    },
  },
  result_configuration: {
    output_configuration: { # required
      member: {
        account_id: "AccountId", # required
      },
    },
  },
  compute_configuration: {
    worker: {
      type: "CR.1X", # required, accepts CR.1X, CR.4X
      number: 1, # required
      properties: {
        spark: {
          "SparkPropertyKey" => "SparkPropertyValue",
        },
      },
    },
  },
  job_compute_payer_account_id: "AccountId",
})

Response structure


resp.protected_job.id #=> String
resp.protected_job.membership_id #=> String
resp.protected_job.membership_arn #=> String
resp.protected_job.create_time #=> Time
resp.protected_job.job_parameters.analysis_template_arn #=> String
resp.protected_job.job_parameters.parameters #=> Hash
resp.protected_job.job_parameters.parameters["JobParameterName"] #=> String
resp.protected_job.status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS"
resp.protected_job.result_configuration.output_configuration.s3.bucket #=> String
resp.protected_job.result_configuration.output_configuration.s3.key_prefix #=> String
resp.protected_job.result_configuration.output_configuration.member. #=> String
resp.protected_job.statistics.total_duration_in_millis #=> Integer
resp.protected_job.statistics.billed_resource_utilization.units #=> Float
resp.protected_job.result.output.s3.location #=> String
resp.protected_job.result.output.member_list #=> Array
resp.protected_job.result.output.member_list[0]. #=> String
resp.protected_job.error.message #=> String
resp.protected_job.error.code #=> String
resp.protected_job.compute_configuration.worker.type #=> String, one of "CR.1X", "CR.4X"
resp.protected_job.compute_configuration.worker.number #=> Integer
resp.protected_job.compute_configuration.worker.properties.spark #=> Hash
resp.protected_job.compute_configuration.worker.properties.spark["SparkPropertyKey"] #=> String
resp.protected_job. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :type (required, String) —

    The type of protected job to start.

  • :membership_identifier (required, String) —

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

  • :job_parameters (required, Types::ProtectedJobParameters) —

    The job parameters.

  • :result_configuration (Types::ProtectedJobResultConfigurationInput) —

    The details needed to write the job results.

  • :compute_configuration (Types::ProtectedJobComputeConfiguration) —

    The compute configuration for the protected job.

  • :job_compute_payer_account_id (String) —

    The account ID of the member that pays for the job compute costs.

Returns:

See Also:



5729
5730
5731
5732
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5729

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

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

Creates a protected query that is started by 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",
    analysis_template_arn: "AnalysisTemplateArn",
    parameters: {
      "ParameterName" => "ParameterValue",
    },
  },
  result_configuration: {
    output_configuration: { # required
      s3: {
        result_format: "CSV", # required, accepts CSV, PARQUET
        bucket: "ProtectedQueryS3OutputConfigurationBucketString", # required
        key_prefix: "KeyPrefix",
        single_file_output: false,
      },
      member: {
        account_id: "AccountId", # required
      },
      distribute: {
        locations: [ # required
          {
            s3: {
              result_format: "CSV", # required, accepts CSV, PARQUET
              bucket: "ProtectedQueryS3OutputConfigurationBucketString", # required
              key_prefix: "KeyPrefix",
              single_file_output: false,
            },
            member: {
              account_id: "AccountId", # required
            },
          },
        ],
      },
      intermediate_table: {
        id: "UUID", # required
        arn: "IntermediateTableArn", # required
        name: "DisplayName", # required
      },
    },
  },
  compute_configuration: {
    worker: {
      type: "CR.1X", # accepts CR.1X, CR.4X
      number: 1,
      properties: {
        spark: {
          "SparkPropertyKey" => "SparkPropertyValue",
        },
      },
    },
  },
  query_compute_payer_account_id: "AccountId",
})

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.sql_parameters.analysis_template_arn #=> String
resp.protected_query.sql_parameters.parameters #=> Hash
resp.protected_query.sql_parameters.parameters["ParameterName"] #=> 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.result_configuration.output_configuration.s3.single_file_output #=> Boolean
resp.protected_query.result_configuration.output_configuration.member. #=> String
resp.protected_query.result_configuration.output_configuration.distribute.locations #=> Array
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].s3.result_format #=> String, one of "CSV", "PARQUET"
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].s3.bucket #=> String
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].s3.key_prefix #=> String
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].s3.single_file_output #=> Boolean
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].member. #=> String
resp.protected_query.result_configuration.output_configuration.intermediate_table.id #=> String
resp.protected_query.result_configuration.output_configuration.intermediate_table.arn #=> String
resp.protected_query.result_configuration.output_configuration.intermediate_table.name #=> String
resp.protected_query.statistics.total_duration_in_millis #=> Integer
resp.protected_query.statistics.billed_resource_utilization.units #=> Float
resp.protected_query.result.output.s3.location #=> String
resp.protected_query.result.output.member_list #=> Array
resp.protected_query.result.output.member_list[0]. #=> String
resp.protected_query.result.output.distribute.s3.location #=> String
resp.protected_query.result.output.distribute.member_list #=> Array
resp.protected_query.result.output.distribute.member_list[0]. #=> String
resp.protected_query.error.message #=> String
resp.protected_query.error.code #=> String
resp.protected_query.differential_privacy.sensitivity_parameters #=> Array
resp.protected_query.differential_privacy.sensitivity_parameters[0].aggregation_type #=> String, one of "AVG", "COUNT", "COUNT_DISTINCT", "SUM", "STDDEV"
resp.protected_query.differential_privacy.sensitivity_parameters[0].aggregation_expression #=> String
resp.protected_query.differential_privacy.sensitivity_parameters[0].user_contribution_limit #=> Integer
resp.protected_query.differential_privacy.sensitivity_parameters[0].min_column_value #=> Float
resp.protected_query.differential_privacy.sensitivity_parameters[0].max_column_value #=> Float
resp.protected_query.compute_configuration.worker.type #=> String, one of "CR.1X", "CR.4X"
resp.protected_query.compute_configuration.worker.number #=> Integer
resp.protected_query.compute_configuration.worker.properties.spark #=> Hash
resp.protected_query.compute_configuration.worker.properties.spark["SparkPropertyKey"] #=> String
resp.protected_query. #=> 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 (Types::ProtectedQueryResultConfiguration) —

    The details needed to write the query results.

  • :compute_configuration (Types::ComputeConfiguration) —

    The compute configuration for the protected query.

  • :query_compute_payer_account_id (String) —

    The account ID of the member that pays for the query compute costs.

Returns:

See Also:



5869
5870
5871
5872
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5869

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:



5898
5899
5900
5901
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5898

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:



5925
5926
5927
5928
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5925

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

#update_analysis_template(params = {}) ⇒ Types::UpdateAnalysisTemplateOutput

Updates the analysis template metadata.

Examples:

Request syntax with placeholder values


resp = client.update_analysis_template({
  membership_identifier: "MembershipIdentifier", # required
  analysis_template_identifier: "AnalysisTemplateIdentifier", # required
  description: "ResourceDescription",
})

Response structure


resp.analysis_template.id #=> String
resp.analysis_template.arn #=> String
resp.analysis_template.collaboration_id #=> String
resp.analysis_template.collaboration_arn #=> String
resp.analysis_template.membership_id #=> String
resp.analysis_template.membership_arn #=> String
resp.analysis_template.description #=> String
resp.analysis_template.name #=> String
resp.analysis_template.create_time #=> Time
resp.analysis_template.update_time #=> Time
resp.analysis_template.schema.referenced_tables #=> Array
resp.analysis_template.schema.referenced_tables[0] #=> String
resp.analysis_template.format #=> String, one of "SQL", "PYSPARK_1_0"
resp.analysis_template.source.text #=> String
resp.analysis_template.source.artifacts.entry_point.location.bucket #=> String
resp.analysis_template.source.artifacts.entry_point.location.key #=> String
resp.analysis_template.source.artifacts.additional_artifacts #=> Array
resp.analysis_template.source.artifacts.additional_artifacts[0].location.bucket #=> String
resp.analysis_template.source.artifacts.additional_artifacts[0].location.key #=> String
resp.analysis_template.source.artifacts.role_arn #=> String
resp.analysis_template.source_metadata.artifacts.entry_point_hash.sha256 #=> String
resp.analysis_template.source_metadata.artifacts.additional_artifact_hashes #=> Array
resp.analysis_template.source_metadata.artifacts.additional_artifact_hashes[0].sha256 #=> String
resp.analysis_template.analysis_parameters #=> Array
resp.analysis_template.analysis_parameters[0].name #=> String
resp.analysis_template.analysis_parameters[0].type #=> String, one of "SMALLINT", "INTEGER", "BIGINT", "DECIMAL", "REAL", "DOUBLE_PRECISION", "BOOLEAN", "CHAR", "VARCHAR", "DATE", "TIMESTAMP", "TIMESTAMPTZ", "TIME", "TIMETZ", "VARBYTE", "BINARY", "BYTE", "CHARACTER", "DOUBLE", "FLOAT", "INT", "LONG", "NUMERIC", "SHORT", "STRING", "TIMESTAMP_LTZ", "TIMESTAMP_NTZ", "TINYINT"
resp.analysis_template.analysis_parameters[0].default_value #=> String
resp.analysis_template.validations #=> Array
resp.analysis_template.validations[0].type #=> String, one of "DIFFERENTIAL_PRIVACY"
resp.analysis_template.validations[0].status #=> String, one of "VALID", "INVALID", "UNABLE_TO_VALIDATE"
resp.analysis_template.validations[0].reasons #=> Array
resp.analysis_template.validations[0].reasons[0].message #=> String
resp.analysis_template.error_message_configuration.type #=> String, one of "DETAILED"
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.epsilon #=> Float
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.max_membership_inference_attack_score #=> Float
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping #=> Array
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].column_name #=> String
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].column_type #=> String, one of "CATEGORICAL", "NUMERICAL"
resp.analysis_template.synthetic_data_parameters.ml_synthetic_data_parameters.column_classification.column_mapping[0].is_predictive_value #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The identifier for a membership resource.

  • :analysis_template_identifier (required, String) —

    The identifier for the analysis template resource.

  • :description (String) —

    A new description for the analysis template.

Returns:

See Also:



5999
6000
6001
6002
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 5999

def update_analysis_template(params = {}, options = {})
  req = build_request(:update_analysis_template, 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",
  analytics_engine: "SPARK", # accepts SPARK, CLEAN_ROOMS_SQL
})

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"
resp.collaboration.job_log_status #=> String, one of "ENABLED", "DISABLED"
resp.collaboration.analytics_engine #=> String, one of "SPARK", "CLEAN_ROOMS_SQL"
resp.collaboration.auto_approved_change_types #=> Array
resp.collaboration.auto_approved_change_types[0] #=> String, one of "ADD_MEMBER", "GRANT_RECEIVE_RESULTS_ABILITY", "REVOKE_RECEIVE_RESULTS_ABILITY"
resp.collaboration.allowed_result_regions #=> Array
resp.collaboration.allowed_result_regions[0] #=> String, one of "us-west-1", "us-west-2", "us-east-1", "us-east-2", "af-south-1", "ap-east-1", "ap-east-2", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-5", "ap-southeast-4", "ap-southeast-7", "ap-south-1", "ap-northeast-3", "ap-northeast-1", "ap-northeast-2", "ca-central-1", "ca-west-1", "eu-south-1", "eu-west-3", "eu-south-2", "eu-central-2", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "me-south-1", "me-central-1", "il-central-1", "sa-east-1", "mx-central-1"
resp.collaboration.is_metrics_enabled #=> Boolean

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.

  • :analytics_engine (String) —

    The analytics engine.

    After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

Returns:

See Also:



6068
6069
6070
6071
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 6068

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

#update_collaboration_change_request(params = {}) ⇒ Types::UpdateCollaborationChangeRequestOutput

Updates an existing collaboration change request. This operation allows approval actions for pending change requests in collaborations (APPROVE, DENY, CANCEL, COMMIT).

For change requests without automatic approval, a member in the collaboration can manually APPROVE or DENY a change request. The collaboration owner can manually CANCEL or COMMIT a change request.

Examples:

Request syntax with placeholder values


resp = client.update_collaboration_change_request({
  collaboration_identifier: "CollaborationIdentifier", # required
  change_request_identifier: "CollaborationChangeRequestIdentifier", # required
  action: "APPROVE", # required, accepts APPROVE, DENY, CANCEL, COMMIT
})

Response structure


resp.collaboration_change_request.id #=> String
resp.collaboration_change_request.collaboration_id #=> String
resp.collaboration_change_request.create_time #=> Time
resp.collaboration_change_request.update_time #=> Time
resp.collaboration_change_request.status #=> String, one of "PENDING", "APPROVED", "CANCELLED", "DENIED", "COMMITTED"
resp.collaboration_change_request.is_auto_approved #=> Boolean
resp.collaboration_change_request.changes #=> Array
resp.collaboration_change_request.changes[0].specification_type #=> String, one of "MEMBER", "COLLABORATION"
resp.collaboration_change_request.changes[0].specification.member. #=> String
resp.collaboration_change_request.changes[0].specification.member.member_abilities #=> Array
resp.collaboration_change_request.changes[0].specification.member.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS", "CAN_RUN_JOB"
resp.collaboration_change_request.changes[0].specification.member.ml_member_abilities.custom_ml_member_abilities #=> Array
resp.collaboration_change_request.changes[0].specification.member.ml_member_abilities.custom_ml_member_abilities[0] #=> String, one of "CAN_RECEIVE_MODEL_OUTPUT", "CAN_RECEIVE_INFERENCE_OUTPUT"
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.query_compute.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.machine_learning.model_training.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.machine_learning.model_inference.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.machine_learning.synthetic_data_generation.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.payment_configuration.job_compute.is_responsible #=> Boolean
resp.collaboration_change_request.changes[0].specification.member.display_name #=> String
resp.collaboration_change_request.changes[0].specification.collaboration.auto_approved_change_types #=> Array
resp.collaboration_change_request.changes[0].specification.collaboration.auto_approved_change_types[0] #=> String, one of "ADD_MEMBER", "GRANT_RECEIVE_RESULTS_ABILITY", "REVOKE_RECEIVE_RESULTS_ABILITY"
resp.collaboration_change_request.changes[0].types #=> Array
resp.collaboration_change_request.changes[0].types[0] #=> String, one of "ADD_MEMBER", "GRANT_RECEIVE_RESULTS_ABILITY", "REVOKE_RECEIVE_RESULTS_ABILITY", "EDIT_AUTO_APPROVED_CHANGE_TYPES", "ADD_PAYER_CANDIDATE", "REMOVE_PAYER_CANDIDATE", "GRANT_CAN_RECEIVE_MODEL_OUTPUT", "GRANT_CAN_RECEIVE_INFERENCE_OUTPUT", "REVOKE_CAN_RECEIVE_MODEL_OUTPUT", "REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT"
resp.collaboration_change_request.approvals #=> Hash
resp.collaboration_change_request.approvals["AccountId"].status #=> String, one of "APPROVED", "DENIED", "PENDING"

Parameters:

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

    ({})

Options Hash (params):

  • :collaboration_identifier (required, String) —

    The unique identifier of the collaboration that contains the change request to be updated.

  • :change_request_identifier (required, String) —

    The unique identifier of the specific change request to be updated within the collaboration.

  • :action (required, String) —

    The action to perform on the change request. Valid values include APPROVE (approve the change), DENY (reject the change), CANCEL (cancel the request), and COMMIT (commit after the request is approved).

    For change requests without automatic approval, a member in the collaboration can manually APPROVE or DENY a change request. The collaboration owner can manually CANCEL or COMMIT a change request.

Returns:

See Also:



6142
6143
6144
6145
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 6142

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

#update_configured_audience_model_association(params = {}) ⇒ Types::UpdateConfiguredAudienceModelAssociationOutput

Provides the details necessary to update a configured audience model association.

Examples:

Request syntax with placeholder values


resp = client.update_configured_audience_model_association({
  configured_audience_model_association_identifier: "ConfiguredAudienceModelAssociationIdentifier", # required
  membership_identifier: "MembershipIdentifier", # required
  description: "ResourceDescription",
  name: "ConfiguredAudienceModelAssociationName",
})

Response structure


resp.configured_audience_model_association.id #=> String
resp.configured_audience_model_association.arn #=> String
resp.configured_audience_model_association.configured_audience_model_arn #=> String
resp.configured_audience_model_association.membership_id #=> String
resp.configured_audience_model_association.membership_arn #=> String
resp.configured_audience_model_association.collaboration_id #=> String
resp.configured_audience_model_association.collaboration_arn #=> String
resp.configured_audience_model_association.name #=> String
resp.configured_audience_model_association.manage_resource_policies #=> Boolean
resp.configured_audience_model_association.description #=> String
resp.configured_audience_model_association.create_time #=> Time
resp.configured_audience_model_association.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :configured_audience_model_association_identifier (required, String) —

    A unique identifier for the configured audience model association that you want to update.

  • :membership_identifier (required, String) —

    A unique identifier of the membership that contains the configured audience model association that you want to update.

  • :description (String) —

    A new description for the configured audience model association.

  • :name (String) —

    A new name for the configured audience model association.

Returns:

See Also:



6196
6197
6198
6199
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 6196

def update_configured_audience_model_association(params = {}, options = {})
  req = build_request(:update_configured_audience_model_association, 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",
  table_reference: {
    glue: {
      region: "us-west-1", # accepts us-west-1, us-west-2, us-east-1, us-east-2, af-south-1, ap-east-1, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-southeast-4, ap-southeast-7, ap-south-1, ap-northeast-3, ap-northeast-1, ap-northeast-2, ca-central-1, ca-west-1, eu-south-1, eu-west-3, eu-south-2, eu-central-2, eu-central-1, eu-north-1, eu-west-1, eu-west-2, me-south-1, me-central-1, il-central-1, sa-east-1, mx-central-1, ap-east-2
      table_name: "GlueTableName", # required
      database_name: "GlueDatabaseName", # required
    },
    snowflake: {
      secret_arn: "SecretsManagerArn", # required
      account_identifier: "SnowflakeAccountIdentifier", # required
      database_name: "SnowflakeDatabaseName", # required
      table_name: "SnowflakeTableName", # required
      schema_name: "SnowflakeSchemaName", # required
      table_schema: { # required
        v1: [
          {
            column_name: "ColumnName", # required
            column_type: "ColumnTypeString", # required
          },
        ],
      },
    },
    athena: {
      region: "us-west-1", # accepts us-west-1, us-west-2, us-east-1, us-east-2, af-south-1, ap-east-1, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-southeast-4, ap-southeast-7, ap-south-1, ap-northeast-3, ap-northeast-1, ap-northeast-2, ca-central-1, ca-west-1, eu-south-1, eu-west-3, eu-south-2, eu-central-2, eu-central-1, eu-north-1, eu-west-1, eu-west-2, me-south-1, me-central-1, il-central-1, sa-east-1, mx-central-1, ap-east-2
      work_group: "AthenaWorkGroup", # required
      output_location: "AthenaOutputLocation",
      database_name: "AthenaDatabaseName", # required
      table_name: "AthenaTableName", # required
      catalog_name: "AthenaCatalogName",
    },
  },
  allowed_columns: ["ColumnName"],
  analysis_method: "DIRECT_QUERY", # accepts DIRECT_QUERY, DIRECT_JOB, MULTIPLE
  selected_analysis_methods: ["DIRECT_QUERY"], # accepts DIRECT_QUERY, DIRECT_JOB
})

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.region #=> String, one of "us-west-1", "us-west-2", "us-east-1", "us-east-2", "af-south-1", "ap-east-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-5", "ap-southeast-4", "ap-southeast-7", "ap-south-1", "ap-northeast-3", "ap-northeast-1", "ap-northeast-2", "ca-central-1", "ca-west-1", "eu-south-1", "eu-west-3", "eu-south-2", "eu-central-2", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "me-south-1", "me-central-1", "il-central-1", "sa-east-1", "mx-central-1", "ap-east-2"
resp.configured_table.table_reference.glue.table_name #=> String
resp.configured_table.table_reference.glue.database_name #=> String
resp.configured_table.table_reference.snowflake.secret_arn #=> String
resp.configured_table.table_reference.snowflake. #=> String
resp.configured_table.table_reference.snowflake.database_name #=> String
resp.configured_table.table_reference.snowflake.table_name #=> String
resp.configured_table.table_reference.snowflake.schema_name #=> String
resp.configured_table.table_reference.snowflake.table_schema.v1 #=> Array
resp.configured_table.table_reference.snowflake.table_schema.v1[0].column_name #=> String
resp.configured_table.table_reference.snowflake.table_schema.v1[0].column_type #=> String
resp.configured_table.table_reference.athena.region #=> String, one of "us-west-1", "us-west-2", "us-east-1", "us-east-2", "af-south-1", "ap-east-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-5", "ap-southeast-4", "ap-southeast-7", "ap-south-1", "ap-northeast-3", "ap-northeast-1", "ap-northeast-2", "ca-central-1", "ca-west-1", "eu-south-1", "eu-west-3", "eu-south-2", "eu-central-2", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "me-south-1", "me-central-1", "il-central-1", "sa-east-1", "mx-central-1", "ap-east-2"
resp.configured_table.table_reference.athena.work_group #=> String
resp.configured_table.table_reference.athena.output_location #=> String
resp.configured_table.table_reference.athena.database_name #=> String
resp.configured_table.table_reference.athena.table_name #=> String
resp.configured_table.table_reference.athena.catalog_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", "CUSTOM"
resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE"
resp.configured_table.allowed_columns #=> Array
resp.configured_table.allowed_columns[0] #=> String
resp.configured_table.selected_analysis_methods #=> Array
resp.configured_table.selected_analysis_methods[0] #=> String, one of "DIRECT_QUERY", "DIRECT_JOB"

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.

  • :table_reference (Types::TableReference) —

    A pointer to the dataset that underlies this table.

  • :allowed_columns (Array<String>) —

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

  • :analysis_method (String) —

    The analysis method for the configured table.

    DIRECT_QUERY allows SQL queries to be run directly on this table.

    DIRECT_JOB allows PySpark jobs to be run directly on this table.

    MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

  • :selected_analysis_methods (Array<String>) —

    The selected analysis methods for the table configuration update.

Returns:

See Also:



6315
6316
6317
6318
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 6315

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, CUSTOM
  analysis_rule_policy: { # required
    v1: {
      list: {
        join_columns: ["AnalysisRuleColumnName"], # required
        allowed_join_operators: ["OR"], # accepts OR, AND
        list_columns: ["AnalysisRuleColumnName"], # required
        additional_analyses: "ALLOWED", # accepts ALLOWED, REQUIRED, NOT_ALLOWED
      },
      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
        allowed_join_operators: ["OR"], # accepts OR, AND
        dimension_columns: ["AnalysisRuleColumnName"], # required
        scalar_functions: ["ABS"], # required, accepts ABS, CAST, CEILING, COALESCE, CONVERT, CURRENT_DATE, DATEADD, EXTRACT, FLOOR, GETDATE, LN, LOG, LOWER, ROUND, RTRIM, SQRT, SUBSTRING, TO_CHAR, TO_DATE, TO_NUMBER, TO_TIMESTAMP, TRIM, TRUNC, UPPER
        output_constraints: [ # required
          {
            column_name: "AnalysisRuleColumnName", # required
            minimum: 1, # required
            type: "COUNT_DISTINCT", # required, accepts COUNT_DISTINCT
          },
        ],
        additional_analyses: "ALLOWED", # accepts ALLOWED, REQUIRED, NOT_ALLOWED
      },
      custom: {
        allowed_analyses: ["AnalysisTemplateArnOrQueryWildcard"], # required
        allowed_analysis_providers: ["AccountId"],
        additional_analyses: "ALLOWED", # accepts ALLOWED, REQUIRED, NOT_ALLOWED
        disallowed_output_columns: ["AnalysisRuleColumnName"],
        differential_privacy: {
          columns: [ # required
            {
              name: "ColumnName", # required
            },
          ],
        },
        allowed_result_receivers: ["AccountId"],
        allowed_additional_analyses: ["AdditionalAnalysesResourceArn"],
      },
    },
  },
})

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.allowed_join_operators #=> Array
resp.analysis_rule.policy.v1.list.allowed_join_operators[0] #=> String, one of "OR", "AND"
resp.analysis_rule.policy.v1.list.list_columns #=> Array
resp.analysis_rule.policy.v1.list.list_columns[0] #=> String
resp.analysis_rule.policy.v1.list.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
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.allowed_join_operators #=> Array
resp.analysis_rule.policy.v1.aggregation.allowed_join_operators[0] #=> String, one of "OR", "AND"
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 "ABS", "CAST", "CEILING", "COALESCE", "CONVERT", "CURRENT_DATE", "DATEADD", "EXTRACT", "FLOOR", "GETDATE", "LN", "LOG", "LOWER", "ROUND", "RTRIM", "SQRT", "SUBSTRING", "TO_CHAR", "TO_DATE", "TO_NUMBER", "TO_TIMESTAMP", "TRIM", "TRUNC", "UPPER"
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.policy.v1.aggregation.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rule.policy.v1.custom.allowed_analyses #=> Array
resp.analysis_rule.policy.v1.custom.allowed_analyses[0] #=> String
resp.analysis_rule.policy.v1.custom.allowed_analysis_providers #=> Array
resp.analysis_rule.policy.v1.custom.allowed_analysis_providers[0] #=> String
resp.analysis_rule.policy.v1.custom.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rule.policy.v1.custom.disallowed_output_columns #=> Array
resp.analysis_rule.policy.v1.custom.disallowed_output_columns[0] #=> String
resp.analysis_rule.policy.v1.custom.differential_privacy.columns #=> Array
resp.analysis_rule.policy.v1.custom.differential_privacy.columns[0].name #=> String
resp.analysis_rule.policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rule.policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rule.policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rule.policy.v1.custom.allowed_additional_analyses[0] #=> String
resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
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:



6441
6442
6443
6444
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 6441

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.analysis_rule_types #=> Array
resp.configured_table_association.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
resp.configured_table_association.create_time #=> Time
resp.configured_table_association.update_time #=> Time
resp.configured_table_association.child_resources #=> Array
resp.configured_table_association.child_resources[0].resource_id #=> String
resp.configured_table_association.child_resources[0].resource_type #=> String, one of "INTERMEDIATE_TABLE"
resp.configured_table_association.child_resources[0].resource_name #=> String
resp.configured_table_association.child_resources[0]. #=> String
resp.configured_table_association.child_resources[0].resource_status #=> String, one of "CREATED", "POPULATE_STARTED", "POPULATE_SUCCESS", "POPULATE_FAILED", "DISALLOWED_BY_DATA_PROVIDER", "BASE_TABLE_REMOVED", "RETENTION_PERIOD_EXPIRED"

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:



6502
6503
6504
6505
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 6502

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

#update_configured_table_association_analysis_rule(params = {}) ⇒ Types::UpdateConfiguredTableAssociationAnalysisRuleOutput

Updates the analysis rule for a configured table association.

Examples:

Request syntax with placeholder values


resp = client.update_configured_table_association_analysis_rule({
  membership_identifier: "MembershipIdentifier", # required
  configured_table_association_identifier: "ConfiguredTableAssociationIdentifier", # required
  analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST, CUSTOM
  analysis_rule_policy: { # required
    v1: {
      list: {
        allowed_result_receivers: ["AccountId"],
        allowed_additional_analyses: ["AdditionalAnalysesResourceArn"],
      },
      aggregation: {
        allowed_result_receivers: ["AccountId"],
        allowed_additional_analyses: ["AdditionalAnalysesResourceArn"],
      },
      custom: {
        allowed_result_receivers: ["AccountId"],
        allowed_additional_analyses: ["AdditionalAnalysesResourceArn"],
      },
    },
  },
})

Response structure


resp.analysis_rule.membership_identifier #=> String
resp.analysis_rule.configured_table_association_id #=> String
resp.analysis_rule.configured_table_association_arn #=> String
resp.analysis_rule.policy.v1.list.allowed_result_receivers #=> Array
resp.analysis_rule.policy.v1.list.allowed_result_receivers[0] #=> String
resp.analysis_rule.policy.v1.list.allowed_additional_analyses #=> Array
resp.analysis_rule.policy.v1.list.allowed_additional_analyses[0] #=> String
resp.analysis_rule.policy.v1.aggregation.allowed_result_receivers #=> Array
resp.analysis_rule.policy.v1.aggregation.allowed_result_receivers[0] #=> String
resp.analysis_rule.policy.v1.aggregation.allowed_additional_analyses #=> Array
resp.analysis_rule.policy.v1.aggregation.allowed_additional_analyses[0] #=> String
resp.analysis_rule.policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rule.policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rule.policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rule.policy.v1.custom.allowed_additional_analyses[0] #=> String
resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
resp.analysis_rule.create_time #=> Time
resp.analysis_rule.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

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

  • :configured_table_association_identifier (required, String) —

    The identifier for the configured table association to update.

  • :analysis_rule_type (required, String) —

    The analysis rule type that you want to update.

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

    The updated analysis rule policy for the configured table association.

Returns:

See Also:



6575
6576
6577
6578
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 6575

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

#update_id_mapping_table(params = {}) ⇒ Types::UpdateIdMappingTableOutput

Provides the details that are necessary to update an ID mapping table.

Examples:

Request syntax with placeholder values


resp = client.update_id_mapping_table({
  id_mapping_table_identifier: "UUID", # required
  membership_identifier: "MembershipIdentifier", # required
  description: "ResourceDescription",
  kms_key_arn: "KMSKeyArn",
})

Response structure


resp.id_mapping_table.id #=> String
resp.id_mapping_table.arn #=> String
resp.id_mapping_table.input_reference_config.input_reference_arn #=> String
resp.id_mapping_table.input_reference_config.manage_resource_policies #=> Boolean
resp.id_mapping_table.membership_id #=> String
resp.id_mapping_table.membership_arn #=> String
resp.id_mapping_table.collaboration_id #=> String
resp.id_mapping_table.collaboration_arn #=> String
resp.id_mapping_table.description #=> String
resp.id_mapping_table.name #=> String
resp.id_mapping_table.create_time #=> Time
resp.id_mapping_table.update_time #=> Time
resp.id_mapping_table.input_reference_properties.id_mapping_table_input_source #=> Array
resp.id_mapping_table.input_reference_properties.id_mapping_table_input_source[0].id_namespace_association_id #=> String
resp.id_mapping_table.input_reference_properties.id_mapping_table_input_source[0].type #=> String, one of "SOURCE", "TARGET"
resp.id_mapping_table.kms_key_arn #=> String
resp.id_mapping_table.child_resources #=> Array
resp.id_mapping_table.child_resources[0].resource_id #=> String
resp.id_mapping_table.child_resources[0].resource_type #=> String, one of "INTERMEDIATE_TABLE"
resp.id_mapping_table.child_resources[0].resource_name #=> String
resp.id_mapping_table.child_resources[0]. #=> String
resp.id_mapping_table.child_resources[0].resource_status #=> String, one of "CREATED", "POPULATE_STARTED", "POPULATE_SUCCESS", "POPULATE_FAILED", "DISALLOWED_BY_DATA_PROVIDER", "BASE_TABLE_REMOVED", "RETENTION_PERIOD_EXPIRED"

Parameters:

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

    ({})

Options Hash (params):

  • :id_mapping_table_identifier (required, String) —

    The unique identifier of the ID mapping table that you want to update.

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the ID mapping table that you want to update.

  • :description (String) —

    A new description for the ID mapping table.

  • :kms_key_arn (String) —

    The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.

Returns:

See Also:



6637
6638
6639
6640
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 6637

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

#update_id_namespace_association(params = {}) ⇒ Types::UpdateIdNamespaceAssociationOutput

Provides the details that are necessary to update an ID namespace association.

Examples:

Request syntax with placeholder values


resp = client.update_id_namespace_association({
  id_namespace_association_identifier: "IdNamespaceAssociationIdentifier", # required
  membership_identifier: "MembershipIdentifier", # required
  name: "GenericResourceName",
  description: "ResourceDescription",
  id_mapping_config: {
    allow_use_as_dimension_column: false, # required
  },
})

Response structure


resp.id_namespace_association.id #=> String
resp.id_namespace_association.arn #=> String
resp.id_namespace_association.membership_id #=> String
resp.id_namespace_association.membership_arn #=> String
resp.id_namespace_association.collaboration_id #=> String
resp.id_namespace_association.collaboration_arn #=> String
resp.id_namespace_association.name #=> String
resp.id_namespace_association.description #=> String
resp.id_namespace_association.create_time #=> Time
resp.id_namespace_association.update_time #=> Time
resp.id_namespace_association.input_reference_config.input_reference_arn #=> String
resp.id_namespace_association.input_reference_config.manage_resource_policies #=> Boolean
resp.id_namespace_association.input_reference_properties.id_namespace_type #=> String, one of "SOURCE", "TARGET"
resp.id_namespace_association.input_reference_properties.id_mapping_workflows_supported #=> Array
resp.id_namespace_association.id_mapping_config.allow_use_as_dimension_column #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :id_namespace_association_identifier (required, String) —

    The unique identifier of the ID namespace association that you want to update.

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the ID namespace association that you want to update.

  • :name (String) —

    A new name for the ID namespace association.

  • :description (String) —

    A new description for the ID namespace association.

  • :id_mapping_config (Types::IdMappingConfig) —

    The configuration settings for the ID mapping table.

Returns:

See Also:



6700
6701
6702
6703
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 6700

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

#update_intermediate_table(params = {}) ⇒ Types::UpdateIntermediateTableOutput

Updates an intermediate table. You can update the description, KMS key ARN, and column types of existing columns. Only the intermediate table owner can call this operation.

Examples:

Request syntax with placeholder values


resp = client.update_intermediate_table({
  intermediate_table_identifier: "IntermediateTableIdentifier", # required
  membership_identifier: "MembershipIdentifier", # required
  description: "ResourceDescription",
  kms_key_arn: "KMSKeyArn",
  columns: [
    {
      name: "ColumnName", # required
      type: "IntermediateTableColumnTypeString", # required
    },
  ],
})

Response structure


resp.intermediate_table.id #=> String
resp.intermediate_table.arn #=> String
resp.intermediate_table.name #=> String
resp.intermediate_table.description #=> String
resp.intermediate_table.membership_arn #=> String
resp.intermediate_table.membership_id #=> String
resp.intermediate_table.collaboration_arn #=> String
resp.intermediate_table.collaboration_id #=> String
resp.intermediate_table.child_resources #=> Array
resp.intermediate_table.child_resources[0].resource_id #=> String
resp.intermediate_table.child_resources[0].resource_type #=> String, one of "INTERMEDIATE_TABLE"
resp.intermediate_table.child_resources[0].resource_name #=> String
resp.intermediate_table.child_resources[0]. #=> String
resp.intermediate_table.child_resources[0].resource_status #=> String, one of "CREATED", "POPULATE_STARTED", "POPULATE_SUCCESS", "POPULATE_FAILED", "DISALLOWED_BY_DATA_PROVIDER", "BASE_TABLE_REMOVED", "RETENTION_PERIOD_EXPIRED"
resp.intermediate_table.create_time #=> Time
resp.intermediate_table.update_time #=> Time
resp.intermediate_table.status #=> String, one of "CREATED", "POPULATE_STARTED", "POPULATE_SUCCESS", "POPULATE_FAILED", "DISALLOWED_BY_DATA_PROVIDER", "BASE_TABLE_REMOVED", "RETENTION_PERIOD_EXPIRED"
resp.intermediate_table.status_reason #=> String
resp.intermediate_table.kms_key_arn #=> String
resp.intermediate_table.population_analysis_configuration.sql_parameters.query_string #=> String
resp.intermediate_table.population_analysis_configuration.sql_parameters.analysis_template_arn #=> String
resp.intermediate_table.retention_in_days #=> Integer
resp.intermediate_table.table_dependencies #=> Array
resp.intermediate_table.table_dependencies[0].id #=> String
resp.intermediate_table.table_dependencies[0].name #=> String
resp.intermediate_table.table_dependencies[0].type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.table_dependencies[0].parent_type #=> String, one of "DIRECT", "INDIRECT"
resp.intermediate_table.table_dependencies[0]. #=> String
resp.intermediate_table.intermediate_table_version.version_id #=> String
resp.intermediate_table.intermediate_table_version.analysis_id #=> String
resp.intermediate_table.intermediate_table_version.analysis_type #=> String, one of "QUERY"
resp.intermediate_table.intermediate_table_version.kms_key_arn #=> String
resp.intermediate_table.intermediate_table_version.parameters #=> Hash
resp.intermediate_table.intermediate_table_version.parameters["ParameterName"] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.value #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0].name #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0].id #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0].type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0].value #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.intermediate_table.intermediate_table_version.inherited_constraints.additional_analyses.sources[0]. #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].name #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].id #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0].value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_additional_analyses.sources[0]. #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].name #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].id #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0].value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.allowed_result_receivers.sources[0]. #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.value #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.value[0] #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage #=> Array
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].column #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].source_column #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].source_name #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].source_id #=> String
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0].source_type #=> String, one of "TABLE", "INTERMEDIATE_TABLE", "ID_MAPPING_TABLE"
resp.intermediate_table.intermediate_table_version.inherited_constraints.disallowed_output_columns.column_lineage[0]. #=> String
resp.intermediate_table.intermediate_table_version.expiration_time #=> Time
resp.intermediate_table.analysis_rule_types #=> Array
resp.intermediate_table.analysis_rule_types[0] #=> String, one of "CUSTOM"
resp.intermediate_table.schema.columns #=> Array
resp.intermediate_table.schema.columns[0].name #=> String
resp.intermediate_table.schema.columns[0].type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :intermediate_table_identifier (required, String) —

    The unique identifier of the intermediate table to update.

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the intermediate table.

  • :description (String) —

    A new description for the intermediate table.

  • :kms_key_arn (String) —

    The Amazon Resource Name (ARN) of the customer-managed KMS key to use for encrypting future population data.

  • :columns (Array<Types::IntermediateTableColumn>) —

    The list of columns with updated type definitions. Only the type of existing columns can be updated.

Returns:

See Also:



6827
6828
6829
6830
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 6827

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

#update_intermediate_table_analysis_rule(params = {}) ⇒ Types::UpdateIntermediateTableAnalysisRuleOutput

Updates the analysis rule policy for an intermediate table. Only the intermediate table owner can call this operation.

Examples:

Request syntax with placeholder values


resp = client.update_intermediate_table_analysis_rule({
  membership_identifier: "MembershipIdentifier", # required
  intermediate_table_identifier: "IntermediateTableIdentifier", # required
  analysis_rule_type: "CUSTOM", # required, accepts CUSTOM
  analysis_rule_policy: { # required
    v1: {
      custom: {
        allowed_analyses: ["AnalysisTemplateArnOrQueryWildcard"],
        additional_analyses: "ALLOWED", # accepts ALLOWED, REQUIRED, NOT_ALLOWED
        allowed_additional_analyses: ["AdditionalAnalysesResourceArn"],
        allowed_analysis_providers: ["AccountId"],
        allowed_result_receivers: ["AccountId"],
        differential_privacy: {
          columns: [ # required
            {
              name: "ColumnName", # required
            },
          ],
        },
        disallowed_output_columns: ["AnalysisRuleColumnName"],
      },
    },
  },
})

Response structure


resp.analysis_rule.intermediate_table_identifier #=> String
resp.analysis_rule.intermediate_table_arn #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_analyses #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_analyses[0] #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_additional_analyses #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_additional_analyses[0] #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_analysis_providers #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_analysis_providers[0] #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_result_receivers #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.allowed_result_receivers[0] #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.differential_privacy.columns #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.differential_privacy.columns[0].name #=> String
resp.analysis_rule.analysis_rule_policy.v1.custom.disallowed_output_columns #=> Array
resp.analysis_rule.analysis_rule_policy.v1.custom.disallowed_output_columns[0] #=> String
resp.analysis_rule.analysis_rule_type #=> String, one of "CUSTOM"
resp.analysis_rule.create_time #=> Time
resp.analysis_rule.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The unique identifier of the membership that contains the intermediate table.

  • :intermediate_table_identifier (required, String) —

    The unique identifier of the intermediate table for which to update the analysis rule.

  • :analysis_rule_type (required, String) —

    The type of analysis rule to update. Currently, only CUSTOM is supported.

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

    The updated analysis rule policy for the intermediate table.

Returns:

See Also:



6906
6907
6908
6909
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 6906

def update_intermediate_table_analysis_rule(params = {}, options = {})
  req = build_request(:update_intermediate_table_analysis_rule, 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
  job_log_status: "ENABLED", # accepts ENABLED, DISABLED
  default_result_configuration: {
    output_configuration: { # required
      s3: {
        result_format: "CSV", # required, accepts CSV, PARQUET
        bucket: "ProtectedQueryS3OutputConfigurationBucketString", # required
        key_prefix: "KeyPrefix",
        single_file_output: false,
      },
    },
    role_arn: "RoleArn",
  },
  default_job_result_configuration: {
    output_configuration: { # required
      s3: {
        bucket: "ProtectedJobS3OutputConfigurationInputBucketString", # required
        key_prefix: "KeyPrefix",
      },
    },
    role_arn: "RoleArn", # required
  },
  membership_payment_configuration: {
    query_compute: {
      is_responsible: false, # required
    },
    machine_learning: {
      model_training: {
        is_responsible: false, # required
      },
      model_inference: {
        is_responsible: false, # required
      },
      synthetic_data_generation: {
        is_responsible: false, # required
      },
    },
    job_compute: {
      is_responsible: false, # 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", "CAN_RUN_JOB"
resp.membership.ml_member_abilities.custom_ml_member_abilities #=> Array
resp.membership.ml_member_abilities.custom_ml_member_abilities[0] #=> String, one of "CAN_RECEIVE_MODEL_OUTPUT", "CAN_RECEIVE_INFERENCE_OUTPUT"
resp.membership.query_log_status #=> String, one of "ENABLED", "DISABLED"
resp.membership.job_log_status #=> String, one of "ENABLED", "DISABLED"
resp.membership.default_result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
resp.membership.default_result_configuration.output_configuration.s3.bucket #=> String
resp.membership.default_result_configuration.output_configuration.s3.key_prefix #=> String
resp.membership.default_result_configuration.output_configuration.s3.single_file_output #=> Boolean
resp.membership.default_result_configuration.role_arn #=> String
resp.membership.default_job_result_configuration.output_configuration.s3.bucket #=> String
resp.membership.default_job_result_configuration.output_configuration.s3.key_prefix #=> String
resp.membership.default_job_result_configuration.role_arn #=> String
resp.membership.payment_configuration.query_compute.is_responsible #=> Boolean
resp.membership.payment_configuration.machine_learning.model_training.is_responsible #=> Boolean
resp.membership.payment_configuration.machine_learning.model_inference.is_responsible #=> Boolean
resp.membership.payment_configuration.machine_learning.synthetic_data_generation.is_responsible #=> Boolean
resp.membership.payment_configuration.job_compute.is_responsible #=> Boolean
resp.membership.is_metrics_enabled #=> Boolean

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

    When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

  • :job_log_status (String) —

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

    When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

  • :default_result_configuration (Types::MembershipProtectedQueryResultConfiguration) —

    The default protected query result configuration as specified by the member who can receive results.

  • :default_job_result_configuration (Types::MembershipProtectedJobResultConfiguration) —

    The default job result configuration.

  • :membership_payment_configuration (Types::UpdateMembershipPaymentConfiguration) —

    The payment configuration to update for the membership.

Returns:

See Also:



7030
7031
7032
7033
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 7030

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

#update_privacy_budget_template(params = {}) ⇒ Types::UpdatePrivacyBudgetTemplateOutput

Updates the privacy budget template for the specified collaboration.

Examples:

Request syntax with placeholder values


resp = client.update_privacy_budget_template({
  membership_identifier: "MembershipIdentifier", # required
  privacy_budget_template_identifier: "PrivacyBudgetTemplateIdentifier", # required
  privacy_budget_type: "DIFFERENTIAL_PRIVACY", # required, accepts DIFFERENTIAL_PRIVACY, ACCESS_BUDGET
  parameters: {
    differential_privacy: {
      epsilon: 1,
      users_noise_per_query: 1,
    },
    access_budget: {
      budget_parameters: [ # required
        {
          type: "CALENDAR_DAY", # required, accepts CALENDAR_DAY, CALENDAR_MONTH, CALENDAR_WEEK, LIFETIME
          budget: 1, # required
          auto_refresh: "ENABLED", # accepts ENABLED, DISABLED
        },
      ],
    },
  },
})

Response structure


resp.privacy_budget_template.id #=> String
resp.privacy_budget_template.arn #=> String
resp.privacy_budget_template.membership_id #=> String
resp.privacy_budget_template.membership_arn #=> String
resp.privacy_budget_template.collaboration_id #=> String
resp.privacy_budget_template.collaboration_arn #=> String
resp.privacy_budget_template.create_time #=> Time
resp.privacy_budget_template.update_time #=> Time
resp.privacy_budget_template.privacy_budget_type #=> String, one of "DIFFERENTIAL_PRIVACY", "ACCESS_BUDGET"
resp.privacy_budget_template.auto_refresh #=> String, one of "CALENDAR_MONTH", "NONE"
resp.privacy_budget_template.parameters.differential_privacy.epsilon #=> Integer
resp.privacy_budget_template.parameters.differential_privacy.users_noise_per_query #=> Integer
resp.privacy_budget_template.parameters.access_budget.budget_parameters #=> Array
resp.privacy_budget_template.parameters.access_budget.budget_parameters[0].type #=> String, one of "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_WEEK", "LIFETIME"
resp.privacy_budget_template.parameters.access_budget.budget_parameters[0].budget #=> Integer
resp.privacy_budget_template.parameters.access_budget.budget_parameters[0].auto_refresh #=> String, one of "ENABLED", "DISABLED"
resp.privacy_budget_template.parameters.access_budget.resource_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    A unique identifier for one of your memberships for a collaboration. The privacy budget template is updated in the collaboration that this membership belongs to. Accepts a membership ID.

  • :privacy_budget_template_identifier (required, String) —

    A unique identifier for your privacy budget template that you want to update.

  • :privacy_budget_type (required, String) —

    Specifies the type of the privacy budget template.

  • :parameters (Types::PrivacyBudgetTemplateUpdateParameters) —

    Specifies the epsilon and noise parameters for the privacy budget template.

Returns:

See Also:



7104
7105
7106
7107
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 7104

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

#update_protected_job(params = {}) ⇒ Types::UpdateProtectedJobOutput

Updates the processing of a currently running job.

Examples:

Request syntax with placeholder values


resp = client.update_protected_job({
  membership_identifier: "MembershipIdentifier", # required
  protected_job_identifier: "ProtectedJobIdentifier", # required
  target_status: "CANCELLED", # required, accepts CANCELLED
})

Response structure


resp.protected_job.id #=> String
resp.protected_job.membership_id #=> String
resp.protected_job.membership_arn #=> String
resp.protected_job.create_time #=> Time
resp.protected_job.job_parameters.analysis_template_arn #=> String
resp.protected_job.job_parameters.parameters #=> Hash
resp.protected_job.job_parameters.parameters["JobParameterName"] #=> String
resp.protected_job.status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS"
resp.protected_job.result_configuration.output_configuration.s3.bucket #=> String
resp.protected_job.result_configuration.output_configuration.s3.key_prefix #=> String
resp.protected_job.result_configuration.output_configuration.member. #=> String
resp.protected_job.statistics.total_duration_in_millis #=> Integer
resp.protected_job.statistics.billed_resource_utilization.units #=> Float
resp.protected_job.result.output.s3.location #=> String
resp.protected_job.result.output.member_list #=> Array
resp.protected_job.result.output.member_list[0]. #=> String
resp.protected_job.error.message #=> String
resp.protected_job.error.code #=> String
resp.protected_job.compute_configuration.worker.type #=> String, one of "CR.1X", "CR.4X"
resp.protected_job.compute_configuration.worker.number #=> Integer
resp.protected_job.compute_configuration.worker.properties.spark #=> Hash
resp.protected_job.compute_configuration.worker.properties.spark["SparkPropertyKey"] #=> String
resp.protected_job. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :membership_identifier (required, String) —

    The identifier for a member of a protected job instance.

  • :protected_job_identifier (required, String) —

    The identifier of the protected job to update.

  • :target_status (required, String) —

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

Returns:

See Also:



7163
7164
7165
7166
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 7163

def update_protected_job(params = {}, options = {})
  req = build_request(:update_protected_job, 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.sql_parameters.analysis_template_arn #=> String
resp.protected_query.sql_parameters.parameters #=> Hash
resp.protected_query.sql_parameters.parameters["ParameterName"] #=> 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.result_configuration.output_configuration.s3.single_file_output #=> Boolean
resp.protected_query.result_configuration.output_configuration.member. #=> String
resp.protected_query.result_configuration.output_configuration.distribute.locations #=> Array
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].s3.result_format #=> String, one of "CSV", "PARQUET"
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].s3.bucket #=> String
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].s3.key_prefix #=> String
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].s3.single_file_output #=> Boolean
resp.protected_query.result_configuration.output_configuration.distribute.locations[0].member. #=> String
resp.protected_query.result_configuration.output_configuration.intermediate_table.id #=> String
resp.protected_query.result_configuration.output_configuration.intermediate_table.arn #=> String
resp.protected_query.result_configuration.output_configuration.intermediate_table.name #=> String
resp.protected_query.statistics.total_duration_in_millis #=> Integer
resp.protected_query.statistics.billed_resource_utilization.units #=> Float
resp.protected_query.result.output.s3.location #=> String
resp.protected_query.result.output.member_list #=> Array
resp.protected_query.result.output.member_list[0]. #=> String
resp.protected_query.result.output.distribute.s3.location #=> String
resp.protected_query.result.output.distribute.member_list #=> Array
resp.protected_query.result.output.distribute.member_list[0]. #=> String
resp.protected_query.error.message #=> String
resp.protected_query.error.code #=> String
resp.protected_query.differential_privacy.sensitivity_parameters #=> Array
resp.protected_query.differential_privacy.sensitivity_parameters[0].aggregation_type #=> String, one of "AVG", "COUNT", "COUNT_DISTINCT", "SUM", "STDDEV"
resp.protected_query.differential_privacy.sensitivity_parameters[0].aggregation_expression #=> String
resp.protected_query.differential_privacy.sensitivity_parameters[0].user_contribution_limit #=> Integer
resp.protected_query.differential_privacy.sensitivity_parameters[0].min_column_value #=> Float
resp.protected_query.differential_privacy.sensitivity_parameters[0].max_column_value #=> Float
resp.protected_query.compute_configuration.worker.type #=> String, one of "CR.1X", "CR.4X"
resp.protected_query.compute_configuration.worker.number #=> Integer
resp.protected_query.compute_configuration.worker.properties.spark #=> Hash
resp.protected_query.compute_configuration.worker.properties.spark["SparkPropertyKey"] #=> String
resp.protected_query. #=> 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:



7243
7244
7245
7246
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/client.rb', line 7243

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