# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE require 'seahorse/client/plugins/content_length.rb' require 'aws-sdk-core/plugins/credentials_configuration.rb' require 'aws-sdk-core/plugins/logging.rb' require 'aws-sdk-core/plugins/param_converter.rb' require 'aws-sdk-core/plugins/param_validator.rb' require 'aws-sdk-core/plugins/user_agent.rb' require 'aws-sdk-core/plugins/helpful_socket_errors.rb' require 'aws-sdk-core/plugins/retry_errors.rb' require 'aws-sdk-core/plugins/global_configuration.rb' require 'aws-sdk-core/plugins/regional_endpoint.rb' require 'aws-sdk-core/plugins/endpoint_discovery.rb' require 'aws-sdk-core/plugins/endpoint_pattern.rb' require 'aws-sdk-core/plugins/response_paging.rb' require 'aws-sdk-core/plugins/stub_responses.rb' require 'aws-sdk-core/plugins/idempotency_token.rb' require 'aws-sdk-core/plugins/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/client_metrics_plugin.rb' require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb' require 'aws-sdk-core/plugins/transfer_encoding.rb' require 'aws-sdk-core/plugins/http_checksum.rb' require 'aws-sdk-core/plugins/checksum_algorithm.rb' require 'aws-sdk-core/plugins/request_compression.rb' require 'aws-sdk-core/plugins/defaults_mode.rb' require 'aws-sdk-core/plugins/recursion_detection.rb' require 'aws-sdk-core/plugins/sign.rb' require 'aws-sdk-core/plugins/protocols/json_rpc.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:bcmdataexports) module Aws::BCMDataExports # An API client for BCMDataExports. To construct a client, you need to configure a `:region` and `:credentials`. # # client = Aws::BCMDataExports::Client.new( # region: region_name, # credentials: credentials, # # ... # ) # # For details on configuring region and credentials see # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html). # # See {#initialize} for a full list of supported configuration options. class Client < Seahorse::Client::Base include Aws::ClientStubs @identifier = :bcmdataexports set_api(ClientApi::API) add_plugin(Seahorse::Client::Plugins::ContentLength) add_plugin(Aws::Plugins::CredentialsConfiguration) add_plugin(Aws::Plugins::Logging) add_plugin(Aws::Plugins::ParamConverter) add_plugin(Aws::Plugins::ParamValidator) add_plugin(Aws::Plugins::UserAgent) add_plugin(Aws::Plugins::HelpfulSocketErrors) add_plugin(Aws::Plugins::RetryErrors) add_plugin(Aws::Plugins::GlobalConfiguration) add_plugin(Aws::Plugins::RegionalEndpoint) add_plugin(Aws::Plugins::EndpointDiscovery) add_plugin(Aws::Plugins::EndpointPattern) add_plugin(Aws::Plugins::ResponsePaging) add_plugin(Aws::Plugins::StubResponses) add_plugin(Aws::Plugins::IdempotencyToken) add_plugin(Aws::Plugins::JsonvalueConverter) add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) add_plugin(Aws::Plugins::TransferEncoding) add_plugin(Aws::Plugins::HttpChecksum) add_plugin(Aws::Plugins::ChecksumAlgorithm) add_plugin(Aws::Plugins::RequestCompression) add_plugin(Aws::Plugins::DefaultsMode) add_plugin(Aws::Plugins::RecursionDetection) add_plugin(Aws::Plugins::Sign) add_plugin(Aws::Plugins::Protocols::JsonRpc) add_plugin(Aws::BCMDataExports::Plugins::Endpoints) # @overload initialize(options) # @param [Hash] options # @option options [required, Aws::CredentialProvider] :credentials # Your AWS credentials. This can be an instance of any one of the # following classes: # # * `Aws::Credentials` - Used for configuring static, non-refreshing # credentials. # # * `Aws::SharedCredentials` - Used for loading static credentials from a # shared file, such as `~/.aws/config`. # # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. # # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to # assume a role after providing credentials via the web. # # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an # access token generated from `aws login`. # # * `Aws::ProcessCredentials` - Used for loading credentials from a # process that outputs to stdout. # # * `Aws::InstanceProfileCredentials` - Used for loading credentials # from an EC2 IMDS on an EC2 instance. # # * `Aws::ECSCredentials` - Used for loading credentials from # instances running in ECS. # # * `Aws::CognitoIdentityCredentials` - Used for loading credentials # from the Cognito Identity service. # # When `:credentials` are not configured directly, the following # locations will be searched for credentials: # # * `Aws.config[:credentials]` # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] # * `~/.aws/credentials` # * `~/.aws/config` # * EC2/ECS IMDS instance profile - When used by default, the timeouts # are very aggressive. Construct and pass an instance of # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to # enable retries and extended timeouts. Instance profile credential # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] # to true. # # @option options [required, String] :region # 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` # # @option options [String] :access_key_id # # @option options [Boolean] :active_endpoint_cache (false) # When set to `true`, a thread polling for endpoints will be running in # the background every 60 secs (default). Defaults to `false`. # # @option options [Boolean] :adaptive_retry_wait_to_fill (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. # # @option options [Boolean] :client_side_monitoring (false) # When `true`, client-side metrics will be collected for all API requests from # this client. # # @option options [String] :client_side_monitoring_client_id ("") # Allows you to provide an identifier for this client which will be attached to # all generated client side metrics. Defaults to an empty string. # # @option options [String] :client_side_monitoring_host ("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. # # @option options [Integer] :client_side_monitoring_port (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. # # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) # Allows you to provide a custom client-side monitoring publisher class. By default, # will use the Client Side Monitoring Agent Publisher. # # @option options [Boolean] :convert_params (true) # When `true`, an attempt is made to coerce request parameters into # the required types. # # @option options [Boolean] :correct_clock_skew (true) # Used only in `standard` and adaptive retry modes. Specifies whether to apply # a clock skew correction and retry requests with skewed client clocks. # # @option options [String] :defaults_mode ("legacy") # See {Aws::DefaultsModeConfiguration} for a list of the # accepted modes and the configuration defaults that are included. # # @option options [Boolean] :disable_host_prefix_injection (false) # Set to true to disable SDK automatically adding host prefix # to default service endpoint when available. # # @option options [Boolean] :disable_request_compression (false) # When set to 'true' the request body will not be compressed # for supported operations. # # @option options [String] :endpoint # The client endpoint is normally constructed from the `:region` # option. You should only configure an `:endpoint` when connecting # to test or custom endpoints. This should be a valid HTTP(S) URI. # # @option options [Integer] :endpoint_cache_max_entries (1000) # Used for the maximum size limit of the LRU cache storing endpoints data # for endpoint discovery enabled operations. Defaults to 1000. # # @option options [Integer] :endpoint_cache_max_threads (10) # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. # # @option options [Integer] :endpoint_cache_poll_interval (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. # # @option options [Boolean] :endpoint_discovery (false) # When set to `true`, endpoint discovery will be enabled for operations when available. # # @option options [Boolean] :ignore_configured_endpoint_urls # Setting to true disables use of endpoint URLs provided via environment # variables and the shared configuration file. # # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) # The log formatter. # # @option options [Symbol] :log_level (:info) # The log level to send messages to the `:logger` at. # # @option options [Logger] :logger # The Logger instance to send log messages to. If this option # is not set, logging will be disabled. # # @option options [Integer] :max_attempts (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. # # @option options [String] :profile ("default") # Used when loading credentials from the shared credentials file # at HOME/.aws/credentials. When not specified, 'default' is used. # # @option options [Integer] :request_min_compression_size_bytes (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. # # @option options [Proc] :retry_backoff # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. # This option is only used in the `legacy` retry mode. # # @option options [Float] :retry_base_delay (0.3) # The base delay in seconds used by the default backoff function. This option # is only used in the `legacy` retry mode. # # @option options [Symbol] :retry_jitter (: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 # # @option options [Integer] :retry_limit (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. # # @option options [Integer] :retry_max_delay (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. # # @option options [String] :retry_mode ("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. # # # @option options [String] :sdk_ua_app_id # A unique and opaque application ID that is appended to the # User-Agent header as app/. It should have a # maximum length of 50. # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Boolean] :simple_json (false) # Disables request parameter conversion, validation, and formatting. # Also disable response data type conversions. This option is useful # when you want to ensure the highest level of performance by # avoiding overhead of walking request parameters and response data # structures. # # When `:simple_json` is enabled, the request parameters hash must # be formatted exactly as the DynamoDB API expects. # # @option options [Boolean] :stub_responses (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. # # @option options [Aws::TokenProvider] :token_provider # A Bearer Token Provider. This can be an instance of any one of the # following classes: # # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing # tokens. # # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an # access token generated from `aws login`. # # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain` # will be used to search for tokens configured for your profile in shared configuration files. # # @option options [Boolean] :use_dualstack_endpoint # When set to `true`, dualstack enabled endpoints (with `.aws` TLD) # will be used if available. # # @option options [Boolean] :use_fips_endpoint # 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`. # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # # @option options [Aws::BCMDataExports::EndpointProvider] :endpoint_provider # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::BCMDataExports::EndpointParameters` # # @option options [URI::HTTP,String] :http_proxy A proxy to send # requests through. Formatted like 'http://proxy.com:123'. # # @option options [Float] :http_open_timeout (15) The number of # seconds to wait when opening a HTTP session before raising a # `Timeout::Error`. # # @option options [Float] :http_read_timeout (60) The default # number of seconds to wait for response data. This value can # safely be set per-request on the session. # # @option options [Float] :http_idle_timeout (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. # # @option options [Float] :http_continue_timeout (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. # # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout # in seconds. # # @option options [Boolean] :http_wire_trace (false) When `true`, # HTTP debug output will be sent to the `:logger`. # # @option options [Boolean] :ssl_verify_peer (true) When `true`, # SSL peer certificates are verified when establishing a # connection. # # @option options [String] :ssl_ca_bundle 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. # # @option options [String] :ssl_ca_directory 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. # def initialize(*args) super end # @!group API Operations # Creates a data export and specifies the data query, the delivery # preference, and any optional resource tags. # # A `DataQuery` consists of both a `QueryStatement` and # `TableConfigurations`. # # The `QueryStatement` is an SQL statement. Data Exports only supports a # limited subset of the SQL syntax. For more information on the SQL # syntax that is supported, see [Data query][1]. To view the available # tables and columns, see the [Data Exports table dictionary][2]. # # The `TableConfigurations` is a collection of specified # `TableProperties` for the table being queried in the `QueryStatement`. # TableProperties are additional configurations you can provide to # change the data and schema of a table. Each table can have different # TableProperties. However, tables are not required to have any # TableProperties. Each table property has a default value that it # assumes if not specified. For more information on table # configurations, see [Data query][1]. To view the table properties # available for each table, see the [Data Exports table dictionary][2] # or use the `ListTables` API to get a response of all tables and their # available properties. # # # # [1]: https://docs.aws.amazon.com/cur/latest/userguide/de-data-query.html # [2]: https://docs.aws.amazon.com/cur/latest/userguide/de-table-dictionary.html # # @option params [required, Types::Export] :export # The details of the export, including data query, name, description, # and destination configuration. # # @option params [Array] :resource_tags # An optional list of tags to associate with the specified export. Each # tag consists of a key and a value, and each key must be unique for the # resource. # # @return [Types::CreateExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateExportResponse#export_arn #export_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_export({ # export: { # required # data_query: { # required # query_statement: "QueryStatement", # required # table_configurations: { # "TableName" => { # "TableProperty" => "GenericString", # }, # }, # }, # description: "GenericString", # destination_configurations: { # required # s3_destination: { # required # s3_bucket: "GenericString", # required # s3_output_configurations: { # required # compression: "GZIP", # required, accepts GZIP, PARQUET # format: "TEXT_OR_CSV", # required, accepts TEXT_OR_CSV, PARQUET # output_type: "CUSTOM", # required, accepts CUSTOM # overwrite: "CREATE_NEW_REPORT", # required, accepts CREATE_NEW_REPORT, OVERWRITE_REPORT # }, # s3_prefix: "GenericString", # required # s3_region: "GenericString", # required # }, # }, # export_arn: "Arn", # name: "ExportName", # required # refresh_cadence: { # required # frequency: "SYNCHRONOUS", # required, accepts SYNCHRONOUS # }, # }, # resource_tags: [ # { # key: "ResourceTagKey", # required # value: "ResourceTagValue", # required # }, # ], # }) # # @example Response structure # # resp.export_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/CreateExport AWS API Documentation # # @overload create_export(params = {}) # @param [Hash] params ({}) def create_export(params = {}, options = {}) req = build_request(:create_export, params) req.send_request(options) end # Deletes an existing data export. # # @option params [required, String] :export_arn # The Amazon Resource Name (ARN) for this export. # # @return [Types::DeleteExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteExportResponse#export_arn #export_arn} => String # # @example Request syntax with placeholder values # # resp = client.delete_export({ # export_arn: "Arn", # required # }) # # @example Response structure # # resp.export_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/DeleteExport AWS API Documentation # # @overload delete_export(params = {}) # @param [Hash] params ({}) def delete_export(params = {}, options = {}) req = build_request(:delete_export, params) req.send_request(options) end # Exports data based on the source data update. # # @option params [required, String] :execution_id # The ID for this specific execution. # # @option params [required, String] :export_arn # The Amazon Resource Name (ARN) of the Export object that generated # this specific execution. # # @return [Types::GetExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetExecutionResponse#execution_id #execution_id} => String # * {Types::GetExecutionResponse#execution_status #execution_status} => Types::ExecutionStatus # * {Types::GetExecutionResponse#export #export} => Types::Export # # @example Request syntax with placeholder values # # resp = client.get_execution({ # execution_id: "GenericString", # required # export_arn: "Arn", # required # }) # # @example Response structure # # resp.execution_id #=> String # resp.execution_status.completed_at #=> Time # resp.execution_status.created_at #=> Time # resp.execution_status.last_updated_at #=> Time # resp.execution_status.status_code #=> String, one of "INITIATION_IN_PROCESS", "QUERY_QUEUED", "QUERY_IN_PROCESS", "QUERY_FAILURE", "DELIVERY_IN_PROCESS", "DELIVERY_SUCCESS", "DELIVERY_FAILURE" # resp.execution_status.status_reason #=> String, one of "INSUFFICIENT_PERMISSION", "BILL_OWNER_CHANGED", "INTERNAL_FAILURE" # resp.export.data_query.query_statement #=> String # resp.export.data_query.table_configurations #=> Hash # resp.export.data_query.table_configurations["TableName"] #=> Hash # resp.export.data_query.table_configurations["TableName"]["TableProperty"] #=> String # resp.export.description #=> String # resp.export.destination_configurations.s3_destination.s3_bucket #=> String # resp.export.destination_configurations.s3_destination.s3_output_configurations.compression #=> String, one of "GZIP", "PARQUET" # resp.export.destination_configurations.s3_destination.s3_output_configurations.format #=> String, one of "TEXT_OR_CSV", "PARQUET" # resp.export.destination_configurations.s3_destination.s3_output_configurations.output_type #=> String, one of "CUSTOM" # resp.export.destination_configurations.s3_destination.s3_output_configurations.overwrite #=> String, one of "CREATE_NEW_REPORT", "OVERWRITE_REPORT" # resp.export.destination_configurations.s3_destination.s3_prefix #=> String # resp.export.destination_configurations.s3_destination.s3_region #=> String # resp.export.export_arn #=> String # resp.export.name #=> String # resp.export.refresh_cadence.frequency #=> String, one of "SYNCHRONOUS" # # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/GetExecution AWS API Documentation # # @overload get_execution(params = {}) # @param [Hash] params ({}) def get_execution(params = {}, options = {}) req = build_request(:get_execution, params) req.send_request(options) end # Views the definition of an existing data export. # # @option params [required, String] :export_arn # The Amazon Resource Name (ARN) for this export. # # @return [Types::GetExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetExportResponse#export #export} => Types::Export # * {Types::GetExportResponse#export_status #export_status} => Types::ExportStatus # # @example Request syntax with placeholder values # # resp = client.get_export({ # export_arn: "Arn", # required # }) # # @example Response structure # # resp.export.data_query.query_statement #=> String # resp.export.data_query.table_configurations #=> Hash # resp.export.data_query.table_configurations["TableName"] #=> Hash # resp.export.data_query.table_configurations["TableName"]["TableProperty"] #=> String # resp.export.description #=> String # resp.export.destination_configurations.s3_destination.s3_bucket #=> String # resp.export.destination_configurations.s3_destination.s3_output_configurations.compression #=> String, one of "GZIP", "PARQUET" # resp.export.destination_configurations.s3_destination.s3_output_configurations.format #=> String, one of "TEXT_OR_CSV", "PARQUET" # resp.export.destination_configurations.s3_destination.s3_output_configurations.output_type #=> String, one of "CUSTOM" # resp.export.destination_configurations.s3_destination.s3_output_configurations.overwrite #=> String, one of "CREATE_NEW_REPORT", "OVERWRITE_REPORT" # resp.export.destination_configurations.s3_destination.s3_prefix #=> String # resp.export.destination_configurations.s3_destination.s3_region #=> String # resp.export.export_arn #=> String # resp.export.name #=> String # resp.export.refresh_cadence.frequency #=> String, one of "SYNCHRONOUS" # resp.export_status.created_at #=> Time # resp.export_status.last_refreshed_at #=> Time # resp.export_status.last_updated_at #=> Time # resp.export_status.status_code #=> String, one of "HEALTHY", "UNHEALTHY" # resp.export_status.status_reason #=> String, one of "INSUFFICIENT_PERMISSION", "BILL_OWNER_CHANGED", "INTERNAL_FAILURE" # # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/GetExport AWS API Documentation # # @overload get_export(params = {}) # @param [Hash] params ({}) def get_export(params = {}, options = {}) req = build_request(:get_export, params) req.send_request(options) end # Returns the metadata for the specified table and table properties. # This includes the list of columns in the table schema, their data # types, and column descriptions. # # @option params [required, String] :table_name # The name of the table. # # @option params [Hash] :table_properties # TableProperties are additional configurations you can provide to # change the data and schema of a table. Each table can have different # TableProperties. Tables are not required to have any TableProperties. # Each table property has a default value that it assumes if not # specified. # # @return [Types::GetTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetTableResponse#description #description} => String # * {Types::GetTableResponse#schema #schema} => Array<Types::Column> # * {Types::GetTableResponse#table_name #table_name} => String # * {Types::GetTableResponse#table_properties #table_properties} => Hash<String,String> # # @example Request syntax with placeholder values # # resp = client.get_table({ # table_name: "TableName", # required # table_properties: { # "TableProperty" => "GenericString", # }, # }) # # @example Response structure # # resp.description #=> String # resp.schema #=> Array # resp.schema[0].description #=> String # resp.schema[0].name #=> String # resp.schema[0].type #=> String # resp.table_name #=> String # resp.table_properties #=> Hash # resp.table_properties["TableProperty"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/GetTable AWS API Documentation # # @overload get_table(params = {}) # @param [Hash] params ({}) def get_table(params = {}, options = {}) req = build_request(:get_table, params) req.send_request(options) end # Lists the historical executions for the export. # # @option params [required, String] :export_arn # The Amazon Resource Name (ARN) for this export. # # @option params [Integer] :max_results # The maximum number of objects that are returned for the request. # # @option params [String] :next_token # The token to retrieve the next set of results. # # @return [Types::ListExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListExecutionsResponse#executions #executions} => Array<Types::ExecutionReference> # * {Types::ListExecutionsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_executions({ # export_arn: "Arn", # required # max_results: 1, # next_token: "NextPageToken", # }) # # @example Response structure # # resp.executions #=> Array # resp.executions[0].execution_id #=> String # resp.executions[0].execution_status.completed_at #=> Time # resp.executions[0].execution_status.created_at #=> Time # resp.executions[0].execution_status.last_updated_at #=> Time # resp.executions[0].execution_status.status_code #=> String, one of "INITIATION_IN_PROCESS", "QUERY_QUEUED", "QUERY_IN_PROCESS", "QUERY_FAILURE", "DELIVERY_IN_PROCESS", "DELIVERY_SUCCESS", "DELIVERY_FAILURE" # resp.executions[0].execution_status.status_reason #=> String, one of "INSUFFICIENT_PERMISSION", "BILL_OWNER_CHANGED", "INTERNAL_FAILURE" # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ListExecutions AWS API Documentation # # @overload list_executions(params = {}) # @param [Hash] params ({}) def list_executions(params = {}, options = {}) req = build_request(:list_executions, params) req.send_request(options) end # Lists all data export definitions. # # @option params [Integer] :max_results # The maximum number of objects that are returned for the request. # # @option params [String] :next_token # The token to retrieve the next set of results. # # @return [Types::ListExportsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListExportsResponse#exports #exports} => Array<Types::ExportReference> # * {Types::ListExportsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_exports({ # max_results: 1, # next_token: "NextPageToken", # }) # # @example Response structure # # resp.exports #=> Array # resp.exports[0].export_arn #=> String # resp.exports[0].export_name #=> String # resp.exports[0].export_status.created_at #=> Time # resp.exports[0].export_status.last_refreshed_at #=> Time # resp.exports[0].export_status.last_updated_at #=> Time # resp.exports[0].export_status.status_code #=> String, one of "HEALTHY", "UNHEALTHY" # resp.exports[0].export_status.status_reason #=> String, one of "INSUFFICIENT_PERMISSION", "BILL_OWNER_CHANGED", "INTERNAL_FAILURE" # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ListExports AWS API Documentation # # @overload list_exports(params = {}) # @param [Hash] params ({}) def list_exports(params = {}, options = {}) req = build_request(:list_exports, params) req.send_request(options) end # Lists all available tables in data exports. # # @option params [Integer] :max_results # The maximum number of objects that are returned for the request. # # @option params [String] :next_token # The token to retrieve the next set of results. # # @return [Types::ListTablesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTablesResponse#next_token #next_token} => String # * {Types::ListTablesResponse#tables #tables} => Array<Types::Table> # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_tables({ # max_results: 1, # next_token: "NextPageToken", # }) # # @example Response structure # # resp.next_token #=> String # resp.tables #=> Array # resp.tables[0].description #=> String # resp.tables[0].table_name #=> String # resp.tables[0].table_properties #=> Array # resp.tables[0].table_properties[0].default_value #=> String # resp.tables[0].table_properties[0].description #=> String # resp.tables[0].table_properties[0].name #=> String # resp.tables[0].table_properties[0].valid_values #=> Array # resp.tables[0].table_properties[0].valid_values[0] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ListTables AWS API Documentation # # @overload list_tables(params = {}) # @param [Hash] params ({}) def list_tables(params = {}, options = {}) req = build_request(:list_tables, params) req.send_request(options) end # List tags associated with an existing data export. # # @option params [Integer] :max_results # The maximum number of objects that are returned for the request. # # @option params [String] :next_token # The token to retrieve the next set of results. # # @option params [required, String] :resource_arn # The unique identifier for the resource. # # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForResourceResponse#next_token #next_token} => String # * {Types::ListTagsForResourceResponse#resource_tags #resource_tags} => Array<Types::ResourceTag> # # @example Request syntax with placeholder values # # resp = client.list_tags_for_resource({ # max_results: 1, # next_token: "NextPageToken", # resource_arn: "Arn", # required # }) # # @example Response structure # # resp.next_token #=> String # resp.resource_tags #=> Array # resp.resource_tags[0].key #=> String # resp.resource_tags[0].value #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ListTagsForResource AWS API Documentation # # @overload list_tags_for_resource(params = {}) # @param [Hash] params ({}) def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end # Adds tags for an existing data export definition. # # @option params [required, String] :resource_arn # The unique identifier for the resource. # # @option params [required, Array] :resource_tags # The tags to associate with the resource. Each tag consists of a key # and a value, and each key must be unique for the resource. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.tag_resource({ # resource_arn: "Arn", # required # resource_tags: [ # required # { # key: "ResourceTagKey", # required # value: "ResourceTagValue", # required # }, # ], # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/TagResource AWS API Documentation # # @overload tag_resource(params = {}) # @param [Hash] params ({}) def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end # Deletes tags associated with an existing data export definition. # # @option params [required, String] :resource_arn # The unique identifier for the resource. # # @option params [required, Array] :resource_tag_keys # The tag keys that are associated with the resource ARN. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.untag_resource({ # resource_arn: "Arn", # required # resource_tag_keys: ["ResourceTagKey"], # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/UntagResource AWS API Documentation # # @overload untag_resource(params = {}) # @param [Hash] params ({}) def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end # Updates an existing data export by overwriting all export parameters. # All export parameters must be provided in the UpdateExport request. # # @option params [required, Types::Export] :export # The name and query details for the export. # # @option params [required, String] :export_arn # The Amazon Resource Name (ARN) for this export. # # @return [Types::UpdateExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateExportResponse#export_arn #export_arn} => String # # @example Request syntax with placeholder values # # resp = client.update_export({ # export: { # required # data_query: { # required # query_statement: "QueryStatement", # required # table_configurations: { # "TableName" => { # "TableProperty" => "GenericString", # }, # }, # }, # description: "GenericString", # destination_configurations: { # required # s3_destination: { # required # s3_bucket: "GenericString", # required # s3_output_configurations: { # required # compression: "GZIP", # required, accepts GZIP, PARQUET # format: "TEXT_OR_CSV", # required, accepts TEXT_OR_CSV, PARQUET # output_type: "CUSTOM", # required, accepts CUSTOM # overwrite: "CREATE_NEW_REPORT", # required, accepts CREATE_NEW_REPORT, OVERWRITE_REPORT # }, # s3_prefix: "GenericString", # required # s3_region: "GenericString", # required # }, # }, # export_arn: "Arn", # name: "ExportName", # required # refresh_cadence: { # required # frequency: "SYNCHRONOUS", # required, accepts SYNCHRONOUS # }, # }, # export_arn: "Arn", # required # }) # # @example Response structure # # resp.export_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/UpdateExport AWS API Documentation # # @overload update_export(params = {}) # @param [Hash] params ({}) def update_export(params = {}, options = {}) req = build_request(:update_export, params) req.send_request(options) end # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-bcmdataexports' context[:gem_version] = '1.2.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated def waiter_names [] end class << self # @api private attr_reader :identifier # @api private def errors_module Errors end end end end