Class: Aws::DataExchange::Client

Inherits:

Seahorse::Client::Base

• Object
• Seahorse::Client::Base
• Aws::DataExchange::Client

Includes:

ClientStubs

Defined in:

gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb

Overview

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

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

• #accept_data_grant(params = {}) ⇒ Types::AcceptDataGrantResponse

  This operation accepts a data grant.

• #cancel_job(params = {}) ⇒ Struct

  This operation cancels a job.

• #create_data_grant(params = {}) ⇒ Types::CreateDataGrantResponse

  This operation creates a data grant.

• #create_data_set(params = {}) ⇒ Types::CreateDataSetResponse

  This operation creates a data set.

• #create_event_action(params = {}) ⇒ Types::CreateEventActionResponse

  This operation creates an event action.

• #create_job(params = {}) ⇒ Types::CreateJobResponse

  This operation creates a job.

• #create_revision(params = {}) ⇒ Types::CreateRevisionResponse

  This operation creates a revision for a data set.

• #delete_asset(params = {}) ⇒ Struct

  This operation deletes an asset.

• #delete_data_grant(params = {}) ⇒ Struct

  This operation deletes a data grant.

• #delete_data_set(params = {}) ⇒ Struct

  This operation deletes a data set.

• #delete_event_action(params = {}) ⇒ Struct

  This operation deletes the event action.

• #delete_revision(params = {}) ⇒ Struct

  This operation deletes a revision.

• #get_asset(params = {}) ⇒ Types::GetAssetResponse

  This operation returns information about an asset.

• #get_data_grant(params = {}) ⇒ Types::GetDataGrantResponse

  This operation returns information about a data grant.

• #get_data_set(params = {}) ⇒ Types::GetDataSetResponse

  This operation returns information about a data set.

• #get_event_action(params = {}) ⇒ Types::GetEventActionResponse

  This operation retrieves information about an event action.

• #get_job(params = {}) ⇒ Types::GetJobResponse

  This operation returns information about a job.

• #get_received_data_grant(params = {}) ⇒ Types::GetReceivedDataGrantResponse

  This operation returns information about a received data grant.

• #get_revision(params = {}) ⇒ Types::GetRevisionResponse

  This operation returns information about a revision.

• #list_data_grants(params = {}) ⇒ Types::ListDataGrantsResponse

  This operation returns information about all data grants.

• #list_data_set_revisions(params = {}) ⇒ Types::ListDataSetRevisionsResponse

  This operation lists a data set's revisions sorted by CreatedAt in descending order.

• #list_data_sets(params = {}) ⇒ Types::ListDataSetsResponse

  This operation lists your data sets.

• #list_event_actions(params = {}) ⇒ Types::ListEventActionsResponse

  This operation lists your event actions.

• #list_jobs(params = {}) ⇒ Types::ListJobsResponse

  This operation lists your jobs sorted by CreatedAt in descending order.

• #list_received_data_grants(params = {}) ⇒ Types::ListReceivedDataGrantsResponse

  This operation returns information about all received data grants.

• #list_revision_assets(params = {}) ⇒ Types::ListRevisionAssetsResponse

  This operation lists a revision's assets sorted alphabetically in descending order.

• #list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

  This operation lists the tags on the resource.

• #revoke_revision(params = {}) ⇒ Types::RevokeRevisionResponse

  This operation revokes subscribers' access to a revision.

• #send_api_asset(params = {}) ⇒ Types::SendApiAssetResponse

  This operation invokes an API Gateway API asset.

• #send_data_set_notification(params = {}) ⇒ Struct

  The type of event associated with the data set.

• #start_job(params = {}) ⇒ Struct

  This operation starts a job.

• #tag_resource(params = {}) ⇒ Struct

  This operation tags a resource.

• #untag_resource(params = {}) ⇒ Struct

  This operation removes one or more tags from a resource.

• #update_asset(params = {}) ⇒ Types::UpdateAssetResponse

  This operation updates an asset.

• #update_data_set(params = {}) ⇒ Types::UpdateDataSetResponse

  This operation updates a data set.

• #update_event_action(params = {}) ⇒ Types::UpdateEventActionResponse

  This operation updates the event action.

• #update_revision(params = {}) ⇒ Types::UpdateRevisionResponse

  This operation updates a revision.

Instance Method Summary

• #initialize(options) ⇒ Client constructor

  A new instance of Client.

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

• options (Hash)

Options Hash (options):

• :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 an instance of any one of the following classes:

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

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

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

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

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

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

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

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

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

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

  • Aws.config[:credentials]

  • The :access_key_id, :secret_access_key, :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 Aws::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 default value if no retry mode is provided.

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

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

• :sdk_ua_app_id (String) —

  A unique and opaque application ID that is appended to the User-Agent header as app/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 ClientStubs#stub_responses. See 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 an instance of any one of the following classes:

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

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

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

• :use_dualstack_endpoint (Boolean) —

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

• :use_fips_endpoint (Boolean) —

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

• :validate_params (Boolean) — default: true —

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

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

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

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 476

def initialize(*args)
  super
end

Instance Method Details

#accept_data_grant(params = {}) ⇒ Types::AcceptDataGrantResponse

This operation accepts a data grant.

Examples:

Request syntax with placeholder values

resp = client.accept_data_grant({
  data_grant_arn: "DataGrantArn", # required
})

Response structure

resp.name #=> String
resp.sender_principal #=> String
resp.receiver_principal #=> String
resp.description #=> String
resp.acceptance_state #=> String, one of "PENDING_RECEIVER_ACCEPTANCE", "ACCEPTED"
resp.accepted_at #=> Time
resp.ends_at #=> Time
resp.grant_distribution_scope #=> String, one of "AWS_ORGANIZATION", "NONE"
resp.data_set_id #=> String
resp.id #=> String
resp.arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :data_grant_arn (required, String) —

  The Amazon Resource Name (ARN) of the data grant to accept.

Returns:

• (Types::AcceptDataGrantResponse) —

  Returns a response object which responds to the following methods:

  • #name => String
  • #sender_principal => String
  • #receiver_principal => String
  • #description => String
  • #acceptance_state => String
  • #accepted_at => Time
  • #ends_at => Time
  • #grant_distribution_scope => String
  • #data_set_id => String
  • #id => String
  • #arn => String
  • #created_at => Time
  • #updated_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 529

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

#cancel_job(params = {}) ⇒ Struct

This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.

Examples:

Request syntax with placeholder values

resp = client.cancel_job({
  job_id: "Id", # required
})

Parameters:

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

  ({})

Options Hash (params):

• :job_id (required, String) —

  The unique identifier for a job.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 552

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

#create_data_grant(params = {}) ⇒ Types::CreateDataGrantResponse

This operation creates a data grant.

Examples:

Request syntax with placeholder values

resp = client.create_data_grant({
  name: "DataGrantName", # required
  grant_distribution_scope: "AWS_ORGANIZATION", # required, accepts AWS_ORGANIZATION, NONE
  receiver_principal: "ReceiverPrincipal", # required
  source_data_set_id: "Id", # required
  ends_at: Time.now,
  description: "Description",
  tags: {
    "__string" => "__string",
  },
})

Response structure

resp.name #=> String
resp.sender_principal #=> String
resp.receiver_principal #=> String
resp.description #=> String
resp.acceptance_state #=> String, one of "PENDING_RECEIVER_ACCEPTANCE", "ACCEPTED"
resp.accepted_at #=> Time
resp.ends_at #=> Time
resp.grant_distribution_scope #=> String, one of "AWS_ORGANIZATION", "NONE"
resp.data_set_id #=> String
resp.source_data_set_id #=> String
resp.id #=> String
resp.arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

  ({})

Options Hash (params):

• :name (required, String) —

  The name of the data grant.

• :grant_distribution_scope (required, String) —

  The distribution scope of the data grant.

• :receiver_principal (required, String) —

  The Amazon Web Services account ID of the data grant receiver.

• :source_data_set_id (required, String) —

  The ID of the data set used to create the data grant.

• :ends_at (Time, DateTime, Date, Integer, String) —

  The timestamp of when access to the associated data set ends.

• :description (String) —

  The description of the data grant.

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

  The tags to add to the data grant. A tag is a key-value pair.

Returns:

• (Types::CreateDataGrantResponse) —

  Returns a response object which responds to the following methods:

  • #name => String
  • #sender_principal => String
  • #receiver_principal => String
  • #description => String
  • #acceptance_state => String
  • #accepted_at => Time
  • #ends_at => Time
  • #grant_distribution_scope => String
  • #data_set_id => String
  • #source_data_set_id => String
  • #id => String
  • #arn => String
  • #created_at => Time
  • #updated_at => Time
  • #tags => Hash<String,String>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 635

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

#create_data_set(params = {}) ⇒ Types::CreateDataSetResponse

This operation creates a data set.

Examples:

Request syntax with placeholder values

resp = client.create_data_set({
  asset_type: "S3_SNAPSHOT", # required, accepts S3_SNAPSHOT, REDSHIFT_DATA_SHARE, API_GATEWAY_API, S3_DATA_ACCESS, LAKE_FORMATION_DATA_PERMISSION
  description: "Description", # required
  name: "Name", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure

resp.arn #=> String
resp.asset_type #=> String, one of "S3_SNAPSHOT", "REDSHIFT_DATA_SHARE", "API_GATEWAY_API", "S3_DATA_ACCESS", "LAKE_FORMATION_DATA_PERMISSION"
resp.created_at #=> Time
resp.description #=> String
resp.id #=> String
resp.name #=> String
resp.origin #=> String, one of "OWNED", "ENTITLED"
resp.origin_details.product_id #=> String
resp.origin_details.data_grant_id #=> String
resp.source_id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.updated_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :asset_type (required, String) —

  The type of asset that is added to a data set.

• :description (required, String) —

  A description for the data set. This value can be up to 16,348 characters long.

• :name (required, String) —

  The name of the data set.

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

  A data set tag is an optional label that you can assign to a data set 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 these data sets and revisions.

Returns:

• (Types::CreateDataSetResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String
  • #asset_type => String
  • #created_at => Time
  • #description => String
  • #id => String
  • #name => String
  • #origin => String
  • #origin_details => Types::OriginDetails
  • #source_id => String
  • #tags => Hash<String,String>
  • #updated_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 704

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

#create_event_action(params = {}) ⇒ Types::CreateEventActionResponse

This operation creates an event action.

Examples:

Request syntax with placeholder values

resp = client.create_event_action({
  action: { # required
    export_revision_to_s3: {
      encryption: {
        kms_key_arn: "__string",
        type: "aws:kms", # required, accepts aws:kms, AES256
      },
      revision_destination: { # required
        bucket: "__string", # required
        key_pattern: "__string",
      },
    },
  },
  event: { # required
    revision_published: {
      data_set_id: "Id", # required
    },
  },
  tags: {
    "__string" => "__string",
  },
})

Response structure

resp.action.export_revision_to_s3.encryption.kms_key_arn #=> String
resp.action.export_revision_to_s3.encryption.type #=> String, one of "aws:kms", "AES256"
resp.action.export_revision_to_s3.revision_destination.bucket #=> String
resp.action.export_revision_to_s3.revision_destination.key_pattern #=> String
resp.arn #=> String
resp.created_at #=> Time
resp.event.revision_published.data_set_id #=> String
resp.id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.updated_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :action (required, Types::Action) —

  What occurs after a certain event.

• :event (required, Types::Event) —

  What occurs to start an action.

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

  Key-value pairs that you can associate with the event action.

Returns:

• (Types::CreateEventActionResponse) —

  Returns a response object which responds to the following methods:

  • #action => Types::Action
  • #arn => String
  • #created_at => Time
  • #event => Types::Event
  • #id => String
  • #tags => Hash<String,String>
  • #updated_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 773

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

#create_job(params = {}) ⇒ Types::CreateJobResponse

This operation creates a job.

Examples:

Request syntax with placeholder values

resp = client.create_job({
  details: { # required
    export_asset_to_signed_url: {
      asset_id: "Id", # required
      data_set_id: "Id", # required
      revision_id: "Id", # required
    },
    export_assets_to_s3: {
      asset_destinations: [ # required
        {
          asset_id: "Id", # required
          bucket: "__string", # required
          key: "__string",
        },
      ],
      data_set_id: "Id", # required
      encryption: {
        kms_key_arn: "__string",
        type: "aws:kms", # required, accepts aws:kms, AES256
      },
      revision_id: "Id", # required
    },
    export_revisions_to_s3: {
      data_set_id: "Id", # required
      encryption: {
        kms_key_arn: "__string",
        type: "aws:kms", # required, accepts aws:kms, AES256
      },
      revision_destinations: [ # required
        {
          bucket: "__string", # required
          key_pattern: "__string",
          revision_id: "Id", # required
        },
      ],
    },
    import_asset_from_signed_url: {
      asset_name: "AssetName", # required
      data_set_id: "Id", # required
      md_5_hash: "__stringMin24Max24PatternAZaZ094AZaZ092AZaZ093", # required
      revision_id: "Id", # required
    },
    import_assets_from_s3: {
      asset_sources: [ # required
        {
          bucket: "__string", # required
          key: "__string", # required
        },
      ],
      data_set_id: "Id", # required
      revision_id: "Id", # required
    },
    import_assets_from_redshift_data_shares: {
      asset_sources: [ # required
        {
          data_share_arn: "__string", # required
        },
      ],
      data_set_id: "Id", # required
      revision_id: "Id", # required
    },
    import_asset_from_api_gateway_api: {
      api_description: "ApiDescription",
      api_id: "__string", # required
      api_key: "__string",
      api_name: "__string", # required
      api_specification_md_5_hash: "__stringMin24Max24PatternAZaZ094AZaZ092AZaZ093", # required
      data_set_id: "Id", # required
      protocol_type: "REST", # required, accepts REST
      revision_id: "Id", # required
      stage: "__string", # required
    },
    create_s3_data_access_from_s3_bucket: {
      asset_source: { # required
        bucket: "__string", # required
        key_prefixes: ["__string"],
        keys: ["__string"],
        kms_keys_to_grant: [
          {
            kms_key_arn: "KmsKeyArn", # required
          },
        ],
      },
      data_set_id: "Id", # required
      revision_id: "Id", # required
    },
    import_assets_from_lake_formation_tag_policy: {
      catalog_id: "AwsAccountId", # required
      database: {
        expression: [ # required
          {
            tag_key: "String", # required
            tag_values: ["String"], # required
          },
        ],
        permissions: ["DESCRIBE"], # required, accepts DESCRIBE
      },
      table: {
        expression: [ # required
          {
            tag_key: "String", # required
            tag_values: ["String"], # required
          },
        ],
        permissions: ["DESCRIBE"], # required, accepts DESCRIBE, SELECT
      },
      role_arn: "RoleArn", # required
      data_set_id: "Id", # required
      revision_id: "Id", # required
    },
  },
  type: "IMPORT_ASSETS_FROM_S3", # required, accepts IMPORT_ASSETS_FROM_S3, IMPORT_ASSET_FROM_SIGNED_URL, EXPORT_ASSETS_TO_S3, EXPORT_ASSET_TO_SIGNED_URL, EXPORT_REVISIONS_TO_S3, IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES, IMPORT_ASSET_FROM_API_GATEWAY_API, CREATE_S3_DATA_ACCESS_FROM_S3_BUCKET, IMPORT_ASSETS_FROM_LAKE_FORMATION_TAG_POLICY
})

Response structure

resp.arn #=> String
resp.created_at #=> Time
resp.details.export_asset_to_signed_url.asset_id #=> String
resp.details.export_asset_to_signed_url.data_set_id #=> String
resp.details.export_asset_to_signed_url.revision_id #=> String
resp.details.export_asset_to_signed_url.signed_url #=> String
resp.details.export_asset_to_signed_url.signed_url_expires_at #=> Time
resp.details.export_assets_to_s3.asset_destinations #=> Array
resp.details.export_assets_to_s3.asset_destinations[0].asset_id #=> String
resp.details.export_assets_to_s3.asset_destinations[0].bucket #=> String
resp.details.export_assets_to_s3.asset_destinations[0].key #=> String
resp.details.export_assets_to_s3.data_set_id #=> String
resp.details.export_assets_to_s3.encryption.kms_key_arn #=> String
resp.details.export_assets_to_s3.encryption.type #=> String, one of "aws:kms", "AES256"
resp.details.export_assets_to_s3.revision_id #=> String
resp.details.export_revisions_to_s3.data_set_id #=> String
resp.details.export_revisions_to_s3.encryption.kms_key_arn #=> String
resp.details.export_revisions_to_s3.encryption.type #=> String, one of "aws:kms", "AES256"
resp.details.export_revisions_to_s3.revision_destinations #=> Array
resp.details.export_revisions_to_s3.revision_destinations[0].bucket #=> String
resp.details.export_revisions_to_s3.revision_destinations[0].key_pattern #=> String
resp.details.export_revisions_to_s3.revision_destinations[0].revision_id #=> String
resp.details.export_revisions_to_s3.event_action_arn #=> String
resp.details.import_asset_from_signed_url.asset_name #=> String
resp.details.import_asset_from_signed_url.data_set_id #=> String
resp.details.import_asset_from_signed_url.md_5_hash #=> String
resp.details.import_asset_from_signed_url.revision_id #=> String
resp.details.import_asset_from_signed_url.signed_url #=> String
resp.details.import_asset_from_signed_url.signed_url_expires_at #=> Time
resp.details.import_assets_from_s3.asset_sources #=> Array
resp.details.import_assets_from_s3.asset_sources[0].bucket #=> String
resp.details.import_assets_from_s3.asset_sources[0].key #=> String
resp.details.import_assets_from_s3.data_set_id #=> String
resp.details.import_assets_from_s3.revision_id #=> String
resp.details.import_assets_from_redshift_data_shares.asset_sources #=> Array
resp.details.import_assets_from_redshift_data_shares.asset_sources[0].data_share_arn #=> String
resp.details.import_assets_from_redshift_data_shares.data_set_id #=> String
resp.details.import_assets_from_redshift_data_shares.revision_id #=> String
resp.details.import_asset_from_api_gateway_api.api_description #=> String
resp.details.import_asset_from_api_gateway_api.api_id #=> String
resp.details.import_asset_from_api_gateway_api.api_key #=> String
resp.details.import_asset_from_api_gateway_api.api_name #=> String
resp.details.import_asset_from_api_gateway_api.api_specification_md_5_hash #=> String
resp.details.import_asset_from_api_gateway_api.api_specification_upload_url #=> String
resp.details.import_asset_from_api_gateway_api.api_specification_upload_url_expires_at #=> Time
resp.details.import_asset_from_api_gateway_api.data_set_id #=> String
resp.details.import_asset_from_api_gateway_api.protocol_type #=> String, one of "REST"
resp.details.import_asset_from_api_gateway_api.revision_id #=> String
resp.details.import_asset_from_api_gateway_api.stage #=> String
resp.details.create_s3_data_access_from_s3_bucket.asset_source.bucket #=> String
resp.details.create_s3_data_access_from_s3_bucket.asset_source.key_prefixes #=> Array
resp.details.create_s3_data_access_from_s3_bucket.asset_source.key_prefixes[0] #=> String
resp.details.create_s3_data_access_from_s3_bucket.asset_source.keys #=> Array
resp.details.create_s3_data_access_from_s3_bucket.asset_source.keys[0] #=> String
resp.details.create_s3_data_access_from_s3_bucket.asset_source.kms_keys_to_grant #=> Array
resp.details.create_s3_data_access_from_s3_bucket.asset_source.kms_keys_to_grant[0].kms_key_arn #=> String
resp.details.create_s3_data_access_from_s3_bucket.data_set_id #=> String
resp.details.create_s3_data_access_from_s3_bucket.revision_id #=> String
resp.details.import_assets_from_lake_formation_tag_policy.catalog_id #=> String
resp.details.import_assets_from_lake_formation_tag_policy.database.expression #=> Array
resp.details.import_assets_from_lake_formation_tag_policy.database.expression[0].tag_key #=> String
resp.details.import_assets_from_lake_formation_tag_policy.database.expression[0].tag_values #=> Array
resp.details.import_assets_from_lake_formation_tag_policy.database.expression[0].tag_values[0] #=> String
resp.details.import_assets_from_lake_formation_tag_policy.database.permissions #=> Array
resp.details.import_assets_from_lake_formation_tag_policy.database.permissions[0] #=> String, one of "DESCRIBE"
resp.details.import_assets_from_lake_formation_tag_policy.table.expression #=> Array
resp.details.import_assets_from_lake_formation_tag_policy.table.expression[0].tag_key #=> String
resp.details.import_assets_from_lake_formation_tag_policy.table.expression[0].tag_values #=> Array
resp.details.import_assets_from_lake_formation_tag_policy.table.expression[0].tag_values[0] #=> String
resp.details.import_assets_from_lake_formation_tag_policy.table.permissions #=> Array
resp.details.import_assets_from_lake_formation_tag_policy.table.permissions[0] #=> String, one of "DESCRIBE", "SELECT"
resp.details.import_assets_from_lake_formation_tag_policy.role_arn #=> String
resp.details.import_assets_from_lake_formation_tag_policy.data_set_id #=> String
resp.details.import_assets_from_lake_formation_tag_policy.revision_id #=> String
resp.errors #=> Array
resp.errors[0].code #=> String, one of "ACCESS_DENIED_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "MALWARE_DETECTED", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "VALIDATION_EXCEPTION", "MALWARE_SCAN_ENCRYPTED_FILE"
resp.errors[0].details.import_asset_from_signed_url_job_error_details.asset_name #=> String
resp.errors[0].details.import_assets_from_s3_job_error_details #=> Array
resp.errors[0].details.import_assets_from_s3_job_error_details[0].bucket #=> String
resp.errors[0].details.import_assets_from_s3_job_error_details[0].key #=> String
resp.errors[0].limit_name #=> String, one of "Assets per revision", "Asset size in GB", "Amazon Redshift datashare assets per revision", "AWS Lake Formation data permission assets per revision", "Amazon S3 data access assets per revision"
resp.errors[0].limit_value #=> Float
resp.errors[0].message #=> String
resp.errors[0].resource_id #=> String
resp.errors[0].resource_type #=> String, one of "REVISION", "ASSET", "DATA_SET"
resp.id #=> String
resp.state #=> String, one of "WAITING", "IN_PROGRESS", "ERROR", "COMPLETED", "CANCELLED", "TIMED_OUT"
resp.type #=> String, one of "IMPORT_ASSETS_FROM_S3", "IMPORT_ASSET_FROM_SIGNED_URL", "EXPORT_ASSETS_TO_S3", "EXPORT_ASSET_TO_SIGNED_URL", "EXPORT_REVISIONS_TO_S3", "IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES", "IMPORT_ASSET_FROM_API_GATEWAY_API", "CREATE_S3_DATA_ACCESS_FROM_S3_BUCKET", "IMPORT_ASSETS_FROM_LAKE_FORMATION_TAG_POLICY"
resp.updated_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :details (required, Types::RequestDetails) —

  The details for the CreateJob request.

• :type (required, String) —

  The type of job to be created.

Returns:

• (Types::CreateJobResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String
  • #created_at => Time
  • #details => Types::ResponseDetails
  • #errors => Array<Types::JobError>
  • #id => String
  • #state => String
  • #type => String
  • #updated_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1009

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

#create_revision(params = {}) ⇒ Types::CreateRevisionResponse

This operation creates a revision for a data set.

Examples:

Request syntax with placeholder values

resp = client.create_revision({
  comment: "__stringMin0Max16384",
  data_set_id: "Id", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure

resp.arn #=> String
resp.comment #=> String
resp.created_at #=> Time
resp.data_set_id #=> String
resp.finalized #=> Boolean
resp.id #=> String
resp.source_id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.updated_at #=> Time
resp.revocation_comment #=> String
resp.revoked #=> Boolean
resp.revoked_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :comment (String) —

  An optional comment about the revision.

• :data_set_id (required, String) —

  The unique identifier for a data set.

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

  A revision tag is an optional label that you can assign to a revision 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 these data sets and revisions.

Returns:

• (Types::CreateRevisionResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String
  • #comment => String
  • #created_at => Time
  • #data_set_id => String
  • #finalized => Boolean
  • #id => String
  • #source_id => String
  • #tags => Hash<String,String>
  • #updated_at => Time
  • #revocation_comment => String
  • #revoked => Boolean
  • #revoked_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1074

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

#delete_asset(params = {}) ⇒ Struct

This operation deletes an asset.

Examples:

Request syntax with placeholder values

resp = client.delete_asset({
  asset_id: "Id", # required
  data_set_id: "Id", # required
  revision_id: "Id", # required
})

Parameters:

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

  ({})

Options Hash (params):

• :asset_id (required, String) —

  The unique identifier for an asset.

• :data_set_id (required, String) —

  The unique identifier for a data set.

• :revision_id (required, String) —

  The unique identifier for a revision.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1104

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

#delete_data_grant(params = {}) ⇒ Struct

This operation deletes a data grant.

Examples:

Request syntax with placeholder values

resp = client.delete_data_grant({
  data_grant_id: "DataGrantId", # required
})

Parameters:

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

  ({})

Options Hash (params):

• :data_grant_id (required, String) —

  The ID of the data grant to delete.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1126

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

#delete_data_set(params = {}) ⇒ Struct

This operation deletes a data set.

Examples:

Request syntax with placeholder values

resp = client.delete_data_set({
  data_set_id: "Id", # required
})

Parameters:

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

  ({})

Options Hash (params):

• :data_set_id (required, String) —

  The unique identifier for a data set.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1148

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

#delete_event_action(params = {}) ⇒ Struct

This operation deletes the event action.

Examples:

Request syntax with placeholder values

resp = client.delete_event_action({
  event_action_id: "__string", # required
})

Parameters:

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

  ({})

Options Hash (params):

• :event_action_id (required, String) —

  The unique identifier for the event action.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1170

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

#delete_revision(params = {}) ⇒ Struct

This operation deletes a revision.

Examples:

Request syntax with placeholder values

resp = client.delete_revision({
  data_set_id: "Id", # required
  revision_id: "Id", # required
})

Parameters:

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

  ({})

Options Hash (params):

• :data_set_id (required, String) —

  The unique identifier for a data set.

• :revision_id (required, String) —

  The unique identifier for a revision.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1196

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

#get_asset(params = {}) ⇒ Types::GetAssetResponse

This operation returns information about an asset.

Examples:

Request syntax with placeholder values

resp = client.get_asset({
  asset_id: "Id", # required
  data_set_id: "Id", # required
  revision_id: "Id", # required
})

Response structure

resp.arn #=> String
resp.asset_details.s3_snapshot_asset.size #=> Float
resp.asset_details.redshift_data_share_asset.arn #=> String
resp.asset_details.api_gateway_api_asset.api_description #=> String
resp.asset_details.api_gateway_api_asset.api_endpoint #=> String
resp.asset_details.api_gateway_api_asset.api_id #=> String
resp.asset_details.api_gateway_api_asset.api_key #=> String
resp.asset_details.api_gateway_api_asset.api_name #=> String
resp.asset_details.api_gateway_api_asset.api_specification_download_url #=> String
resp.asset_details.api_gateway_api_asset.api_specification_download_url_expires_at #=> Time
resp.asset_details.api_gateway_api_asset.protocol_type #=> String, one of "REST"
resp.asset_details.api_gateway_api_asset.stage #=> String
resp.asset_details.s3_data_access_asset.bucket #=> String
resp.asset_details.s3_data_access_asset.key_prefixes #=> Array
resp.asset_details.s3_data_access_asset.key_prefixes[0] #=> String
resp.asset_details.s3_data_access_asset.keys #=> Array
resp.asset_details.s3_data_access_asset.keys[0] #=> String
resp.asset_details.s3_data_access_asset.s3_access_point_alias #=> String
resp.asset_details.s3_data_access_asset.s3_access_point_arn #=> String
resp.asset_details.s3_data_access_asset.kms_keys_to_grant #=> Array
resp.asset_details.s3_data_access_asset.kms_keys_to_grant[0].kms_key_arn #=> String
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.catalog_id #=> String
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_type #=> String, one of "TABLE", "DATABASE"
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.database.expression #=> Array
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.database.expression[0].tag_key #=> String
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.database.expression[0].tag_values #=> Array
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.database.expression[0].tag_values[0] #=> String
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.table.expression #=> Array
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.table.expression[0].tag_key #=> String
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.table.expression[0].tag_values #=> Array
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.table.expression[0].tag_values[0] #=> String
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_type #=> String, one of "LFTagPolicy"
resp.asset_details.lake_formation_data_permission_asset.permissions #=> Array
resp.asset_details.lake_formation_data_permission_asset.permissions[0] #=> String, one of "DESCRIBE", "SELECT"
resp.asset_details.lake_formation_data_permission_asset.role_arn #=> String
resp.asset_type #=> String, one of "S3_SNAPSHOT", "REDSHIFT_DATA_SHARE", "API_GATEWAY_API", "S3_DATA_ACCESS", "LAKE_FORMATION_DATA_PERMISSION"
resp.created_at #=> Time
resp.data_set_id #=> String
resp.id #=> String
resp.name #=> String
resp.revision_id #=> String
resp.source_id #=> String
resp.updated_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :asset_id (required, String) —

  The unique identifier for an asset.

• :data_set_id (required, String) —

  The unique identifier for a data set.

• :revision_id (required, String) —

  The unique identifier for a revision.

Returns:

• (Types::GetAssetResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String
  • #asset_details => Types::AssetDetails
  • #asset_type => String
  • #created_at => Time
  • #data_set_id => String
  • #id => String
  • #name => String
  • #revision_id => String
  • #source_id => String
  • #updated_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1283

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

#get_data_grant(params = {}) ⇒ Types::GetDataGrantResponse

This operation returns information about a data grant.

Examples:

Request syntax with placeholder values

resp = client.get_data_grant({
  data_grant_id: "DataGrantId", # required
})

Response structure

resp.name #=> String
resp.sender_principal #=> String
resp.receiver_principal #=> String
resp.description #=> String
resp.acceptance_state #=> String, one of "PENDING_RECEIVER_ACCEPTANCE", "ACCEPTED"
resp.accepted_at #=> Time
resp.ends_at #=> Time
resp.grant_distribution_scope #=> String, one of "AWS_ORGANIZATION", "NONE"
resp.data_set_id #=> String
resp.source_data_set_id #=> String
resp.id #=> String
resp.arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

  ({})

Options Hash (params):

• :data_grant_id (required, String) —

  The ID of the data grant.

Returns:

• (Types::GetDataGrantResponse) —

  Returns a response object which responds to the following methods:

  • #name => String
  • #sender_principal => String
  • #receiver_principal => String
  • #description => String
  • #acceptance_state => String
  • #accepted_at => Time
  • #ends_at => Time
  • #grant_distribution_scope => String
  • #data_set_id => String
  • #source_data_set_id => String
  • #id => String
  • #arn => String
  • #created_at => Time
  • #updated_at => Time
  • #tags => Hash<String,String>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1340

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

#get_data_set(params = {}) ⇒ Types::GetDataSetResponse

This operation returns information about a data set.

Examples:

Request syntax with placeholder values

resp = client.get_data_set({
  data_set_id: "Id", # required
})

Response structure

resp.arn #=> String
resp.asset_type #=> String, one of "S3_SNAPSHOT", "REDSHIFT_DATA_SHARE", "API_GATEWAY_API", "S3_DATA_ACCESS", "LAKE_FORMATION_DATA_PERMISSION"
resp.created_at #=> Time
resp.description #=> String
resp.id #=> String
resp.name #=> String
resp.origin #=> String, one of "OWNED", "ENTITLED"
resp.origin_details.product_id #=> String
resp.origin_details.data_grant_id #=> String
resp.source_id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.updated_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :data_set_id (required, String) —

  The unique identifier for a data set.

Returns:

• (Types::GetDataSetResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String
  • #asset_type => String
  • #created_at => Time
  • #description => String
  • #id => String
  • #name => String
  • #origin => String
  • #origin_details => Types::OriginDetails
  • #source_id => String
  • #tags => Hash<String,String>
  • #updated_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1390

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

#get_event_action(params = {}) ⇒ Types::GetEventActionResponse

This operation retrieves information about an event action.

Examples:

Request syntax with placeholder values

resp = client.get_event_action({
  event_action_id: "__string", # required
})

Response structure

resp.action.export_revision_to_s3.encryption.kms_key_arn #=> String
resp.action.export_revision_to_s3.encryption.type #=> String, one of "aws:kms", "AES256"
resp.action.export_revision_to_s3.revision_destination.bucket #=> String
resp.action.export_revision_to_s3.revision_destination.key_pattern #=> String
resp.arn #=> String
resp.created_at #=> Time
resp.event.revision_published.data_set_id #=> String
resp.id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.updated_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :event_action_id (required, String) —

  The unique identifier for the event action.

Returns:

• (Types::GetEventActionResponse) —

  Returns a response object which responds to the following methods:

  • #action => Types::Action
  • #arn => String
  • #created_at => Time
  • #event => Types::Event
  • #id => String
  • #tags => Hash<String,String>
  • #updated_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1434

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

#get_job(params = {}) ⇒ Types::GetJobResponse

This operation returns information about a job.

Examples:

Request syntax with placeholder values

resp = client.get_job({
  job_id: "Id", # required
})

Response structure

resp.arn #=> String
resp.created_at #=> Time
resp.details.export_asset_to_signed_url.asset_id #=> String
resp.details.export_asset_to_signed_url.data_set_id #=> String
resp.details.export_asset_to_signed_url.revision_id #=> String
resp.details.export_asset_to_signed_url.signed_url #=> String
resp.details.export_asset_to_signed_url.signed_url_expires_at #=> Time
resp.details.export_assets_to_s3.asset_destinations #=> Array
resp.details.export_assets_to_s3.asset_destinations[0].asset_id #=> String
resp.details.export_assets_to_s3.asset_destinations[0].bucket #=> String
resp.details.export_assets_to_s3.asset_destinations[0].key #=> String
resp.details.export_assets_to_s3.data_set_id #=> String
resp.details.export_assets_to_s3.encryption.kms_key_arn #=> String
resp.details.export_assets_to_s3.encryption.type #=> String, one of "aws:kms", "AES256"
resp.details.export_assets_to_s3.revision_id #=> String
resp.details.export_revisions_to_s3.data_set_id #=> String
resp.details.export_revisions_to_s3.encryption.kms_key_arn #=> String
resp.details.export_revisions_to_s3.encryption.type #=> String, one of "aws:kms", "AES256"
resp.details.export_revisions_to_s3.revision_destinations #=> Array
resp.details.export_revisions_to_s3.revision_destinations[0].bucket #=> String
resp.details.export_revisions_to_s3.revision_destinations[0].key_pattern #=> String
resp.details.export_revisions_to_s3.revision_destinations[0].revision_id #=> String
resp.details.export_revisions_to_s3.event_action_arn #=> String
resp.details.import_asset_from_signed_url.asset_name #=> String
resp.details.import_asset_from_signed_url.data_set_id #=> String
resp.details.import_asset_from_signed_url.md_5_hash #=> String
resp.details.import_asset_from_signed_url.revision_id #=> String
resp.details.import_asset_from_signed_url.signed_url #=> String
resp.details.import_asset_from_signed_url.signed_url_expires_at #=> Time
resp.details.import_assets_from_s3.asset_sources #=> Array
resp.details.import_assets_from_s3.asset_sources[0].bucket #=> String
resp.details.import_assets_from_s3.asset_sources[0].key #=> String
resp.details.import_assets_from_s3.data_set_id #=> String
resp.details.import_assets_from_s3.revision_id #=> String
resp.details.import_assets_from_redshift_data_shares.asset_sources #=> Array
resp.details.import_assets_from_redshift_data_shares.asset_sources[0].data_share_arn #=> String
resp.details.import_assets_from_redshift_data_shares.data_set_id #=> String
resp.details.import_assets_from_redshift_data_shares.revision_id #=> String
resp.details.import_asset_from_api_gateway_api.api_description #=> String
resp.details.import_asset_from_api_gateway_api.api_id #=> String
resp.details.import_asset_from_api_gateway_api.api_key #=> String
resp.details.import_asset_from_api_gateway_api.api_name #=> String
resp.details.import_asset_from_api_gateway_api.api_specification_md_5_hash #=> String
resp.details.import_asset_from_api_gateway_api.api_specification_upload_url #=> String
resp.details.import_asset_from_api_gateway_api.api_specification_upload_url_expires_at #=> Time
resp.details.import_asset_from_api_gateway_api.data_set_id #=> String
resp.details.import_asset_from_api_gateway_api.protocol_type #=> String, one of "REST"
resp.details.import_asset_from_api_gateway_api.revision_id #=> String
resp.details.import_asset_from_api_gateway_api.stage #=> String
resp.details.create_s3_data_access_from_s3_bucket.asset_source.bucket #=> String
resp.details.create_s3_data_access_from_s3_bucket.asset_source.key_prefixes #=> Array
resp.details.create_s3_data_access_from_s3_bucket.asset_source.key_prefixes[0] #=> String
resp.details.create_s3_data_access_from_s3_bucket.asset_source.keys #=> Array
resp.details.create_s3_data_access_from_s3_bucket.asset_source.keys[0] #=> String
resp.details.create_s3_data_access_from_s3_bucket.asset_source.kms_keys_to_grant #=> Array
resp.details.create_s3_data_access_from_s3_bucket.asset_source.kms_keys_to_grant[0].kms_key_arn #=> String
resp.details.create_s3_data_access_from_s3_bucket.data_set_id #=> String
resp.details.create_s3_data_access_from_s3_bucket.revision_id #=> String
resp.details.import_assets_from_lake_formation_tag_policy.catalog_id #=> String
resp.details.import_assets_from_lake_formation_tag_policy.database.expression #=> Array
resp.details.import_assets_from_lake_formation_tag_policy.database.expression[0].tag_key #=> String
resp.details.import_assets_from_lake_formation_tag_policy.database.expression[0].tag_values #=> Array
resp.details.import_assets_from_lake_formation_tag_policy.database.expression[0].tag_values[0] #=> String
resp.details.import_assets_from_lake_formation_tag_policy.database.permissions #=> Array
resp.details.import_assets_from_lake_formation_tag_policy.database.permissions[0] #=> String, one of "DESCRIBE"
resp.details.import_assets_from_lake_formation_tag_policy.table.expression #=> Array
resp.details.import_assets_from_lake_formation_tag_policy.table.expression[0].tag_key #=> String
resp.details.import_assets_from_lake_formation_tag_policy.table.expression[0].tag_values #=> Array
resp.details.import_assets_from_lake_formation_tag_policy.table.expression[0].tag_values[0] #=> String
resp.details.import_assets_from_lake_formation_tag_policy.table.permissions #=> Array
resp.details.import_assets_from_lake_formation_tag_policy.table.permissions[0] #=> String, one of "DESCRIBE", "SELECT"
resp.details.import_assets_from_lake_formation_tag_policy.role_arn #=> String
resp.details.import_assets_from_lake_formation_tag_policy.data_set_id #=> String
resp.details.import_assets_from_lake_formation_tag_policy.revision_id #=> String
resp.errors #=> Array
resp.errors[0].code #=> String, one of "ACCESS_DENIED_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "MALWARE_DETECTED", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "VALIDATION_EXCEPTION", "MALWARE_SCAN_ENCRYPTED_FILE"
resp.errors[0].details.import_asset_from_signed_url_job_error_details.asset_name #=> String
resp.errors[0].details.import_assets_from_s3_job_error_details #=> Array
resp.errors[0].details.import_assets_from_s3_job_error_details[0].bucket #=> String
resp.errors[0].details.import_assets_from_s3_job_error_details[0].key #=> String
resp.errors[0].limit_name #=> String, one of "Assets per revision", "Asset size in GB", "Amazon Redshift datashare assets per revision", "AWS Lake Formation data permission assets per revision", "Amazon S3 data access assets per revision"
resp.errors[0].limit_value #=> Float
resp.errors[0].message #=> String
resp.errors[0].resource_id #=> String
resp.errors[0].resource_type #=> String, one of "REVISION", "ASSET", "DATA_SET"
resp.id #=> String
resp.state #=> String, one of "WAITING", "IN_PROGRESS", "ERROR", "COMPLETED", "CANCELLED", "TIMED_OUT"
resp.type #=> String, one of "IMPORT_ASSETS_FROM_S3", "IMPORT_ASSET_FROM_SIGNED_URL", "EXPORT_ASSETS_TO_S3", "EXPORT_ASSET_TO_SIGNED_URL", "EXPORT_REVISIONS_TO_S3", "IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES", "IMPORT_ASSET_FROM_API_GATEWAY_API", "CREATE_S3_DATA_ACCESS_FROM_S3_BUCKET", "IMPORT_ASSETS_FROM_LAKE_FORMATION_TAG_POLICY"
resp.updated_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :job_id (required, String) —

  The unique identifier for a job.

Returns:

• (Types::GetJobResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String
  • #created_at => Time
  • #details => Types::ResponseDetails
  • #errors => Array<Types::JobError>
  • #id => String
  • #state => String
  • #type => String
  • #updated_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1557

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

#get_received_data_grant(params = {}) ⇒ Types::GetReceivedDataGrantResponse

This operation returns information about a received data grant.

Examples:

Request syntax with placeholder values

resp = client.get_received_data_grant({
  data_grant_arn: "DataGrantArn", # required
})

Response structure

resp.name #=> String
resp.sender_principal #=> String
resp.receiver_principal #=> String
resp.description #=> String
resp.acceptance_state #=> String, one of "PENDING_RECEIVER_ACCEPTANCE", "ACCEPTED"
resp.accepted_at #=> Time
resp.ends_at #=> Time
resp.grant_distribution_scope #=> String, one of "AWS_ORGANIZATION", "NONE"
resp.data_set_id #=> String
resp.id #=> String
resp.arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :data_grant_arn (required, String) —

  The Amazon Resource Name (ARN) of the data grant.

Returns:

• (Types::GetReceivedDataGrantResponse) —

  Returns a response object which responds to the following methods:

  • #name => String
  • #sender_principal => String
  • #receiver_principal => String
  • #description => String
  • #acceptance_state => String
  • #accepted_at => Time
  • #ends_at => Time
  • #grant_distribution_scope => String
  • #data_set_id => String
  • #id => String
  • #arn => String
  • #created_at => Time
  • #updated_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1609

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

#get_revision(params = {}) ⇒ Types::GetRevisionResponse

This operation returns information about a revision.

Examples:

Request syntax with placeholder values

resp = client.get_revision({
  data_set_id: "Id", # required
  revision_id: "Id", # required
})

Response structure

resp.arn #=> String
resp.comment #=> String
resp.created_at #=> Time
resp.data_set_id #=> String
resp.finalized #=> Boolean
resp.id #=> String
resp.source_id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.updated_at #=> Time
resp.revocation_comment #=> String
resp.revoked #=> Boolean
resp.revoked_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :data_set_id (required, String) —

  The unique identifier for a data set.

• :revision_id (required, String) —

  The unique identifier for a revision.

Returns:

• (Types::GetRevisionResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String
  • #comment => String
  • #created_at => Time
  • #data_set_id => String
  • #finalized => Boolean
  • #id => String
  • #source_id => String
  • #tags => Hash<String,String>
  • #updated_at => Time
  • #revocation_comment => String
  • #revoked => Boolean
  • #revoked_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1664

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

#list_data_grants(params = {}) ⇒ Types::ListDataGrantsResponse

This operation returns information about all data grants.

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

Response structure

resp.data_grant_summaries #=> Array
resp.data_grant_summaries[0].name #=> String
resp.data_grant_summaries[0].sender_principal #=> String
resp.data_grant_summaries[0].receiver_principal #=> String
resp.data_grant_summaries[0].acceptance_state #=> String, one of "PENDING_RECEIVER_ACCEPTANCE", "ACCEPTED"
resp.data_grant_summaries[0].accepted_at #=> Time
resp.data_grant_summaries[0].ends_at #=> Time
resp.data_grant_summaries[0].data_set_id #=> String
resp.data_grant_summaries[0].source_data_set_id #=> String
resp.data_grant_summaries[0].id #=> String
resp.data_grant_summaries[0].arn #=> String
resp.data_grant_summaries[0].created_at #=> Time
resp.data_grant_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

  ({})

Options Hash (params):

• :max_results (Integer) —

  The maximum number of results to be included in the next page.

• :next_token (String) —

  The pagination token used to retrieve the next page of results for this operation.

Returns:

• (Types::ListDataGrantsResponse) —

  Returns a response object which responds to the following methods:

  • #data_grant_summaries => Array<Types::DataGrantSummaryEntry>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1713

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

#list_data_set_revisions(params = {}) ⇒ Types::ListDataSetRevisionsResponse

This operation lists a data set's revisions sorted by CreatedAt in descending order.

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_data_set_revisions({
  data_set_id: "Id", # required
  max_results: 1,
  next_token: "__string",
})

Response structure

resp.next_token #=> String
resp.revisions #=> Array
resp.revisions[0].arn #=> String
resp.revisions[0].comment #=> String
resp.revisions[0].created_at #=> Time
resp.revisions[0].data_set_id #=> String
resp.revisions[0].finalized #=> Boolean
resp.revisions[0].id #=> String
resp.revisions[0].source_id #=> String
resp.revisions[0].updated_at #=> Time
resp.revisions[0].revocation_comment #=> String
resp.revisions[0].revoked #=> Boolean
resp.revisions[0].revoked_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :data_set_id (required, String) —

  The unique identifier for a data set.

• :max_results (Integer) —

  The maximum number of results returned by a single call.

• :next_token (String) —

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

Returns:

• (Types::ListDataSetRevisionsResponse) —

  Returns a response object which responds to the following methods:

  • #next_token => String
  • #revisions => Array<Types::RevisionEntry>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1766

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

#list_data_sets(params = {}) ⇒ Types::ListDataSetsResponse

This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order.

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_data_sets({
  max_results: 1,
  next_token: "__string",
  origin: "__string",
})

Response structure

resp.data_sets #=> Array
resp.data_sets[0].arn #=> String
resp.data_sets[0].asset_type #=> String, one of "S3_SNAPSHOT", "REDSHIFT_DATA_SHARE", "API_GATEWAY_API", "S3_DATA_ACCESS", "LAKE_FORMATION_DATA_PERMISSION"
resp.data_sets[0].created_at #=> Time
resp.data_sets[0].description #=> String
resp.data_sets[0].id #=> String
resp.data_sets[0].name #=> String
resp.data_sets[0].origin #=> String, one of "OWNED", "ENTITLED"
resp.data_sets[0].origin_details.product_id #=> String
resp.data_sets[0].origin_details.data_grant_id #=> String
resp.data_sets[0].source_id #=> String
resp.data_sets[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

  ({})

Options Hash (params):

• :max_results (Integer) —

  The maximum number of results returned by a single call.

• :next_token (String) —

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

• :origin (String) —

  A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

Returns:

• (Types::ListDataSetsResponse) —

  Returns a response object which responds to the following methods:

  • #data_sets => Array<Types::DataSetEntry>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1821

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

#list_event_actions(params = {}) ⇒ Types::ListEventActionsResponse

This operation lists your event actions.

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_event_actions({
  event_source_id: "__string",
  max_results: 1,
  next_token: "__string",
})

Response structure

resp.event_actions #=> Array
resp.event_actions[0].action.export_revision_to_s3.encryption.kms_key_arn #=> String
resp.event_actions[0].action.export_revision_to_s3.encryption.type #=> String, one of "aws:kms", "AES256"
resp.event_actions[0].action.export_revision_to_s3.revision_destination.bucket #=> String
resp.event_actions[0].action.export_revision_to_s3.revision_destination.key_pattern #=> String
resp.event_actions[0].arn #=> String
resp.event_actions[0].created_at #=> Time
resp.event_actions[0].event.revision_published.data_set_id #=> String
resp.event_actions[0].id #=> String
resp.event_actions[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

  ({})

Options Hash (params):

• :event_source_id (String) —

  The unique identifier for the event source.

• :max_results (Integer) —

  The maximum number of results returned by a single call.

• :next_token (String) —

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

Returns:

• (Types::ListEventActionsResponse) —

  Returns a response object which responds to the following methods:

  • #event_actions => Array<Types::EventActionEntry>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1871

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

#list_jobs(params = {}) ⇒ Types::ListJobsResponse

This operation lists your jobs sorted by CreatedAt in descending order.

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_jobs({
  data_set_id: "__string",
  max_results: 1,
  next_token: "__string",
  revision_id: "__string",
})

Response structure

resp.jobs #=> Array
resp.jobs[0].arn #=> String
resp.jobs[0].created_at #=> Time
resp.jobs[0].details.export_asset_to_signed_url.asset_id #=> String
resp.jobs[0].details.export_asset_to_signed_url.data_set_id #=> String
resp.jobs[0].details.export_asset_to_signed_url.revision_id #=> String
resp.jobs[0].details.export_asset_to_signed_url.signed_url #=> String
resp.jobs[0].details.export_asset_to_signed_url.signed_url_expires_at #=> Time
resp.jobs[0].details.export_assets_to_s3.asset_destinations #=> Array
resp.jobs[0].details.export_assets_to_s3.asset_destinations[0].asset_id #=> String
resp.jobs[0].details.export_assets_to_s3.asset_destinations[0].bucket #=> String
resp.jobs[0].details.export_assets_to_s3.asset_destinations[0].key #=> String
resp.jobs[0].details.export_assets_to_s3.data_set_id #=> String
resp.jobs[0].details.export_assets_to_s3.encryption.kms_key_arn #=> String
resp.jobs[0].details.export_assets_to_s3.encryption.type #=> String, one of "aws:kms", "AES256"
resp.jobs[0].details.export_assets_to_s3.revision_id #=> String
resp.jobs[0].details.export_revisions_to_s3.data_set_id #=> String
resp.jobs[0].details.export_revisions_to_s3.encryption.kms_key_arn #=> String
resp.jobs[0].details.export_revisions_to_s3.encryption.type #=> String, one of "aws:kms", "AES256"
resp.jobs[0].details.export_revisions_to_s3.revision_destinations #=> Array
resp.jobs[0].details.export_revisions_to_s3.revision_destinations[0].bucket #=> String
resp.jobs[0].details.export_revisions_to_s3.revision_destinations[0].key_pattern #=> String
resp.jobs[0].details.export_revisions_to_s3.revision_destinations[0].revision_id #=> String
resp.jobs[0].details.export_revisions_to_s3.event_action_arn #=> String
resp.jobs[0].details.import_asset_from_signed_url.asset_name #=> String
resp.jobs[0].details.import_asset_from_signed_url.data_set_id #=> String
resp.jobs[0].details.import_asset_from_signed_url.md_5_hash #=> String
resp.jobs[0].details.import_asset_from_signed_url.revision_id #=> String
resp.jobs[0].details.import_asset_from_signed_url.signed_url #=> String
resp.jobs[0].details.import_asset_from_signed_url.signed_url_expires_at #=> Time
resp.jobs[0].details.import_assets_from_s3.asset_sources #=> Array
resp.jobs[0].details.import_assets_from_s3.asset_sources[0].bucket #=> String
resp.jobs[0].details.import_assets_from_s3.asset_sources[0].key #=> String
resp.jobs[0].details.import_assets_from_s3.data_set_id #=> String
resp.jobs[0].details.import_assets_from_s3.revision_id #=> String
resp.jobs[0].details.import_assets_from_redshift_data_shares.asset_sources #=> Array
resp.jobs[0].details.import_assets_from_redshift_data_shares.asset_sources[0].data_share_arn #=> String
resp.jobs[0].details.import_assets_from_redshift_data_shares.data_set_id #=> String
resp.jobs[0].details.import_assets_from_redshift_data_shares.revision_id #=> String
resp.jobs[0].details.import_asset_from_api_gateway_api.api_description #=> String
resp.jobs[0].details.import_asset_from_api_gateway_api.api_id #=> String
resp.jobs[0].details.import_asset_from_api_gateway_api.api_key #=> String
resp.jobs[0].details.import_asset_from_api_gateway_api.api_name #=> String
resp.jobs[0].details.import_asset_from_api_gateway_api.api_specification_md_5_hash #=> String
resp.jobs[0].details.import_asset_from_api_gateway_api.api_specification_upload_url #=> String
resp.jobs[0].details.import_asset_from_api_gateway_api.api_specification_upload_url_expires_at #=> Time
resp.jobs[0].details.import_asset_from_api_gateway_api.data_set_id #=> String
resp.jobs[0].details.import_asset_from_api_gateway_api.protocol_type #=> String, one of "REST"
resp.jobs[0].details.import_asset_from_api_gateway_api.revision_id #=> String
resp.jobs[0].details.import_asset_from_api_gateway_api.stage #=> String
resp.jobs[0].details.create_s3_data_access_from_s3_bucket.asset_source.bucket #=> String
resp.jobs[0].details.create_s3_data_access_from_s3_bucket.asset_source.key_prefixes #=> Array
resp.jobs[0].details.create_s3_data_access_from_s3_bucket.asset_source.key_prefixes[0] #=> String
resp.jobs[0].details.create_s3_data_access_from_s3_bucket.asset_source.keys #=> Array
resp.jobs[0].details.create_s3_data_access_from_s3_bucket.asset_source.keys[0] #=> String
resp.jobs[0].details.create_s3_data_access_from_s3_bucket.asset_source.kms_keys_to_grant #=> Array
resp.jobs[0].details.create_s3_data_access_from_s3_bucket.asset_source.kms_keys_to_grant[0].kms_key_arn #=> String
resp.jobs[0].details.create_s3_data_access_from_s3_bucket.data_set_id #=> String
resp.jobs[0].details.create_s3_data_access_from_s3_bucket.revision_id #=> String
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.catalog_id #=> String
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.database.expression #=> Array
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.database.expression[0].tag_key #=> String
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.database.expression[0].tag_values #=> Array
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.database.expression[0].tag_values[0] #=> String
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.database.permissions #=> Array
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.database.permissions[0] #=> String, one of "DESCRIBE"
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.table.expression #=> Array
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.table.expression[0].tag_key #=> String
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.table.expression[0].tag_values #=> Array
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.table.expression[0].tag_values[0] #=> String
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.table.permissions #=> Array
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.table.permissions[0] #=> String, one of "DESCRIBE", "SELECT"
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.role_arn #=> String
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.data_set_id #=> String
resp.jobs[0].details.import_assets_from_lake_formation_tag_policy.revision_id #=> String
resp.jobs[0].errors #=> Array
resp.jobs[0].errors[0].code #=> String, one of "ACCESS_DENIED_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "MALWARE_DETECTED", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "VALIDATION_EXCEPTION", "MALWARE_SCAN_ENCRYPTED_FILE"
resp.jobs[0].errors[0].details.import_asset_from_signed_url_job_error_details.asset_name #=> String
resp.jobs[0].errors[0].details.import_assets_from_s3_job_error_details #=> Array
resp.jobs[0].errors[0].details.import_assets_from_s3_job_error_details[0].bucket #=> String
resp.jobs[0].errors[0].details.import_assets_from_s3_job_error_details[0].key #=> String
resp.jobs[0].errors[0].limit_name #=> String, one of "Assets per revision", "Asset size in GB", "Amazon Redshift datashare assets per revision", "AWS Lake Formation data permission assets per revision", "Amazon S3 data access assets per revision"
resp.jobs[0].errors[0].limit_value #=> Float
resp.jobs[0].errors[0].message #=> String
resp.jobs[0].errors[0].resource_id #=> String
resp.jobs[0].errors[0].resource_type #=> String, one of "REVISION", "ASSET", "DATA_SET"
resp.jobs[0].id #=> String
resp.jobs[0].state #=> String, one of "WAITING", "IN_PROGRESS", "ERROR", "COMPLETED", "CANCELLED", "TIMED_OUT"
resp.jobs[0].type #=> String, one of "IMPORT_ASSETS_FROM_S3", "IMPORT_ASSET_FROM_SIGNED_URL", "EXPORT_ASSETS_TO_S3", "EXPORT_ASSET_TO_SIGNED_URL", "EXPORT_REVISIONS_TO_S3", "IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES", "IMPORT_ASSET_FROM_API_GATEWAY_API", "CREATE_S3_DATA_ACCESS_FROM_S3_BUCKET", "IMPORT_ASSETS_FROM_LAKE_FORMATION_TAG_POLICY"
resp.jobs[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

  ({})

Options Hash (params):

• :data_set_id (String) —

  The unique identifier for a data set.

• :max_results (Integer) —

  The maximum number of results returned by a single call.

• :next_token (String) —

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

• :revision_id (String) —

  The unique identifier for a revision.

Returns:

• (Types::ListJobsResponse) —

  Returns a response object which responds to the following methods:

  • #jobs => Array<Types::JobEntry>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2006

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

#list_received_data_grants(params = {}) ⇒ Types::ListReceivedDataGrantsResponse

This operation returns information about all received data grants.

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_received_data_grants({
  max_results: 1,
  next_token: "__string",
  acceptance_state: ["PENDING_RECEIVER_ACCEPTANCE"], # accepts PENDING_RECEIVER_ACCEPTANCE, ACCEPTED
})

Response structure

resp.data_grant_summaries #=> Array
resp.data_grant_summaries[0].name #=> String
resp.data_grant_summaries[0].sender_principal #=> String
resp.data_grant_summaries[0].receiver_principal #=> String
resp.data_grant_summaries[0].acceptance_state #=> String, one of "PENDING_RECEIVER_ACCEPTANCE", "ACCEPTED"
resp.data_grant_summaries[0].accepted_at #=> Time
resp.data_grant_summaries[0].ends_at #=> Time
resp.data_grant_summaries[0].data_set_id #=> String
resp.data_grant_summaries[0].id #=> String
resp.data_grant_summaries[0].arn #=> String
resp.data_grant_summaries[0].created_at #=> Time
resp.data_grant_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

  ({})

Options Hash (params):

• :max_results (Integer) —

  The maximum number of results to be included in the next page.

• :next_token (String) —

  The pagination token used to retrieve the next page of results for this operation.

• :acceptance_state (Array<String>) —

  The acceptance state of the data grants to list.

Returns:

• (Types::ListReceivedDataGrantsResponse) —

  Returns a response object which responds to the following methods:

  • #data_grant_summaries => Array<Types::ReceivedDataGrantSummariesEntry>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2058

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

#list_revision_assets(params = {}) ⇒ Types::ListRevisionAssetsResponse

This operation lists a revision's assets sorted alphabetically in descending order.

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_revision_assets({
  data_set_id: "Id", # required
  max_results: 1,
  next_token: "__string",
  revision_id: "Id", # required
})

Response structure

resp.assets #=> Array
resp.assets[0].arn #=> String
resp.assets[0].asset_details.s3_snapshot_asset.size #=> Float
resp.assets[0].asset_details.redshift_data_share_asset.arn #=> String
resp.assets[0].asset_details.api_gateway_api_asset.api_description #=> String
resp.assets[0].asset_details.api_gateway_api_asset.api_endpoint #=> String
resp.assets[0].asset_details.api_gateway_api_asset.api_id #=> String
resp.assets[0].asset_details.api_gateway_api_asset.api_key #=> String
resp.assets[0].asset_details.api_gateway_api_asset.api_name #=> String
resp.assets[0].asset_details.api_gateway_api_asset.api_specification_download_url #=> String
resp.assets[0].asset_details.api_gateway_api_asset.api_specification_download_url_expires_at #=> Time
resp.assets[0].asset_details.api_gateway_api_asset.protocol_type #=> String, one of "REST"
resp.assets[0].asset_details.api_gateway_api_asset.stage #=> String
resp.assets[0].asset_details.s3_data_access_asset.bucket #=> String
resp.assets[0].asset_details.s3_data_access_asset.key_prefixes #=> Array
resp.assets[0].asset_details.s3_data_access_asset.key_prefixes[0] #=> String
resp.assets[0].asset_details.s3_data_access_asset.keys #=> Array
resp.assets[0].asset_details.s3_data_access_asset.keys[0] #=> String
resp.assets[0].asset_details.s3_data_access_asset.s3_access_point_alias #=> String
resp.assets[0].asset_details.s3_data_access_asset.s3_access_point_arn #=> String
resp.assets[0].asset_details.s3_data_access_asset.kms_keys_to_grant #=> Array
resp.assets[0].asset_details.s3_data_access_asset.kms_keys_to_grant[0].kms_key_arn #=> String
resp.assets[0].asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.catalog_id #=> String
resp.assets[0].asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_type #=> String, one of "TABLE", "DATABASE"
resp.assets[0].asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.database.expression #=> Array
resp.assets[0].asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.database.expression[0].tag_key #=> String
resp.assets[0].asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.database.expression[0].tag_values #=> Array
resp.assets[0].asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.database.expression[0].tag_values[0] #=> String
resp.assets[0].asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.table.expression #=> Array
resp.assets[0].asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.table.expression[0].tag_key #=> String
resp.assets[0].asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.table.expression[0].tag_values #=> Array
resp.assets[0].asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.table.expression[0].tag_values[0] #=> String
resp.assets[0].asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_type #=> String, one of "LFTagPolicy"
resp.assets[0].asset_details.lake_formation_data_permission_asset.permissions #=> Array
resp.assets[0].asset_details.lake_formation_data_permission_asset.permissions[0] #=> String, one of "DESCRIBE", "SELECT"
resp.assets[0].asset_details.lake_formation_data_permission_asset.role_arn #=> String
resp.assets[0].asset_type #=> String, one of "S3_SNAPSHOT", "REDSHIFT_DATA_SHARE", "API_GATEWAY_API", "S3_DATA_ACCESS", "LAKE_FORMATION_DATA_PERMISSION"
resp.assets[0].created_at #=> Time
resp.assets[0].data_set_id #=> String
resp.assets[0].id #=> String
resp.assets[0].name #=> String
resp.assets[0].revision_id #=> String
resp.assets[0].source_id #=> String
resp.assets[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

  ({})

Options Hash (params):

• :data_set_id (required, String) —

  The unique identifier for a data set.

• :max_results (Integer) —

  The maximum number of results returned by a single call.

• :next_token (String) —

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

• :revision_id (required, String) —

  The unique identifier for a revision.

Returns:

• (Types::ListRevisionAssetsResponse) —

  Returns a response object which responds to the following methods:

  • #assets => Array<Types::AssetEntry>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2147

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

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

This operation lists the tags on the resource.

Examples:

Request syntax with placeholder values

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

Response structure

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

Parameters:

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

  ({})

Options Hash (params):

• :resource_arn (required, String) —

  An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

Returns:

• (Types::ListTagsForResourceResponse) —

  Returns a response object which responds to the following methods:

  • #tags => Hash<String,String>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2177

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

#revoke_revision(params = {}) ⇒ Types::RevokeRevisionResponse

This operation revokes subscribers' access to a revision.

Examples:

Request syntax with placeholder values

resp = client.revoke_revision({
  data_set_id: "Id", # required
  revision_id: "Id", # required
  revocation_comment: "__stringMin10Max512", # required
})

Response structure

resp.arn #=> String
resp.comment #=> String
resp.created_at #=> Time
resp.data_set_id #=> String
resp.finalized #=> Boolean
resp.id #=> String
resp.source_id #=> String
resp.updated_at #=> Time
resp.revocation_comment #=> String
resp.revoked #=> Boolean
resp.revoked_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :data_set_id (required, String) —

  The unique identifier for a data set.

• :revision_id (required, String) —

  The unique identifier for a revision.

• :revocation_comment (required, String) —

  A required comment to inform subscribers of the reason their access to the revision was revoked.

Returns:

• (Types::RevokeRevisionResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String
  • #comment => String
  • #created_at => Time
  • #data_set_id => String
  • #finalized => Boolean
  • #id => String
  • #source_id => String
  • #updated_at => Time
  • #revocation_comment => String
  • #revoked => Boolean
  • #revoked_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2234

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

#send_api_asset(params = {}) ⇒ Types::SendApiAssetResponse

This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.

Examples:

Request syntax with placeholder values

resp = client.send_api_asset({
  body: "__string",
  query_string_parameters: {
    "__string" => "__string",
  },
  asset_id: "__string", # required
  data_set_id: "__string", # required
  request_headers: {
    "__string" => "__string",
  },
  method: "__string",
  path: "__string",
  revision_id: "__string", # required
})

Response structure

resp.body #=> String
resp.response_headers #=> Hash
resp.response_headers["__string"] #=> String

Parameters:

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

  ({})

Options Hash (params):

• :body (String) —

  The request body.

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

  Attach query string parameters to the end of the URI (for example, /v1/examplePath?exampleParam=exampleValue).

• :asset_id (required, String) —

  Asset ID value for the API request.

• :data_set_id (required, String) —

  Data set ID value for the API request.

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

  Any header value prefixed with x-amzn-dataexchange-header- will have that stripped before sending the Asset API request. Use this when you want to override a header that AWS Data Exchange uses. Alternatively, you can use the header without a prefix to the HTTP request.

• :method (String) —

  HTTP method value for the API request. Alternatively, you can use the appropriate verb in your request.

• :path (String) —

  URI path value for the API request. Alternatively, you can set the URI path directly by invoking /v1/pathValue.

• :revision_id (required, String) —

  Revision ID value for the API request.

Returns:

• (Types::SendApiAssetResponse) —

  Returns a response object which responds to the following methods:

  • #body => String
  • #response_headers => Hash<String,String>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2304

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

#send_data_set_notification(params = {}) ⇒ Struct

The type of event associated with the data set.

Examples:

Request syntax with placeholder values

resp = client.send_data_set_notification({
  scope: {
    lake_formation_tag_policies: [
      {
        database: "__string",
        table: "__string",
      },
    ],
    redshift_data_shares: [
      {
        arn: "__string", # required
        database: "__string", # required
        function: "__string",
        table: "__string",
        schema: "__string",
        view: "__string",
      },
    ],
    s3_data_accesses: [
      {
        key_prefixes: ["__string"],
        keys: ["__string"],
      },
    ],
  },
  client_token: "ClientToken",
  comment: "__stringMin0Max4096",
  data_set_id: "Id", # required
  details: {
    data_update: {
      data_updated_at: Time.now,
    },
    deprecation: {
      deprecation_at: Time.now, # required
    },
    schema_change: {
      changes: [
        {
          name: "__string", # required
          type: "ADD", # required, accepts ADD, REMOVE, MODIFY
          description: "__string",
        },
      ],
      schema_change_at: Time.now, # required
    },
  },
  type: "DATA_DELAY", # required, accepts DATA_DELAY, DATA_UPDATE, DEPRECATION, SCHEMA_CHANGE
})

Parameters:

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

  ({})

Options Hash (params):

• :scope (Types::ScopeDetails) —

  Affected scope of this notification such as the underlying resources affected by the notification event.

• :client_token (String) —

  Idempotency key for the notification, this key allows us to deduplicate notifications that are sent in quick succession erroneously.

  A suitable default value is auto-generated. You should normally not need to pass this option.**

• :comment (String) —

  Free-form text field for providers to add information about their notifications.

• :data_set_id (required, String) —

  Affected data set of the notification.

• :details (Types::NotificationDetails) —

  Extra details specific to this notification type.

• :type (required, String) —

  The type of the notification. Describing the kind of event the notification is alerting you to.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2394

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

#start_job(params = {}) ⇒ Struct

This operation starts a job.

Examples:

Request syntax with placeholder values

resp = client.start_job({
  job_id: "Id", # required
})

Parameters:

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

  ({})

Options Hash (params):

• :job_id (required, String) —

  The unique identifier for a job.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2416

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

#tag_resource(params = {}) ⇒ Struct

This operation tags a resource.

Examples:

Request syntax with placeholder values

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

Parameters:

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

  ({})

Options Hash (params):

• :resource_arn (required, String) —

  An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

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

  A label that consists of a customer-defined key and an optional value.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2445

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

#untag_resource(params = {}) ⇒ Struct

This operation removes one or more tags from a resource.

Examples:

Request syntax with placeholder values

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

Parameters:

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

  ({})

Options Hash (params):

• :resource_arn (required, String) —

  An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

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

  The key tags.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2472

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

#update_asset(params = {}) ⇒ Types::UpdateAssetResponse

This operation updates an asset.

Examples:

Request syntax with placeholder values

resp = client.update_asset({
  asset_id: "Id", # required
  data_set_id: "Id", # required
  name: "AssetName", # required
  revision_id: "Id", # required
})

Response structure

resp.arn #=> String
resp.asset_details.s3_snapshot_asset.size #=> Float
resp.asset_details.redshift_data_share_asset.arn #=> String
resp.asset_details.api_gateway_api_asset.api_description #=> String
resp.asset_details.api_gateway_api_asset.api_endpoint #=> String
resp.asset_details.api_gateway_api_asset.api_id #=> String
resp.asset_details.api_gateway_api_asset.api_key #=> String
resp.asset_details.api_gateway_api_asset.api_name #=> String
resp.asset_details.api_gateway_api_asset.api_specification_download_url #=> String
resp.asset_details.api_gateway_api_asset.api_specification_download_url_expires_at #=> Time
resp.asset_details.api_gateway_api_asset.protocol_type #=> String, one of "REST"
resp.asset_details.api_gateway_api_asset.stage #=> String
resp.asset_details.s3_data_access_asset.bucket #=> String
resp.asset_details.s3_data_access_asset.key_prefixes #=> Array
resp.asset_details.s3_data_access_asset.key_prefixes[0] #=> String
resp.asset_details.s3_data_access_asset.keys #=> Array
resp.asset_details.s3_data_access_asset.keys[0] #=> String
resp.asset_details.s3_data_access_asset.s3_access_point_alias #=> String
resp.asset_details.s3_data_access_asset.s3_access_point_arn #=> String
resp.asset_details.s3_data_access_asset.kms_keys_to_grant #=> Array
resp.asset_details.s3_data_access_asset.kms_keys_to_grant[0].kms_key_arn #=> String
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.catalog_id #=> String
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_type #=> String, one of "TABLE", "DATABASE"
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.database.expression #=> Array
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.database.expression[0].tag_key #=> String
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.database.expression[0].tag_values #=> Array
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.database.expression[0].tag_values[0] #=> String
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.table.expression #=> Array
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.table.expression[0].tag_key #=> String
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.table.expression[0].tag_values #=> Array
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_details.lf_tag_policy.resource_details.table.expression[0].tag_values[0] #=> String
resp.asset_details.lake_formation_data_permission_asset.lake_formation_data_permission_type #=> String, one of "LFTagPolicy"
resp.asset_details.lake_formation_data_permission_asset.permissions #=> Array
resp.asset_details.lake_formation_data_permission_asset.permissions[0] #=> String, one of "DESCRIBE", "SELECT"
resp.asset_details.lake_formation_data_permission_asset.role_arn #=> String
resp.asset_type #=> String, one of "S3_SNAPSHOT", "REDSHIFT_DATA_SHARE", "API_GATEWAY_API", "S3_DATA_ACCESS", "LAKE_FORMATION_DATA_PERMISSION"
resp.created_at #=> Time
resp.data_set_id #=> String
resp.id #=> String
resp.name #=> String
resp.revision_id #=> String
resp.source_id #=> String
resp.updated_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :asset_id (required, String) —

  The unique identifier for an asset.

• :data_set_id (required, String) —

  The unique identifier for a data set.

• :name (required, String) —

  The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name. When importing from AWS Lake Formation, the static values of "Database(s) included in the LF-tag policy" or "Table(s) included in LF-tag policy" are used as the name.

• :revision_id (required, String) —

  The unique identifier for a revision.

Returns:

• (Types::UpdateAssetResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String
  • #asset_details => Types::AssetDetails
  • #asset_type => String
  • #created_at => Time
  • #data_set_id => String
  • #id => String
  • #name => String
  • #revision_id => String
  • #source_id => String
  • #updated_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2570

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

#update_data_set(params = {}) ⇒ Types::UpdateDataSetResponse

This operation updates a data set.

Examples:

Request syntax with placeholder values

resp = client.update_data_set({
  data_set_id: "Id", # required
  description: "Description",
  name: "Name",
})

Response structure

resp.arn #=> String
resp.asset_type #=> String, one of "S3_SNAPSHOT", "REDSHIFT_DATA_SHARE", "API_GATEWAY_API", "S3_DATA_ACCESS", "LAKE_FORMATION_DATA_PERMISSION"
resp.created_at #=> Time
resp.description #=> String
resp.id #=> String
resp.name #=> String
resp.origin #=> String, one of "OWNED", "ENTITLED"
resp.origin_details.product_id #=> String
resp.origin_details.data_grant_id #=> String
resp.source_id #=> String
resp.updated_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :data_set_id (required, String) —

  The unique identifier for a data set.

• :description (String) —

  The description for the data set.

• :name (String) —

  The name of the data set.

Returns:

• (Types::UpdateDataSetResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String
  • #asset_type => String
  • #created_at => Time
  • #description => String
  • #id => String
  • #name => String
  • #origin => String
  • #origin_details => Types::OriginDetails
  • #source_id => String
  • #updated_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2625

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

#update_event_action(params = {}) ⇒ Types::UpdateEventActionResponse

This operation updates the event action.

Examples:

Request syntax with placeholder values

resp = client.update_event_action({
  action: {
    export_revision_to_s3: {
      encryption: {
        kms_key_arn: "__string",
        type: "aws:kms", # required, accepts aws:kms, AES256
      },
      revision_destination: { # required
        bucket: "__string", # required
        key_pattern: "__string",
      },
    },
  },
  event_action_id: "__string", # required
})

Response structure

resp.action.export_revision_to_s3.encryption.kms_key_arn #=> String
resp.action.export_revision_to_s3.encryption.type #=> String, one of "aws:kms", "AES256"
resp.action.export_revision_to_s3.revision_destination.bucket #=> String
resp.action.export_revision_to_s3.revision_destination.key_pattern #=> String
resp.arn #=> String
resp.created_at #=> Time
resp.event.revision_published.data_set_id #=> String
resp.id #=> String
resp.updated_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :action (Types::Action) —

  What occurs after a certain event.

• :event_action_id (required, String) —

  The unique identifier for the event action.

Returns:

• (Types::UpdateEventActionResponse) —

  Returns a response object which responds to the following methods:

  • #action => Types::Action
  • #arn => String
  • #created_at => Time
  • #event => Types::Event
  • #id => String
  • #updated_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2681

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

#update_revision(params = {}) ⇒ Types::UpdateRevisionResponse

This operation updates a revision.

Examples:

Request syntax with placeholder values

resp = client.update_revision({
  comment: "__stringMin0Max16384",
  data_set_id: "Id", # required
  finalized: false,
  revision_id: "Id", # required
})

Response structure

resp.arn #=> String
resp.comment #=> String
resp.created_at #=> Time
resp.data_set_id #=> String
resp.finalized #=> Boolean
resp.id #=> String
resp.source_id #=> String
resp.updated_at #=> Time
resp.revocation_comment #=> String
resp.revoked #=> Boolean
resp.revoked_at #=> Time

Parameters:

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

  ({})

Options Hash (params):

• :comment (String) —

  An optional comment about the revision.

• :data_set_id (required, String) —

  The unique identifier for a data set.

• :finalized (Boolean) —

  Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.

• :revision_id (required, String) —

  The unique identifier for a revision.

Returns:

• (Types::UpdateRevisionResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String
  • #comment => String
  • #created_at => Time
  • #data_set_id => String
  • #finalized => Boolean
  • #id => String
  • #source_id => String
  • #updated_at => Time
  • #revocation_comment => String
  • #revoked => Boolean
  • #revoked_at => Time

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2743

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