Class: Aws::Athena::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-athena/client.rb

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

    Your AWS credentials. This can be an instance of any one of the following classes:

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

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

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

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

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

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` to enable retries and extended timeouts.

  • :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 search for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :endpoint (String) —

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

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.

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

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

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

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

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

    @see 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 and auth errors from expired credentials.

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

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: 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.

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

  • :validate_params (Boolean) — default: true —

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

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

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before rasing a ‘Timeout::Error`.

  • :http_read_timeout (Integer) — default: 60 —

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

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.



261
262
263
 
# File 'lib/aws-sdk-athena/client.rb', line 261

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1193
1194
1195
 
# File 'lib/aws-sdk-athena/client.rb', line 1193

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1196
1197
1198
 
# File 'lib/aws-sdk-athena/client.rb', line 1196

def errors_module
  Errors
end

Instance Method Details

#batch_get_named_query(params = {}) ⇒ Types::BatchGetNamedQueryOutput

Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs.

Examples:

Request syntax with placeholder values


resp = client.batch_get_named_query({
  named_query_ids: ["NamedQueryId"], # required
})

Response structure


resp.named_queries #=> Array
resp.named_queries[0].name #=> String
resp.named_queries[0].description #=> String
resp.named_queries[0].database #=> String
resp.named_queries[0].query_string #=> String
resp.named_queries[0].named_query_id #=> String
resp.named_queries[0].work_group #=> String
resp.unprocessed_named_query_ids #=> Array
resp.unprocessed_named_query_ids[0].named_query_id #=> String
resp.unprocessed_named_query_ids[0].error_code #=> String
resp.unprocessed_named_query_ids[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    An array of query IDs.

Returns:

See Also:



310
311
312
313
 
# File 'lib/aws-sdk-athena/client.rb', line 310

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

#batch_get_query_execution(params = {}) ⇒ Types::BatchGetQueryExecutionOutput

Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.

Examples:

Request syntax with placeholder values


resp = client.batch_get_query_execution({
  query_execution_ids: ["QueryExecutionId"], # required
})

Response structure


resp.query_executions #=> Array
resp.query_executions[0].query_execution_id #=> String
resp.query_executions[0].query #=> String
resp.query_executions[0].statement_type #=> String, one of "DDL", "DML", "UTILITY"
resp.query_executions[0].result_configuration.output_location #=> String
resp.query_executions[0].result_configuration.encryption_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS", "CSE_KMS"
resp.query_executions[0].result_configuration.encryption_configuration.kms_key #=> String
resp.query_executions[0].query_execution_context.database #=> String
resp.query_executions[0].status.state #=> String, one of "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED"
resp.query_executions[0].status.state_change_reason #=> String
resp.query_executions[0].status.submission_date_time #=> Time
resp.query_executions[0].status.completion_date_time #=> Time
resp.query_executions[0].statistics.engine_execution_time_in_millis #=> Integer
resp.query_executions[0].statistics.data_scanned_in_bytes #=> Integer
resp.query_executions[0].statistics.data_manifest_location #=> String
resp.query_executions[0].work_group #=> String
resp.unprocessed_query_execution_ids #=> Array
resp.unprocessed_query_execution_ids[0].query_execution_id #=> String
resp.unprocessed_query_execution_ids[0].error_code #=> String
resp.unprocessed_query_execution_ids[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    An array of query execution IDs.

Returns:

See Also:



364
365
366
367
 
# File 'lib/aws-sdk-athena/client.rb', line 364

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
 
# File 'lib/aws-sdk-athena/client.rb', line 1171

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-athena'
  context[:gem_version] = '1.20.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_named_query(params = {}) ⇒ Types::CreateNamedQueryOutput

Creates a named query in the specified workgroup. Requires that you have access to the workgroup.

For code samples using the AWS SDK for Java, see [Examples and Code Samples] in the *Amazon Athena User Guide*.

[1]: docs.aws.amazon.com/athena/latest/ug/code-samples.html

Examples:

Request syntax with placeholder values


resp = client.create_named_query({
  name: "NameString", # required
  description: "DescriptionString",
  database: "DatabaseString", # required
  query_string: "QueryString", # required
  client_request_token: "IdempotencyToken",
  work_group: "WorkGroupName",
})

Response structure


resp.named_query_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The query name.

  • :description (String) —

    The query description.

  • :database (required, String) —

    The database to which the query belongs.

  • :query_string (required, String) —

    The contents of the query with all query statements.

  • :client_request_token (String) —

    A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another ‘CreateNamedQuery` request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the `QueryString`, an error is returned.

    This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.

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

  • :work_group (String) —

    The name of the workgroup in which the named query is being created.

Returns:

See Also:



432
433
434
435
 
# File 'lib/aws-sdk-athena/client.rb', line 432

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

#create_work_group(params = {}) ⇒ Struct

Creates a workgroup with the specified name.

Examples:

Request syntax with placeholder values


resp = client.create_work_group({
  name: "WorkGroupName", # required
  configuration: {
    result_configuration: {
      output_location: "String",
      encryption_configuration: {
        encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
        kms_key: "String",
      },
    },
    enforce_work_group_configuration: false,
    publish_cloud_watch_metrics_enabled: false,
    bytes_scanned_cutoff_per_query: 1,
    requester_pays_enabled: false,
  },
  description: "WorkGroupDescriptionString",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The workgroup name.

  • :configuration (Types::WorkGroupConfiguration) —

    The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup’s settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

  • :description (String) —

    The workgroup description.

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

    One or more tags, separated by commas, that you want to attach to the workgroup as you create it.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



492
493
494
495
 
# File 'lib/aws-sdk-athena/client.rb', line 492

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

#delete_named_query(params = {}) ⇒ Struct

Deletes the named query if you have access to the workgroup in which the query was saved.

For code samples using the AWS SDK for Java, see [Examples and Code Samples] in the *Amazon Athena User Guide*.

[1]: docs.aws.amazon.com/athena/latest/ug/code-samples.html

Examples:

Request syntax with placeholder values


resp = client.delete_named_query({
  named_query_id: "NamedQueryId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :named_query_id (required, String) —

    The unique ID of the query to delete.

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



525
526
527
528
 
# File 'lib/aws-sdk-athena/client.rb', line 525

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

#delete_work_group(params = {}) ⇒ Struct

Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_work_group({
  work_group: "WorkGroupName", # required
  recursive_delete_option: false,
})

Parameters:

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

    ({})

Options Hash (params):

  • :work_group (required, String) —

    The unique name of the workgroup to delete.

  • :recursive_delete_option (Boolean) —

    The option to delete the workgroup and its contents even if the workgroup contains any named queries.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



553
554
555
556
 
# File 'lib/aws-sdk-athena/client.rb', line 553

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

#get_named_query(params = {}) ⇒ Types::GetNamedQueryOutput

Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.

Examples:

Request syntax with placeholder values


resp = client.get_named_query({
  named_query_id: "NamedQueryId", # required
})

Response structure


resp.named_query.name #=> String
resp.named_query.description #=> String
resp.named_query.database #=> String
resp.named_query.query_string #=> String
resp.named_query.named_query_id #=> String
resp.named_query.work_group #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :named_query_id (required, String) —

    The unique ID of the query. Use ListNamedQueries to get query IDs.

Returns:

See Also:



587
588
589
590
 
# File 'lib/aws-sdk-athena/client.rb', line 587

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

#get_query_execution(params = {}) ⇒ Types::GetQueryExecutionOutput

Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.

Examples:

Request syntax with placeholder values


resp = client.get_query_execution({
  query_execution_id: "QueryExecutionId", # required
})

Response structure


resp.query_execution.query_execution_id #=> String
resp.query_execution.query #=> String
resp.query_execution.statement_type #=> String, one of "DDL", "DML", "UTILITY"
resp.query_execution.result_configuration.output_location #=> String
resp.query_execution.result_configuration.encryption_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS", "CSE_KMS"
resp.query_execution.result_configuration.encryption_configuration.kms_key #=> String
resp.query_execution.query_execution_context.database #=> String
resp.query_execution.status.state #=> String, one of "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED"
resp.query_execution.status.state_change_reason #=> String
resp.query_execution.status.submission_date_time #=> Time
resp.query_execution.status.completion_date_time #=> Time
resp.query_execution.statistics.engine_execution_time_in_millis #=> Integer
resp.query_execution.statistics.data_scanned_in_bytes #=> Integer
resp.query_execution.statistics.data_manifest_location #=> String
resp.query_execution.work_group #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :query_execution_id (required, String) —

    The unique ID of the query execution.

Returns:

See Also:



632
633
634
635
 
# File 'lib/aws-sdk-athena/client.rb', line 632

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

#get_query_results(params = {}) ⇒ Types::GetQueryResultsOutput

Streams the results of a single query execution specified by ‘QueryExecutionId` from the Athena query results location in Amazon S3. For more information, see [Query Results] in the *Amazon Athena User Guide*. This request does not execute the query but returns results. Use StartQueryExecution to run a query.

To stream query results successfully, the IAM principal with permission to call ‘GetQueryResults` also must have permissions to the Amazon S3 `GetObject` action for the Athena query results location.

IAM principals with permission to the Amazon S3 ‘GetObject` action for the query results location are able to retrieve query results from Amazon S3 even if permission to the `GetQueryResults` action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.

[1]: docs.aws.amazon.com/athena/latest/ug/querying.html

Examples:

Request syntax with placeholder values


resp = client.get_query_results({
  query_execution_id: "QueryExecutionId", # required
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.update_count #=> Integer
resp.result_set.rows #=> Array
resp.result_set.rows[0].data #=> Array
resp.result_set.rows[0].data[0].var_char_value #=> String
resp.result_set.result_set_metadata.column_info #=> Array
resp.result_set.result_set_metadata.column_info[0].catalog_name #=> String
resp.result_set.result_set_metadata.column_info[0].schema_name #=> String
resp.result_set.result_set_metadata.column_info[0].table_name #=> String
resp.result_set.result_set_metadata.column_info[0].name #=> String
resp.result_set.result_set_metadata.column_info[0].label #=> String
resp.result_set.result_set_metadata.column_info[0].type #=> String
resp.result_set.result_set_metadata.column_info[0].precision #=> Integer
resp.result_set.result_set_metadata.column_info[0].scale #=> Integer
resp.result_set.result_set_metadata.column_info[0].nullable #=> String, one of "NOT_NULL", "NULLABLE", "UNKNOWN"
resp.result_set.result_set_metadata.column_info[0].case_sensitive #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :query_execution_id (required, String) —

    The unique ID of the query execution.

  • :next_token (String) —

    The token that specifies where to start pagination if a previous request was truncated.

  • :max_results (Integer) —

    The maximum number of results (rows) to return in this request.

Returns:

See Also:



704
705
706
707
 
# File 'lib/aws-sdk-athena/client.rb', line 704

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

#get_work_group(params = {}) ⇒ Types::GetWorkGroupOutput

Returns information about the workgroup with the specified name.

Examples:

Request syntax with placeholder values


resp = client.get_work_group({
  work_group: "WorkGroupName", # required
})

Response structure


resp.work_group.name #=> String
resp.work_group.state #=> String, one of "ENABLED", "DISABLED"
resp.work_group.configuration.result_configuration.output_location #=> String
resp.work_group.configuration.result_configuration.encryption_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS", "CSE_KMS"
resp.work_group.configuration.result_configuration.encryption_configuration.kms_key #=> String
resp.work_group.configuration.enforce_work_group_configuration #=> Boolean
resp.work_group.configuration.publish_cloud_watch_metrics_enabled #=> Boolean
resp.work_group.configuration.bytes_scanned_cutoff_per_query #=> Integer
resp.work_group.configuration.requester_pays_enabled #=> Boolean
resp.work_group.description #=> String
resp.work_group.creation_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :work_group (required, String) —

    The name of the workgroup.

Returns:

See Also:



742
743
744
745
 
# File 'lib/aws-sdk-athena/client.rb', line 742

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

#list_named_queries(params = {}) ⇒ Types::ListNamedQueriesOutput

Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup.

For code samples using the AWS SDK for Java, see [Examples and Code Samples] in the *Amazon Athena User Guide*.

[1]: docs.aws.amazon.com/athena/latest/ug/code-samples.html

Examples:

Request syntax with placeholder values


resp = client.list_named_queries({
  next_token: "Token",
  max_results: 1,
  work_group: "WorkGroupName",
})

Response structure


resp.named_query_ids #=> Array
resp.named_query_ids[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token that specifies where to start pagination if a previous request was truncated.

  • :max_results (Integer) —

    The maximum number of queries to return in this request.

  • :work_group (String) —

    The name of the workgroup from which the named queries are being returned.

Returns:

See Also:



791
792
793
794
 
# File 'lib/aws-sdk-athena/client.rb', line 791

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

#list_query_executions(params = {}) ⇒ Types::ListQueryExecutionsOutput

Provides a list of available query execution IDs for the queries in the specified workgroup. Requires you to have access to the workgroup in which the queries ran.

For code samples using the AWS SDK for Java, see [Examples and Code Samples] in the *Amazon Athena User Guide*.

[1]: docs.aws.amazon.com/athena/latest/ug/code-samples.html

Examples:

Request syntax with placeholder values


resp = client.list_query_executions({
  next_token: "Token",
  max_results: 1,
  work_group: "WorkGroupName",
})

Response structure


resp.query_execution_ids #=> Array
resp.query_execution_ids[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token that specifies where to start pagination if a previous request was truncated.

  • :max_results (Integer) —

    The maximum number of query executions to return in this request.

  • :work_group (String) —

    The name of the workgroup from which queries are being returned.

Returns:

See Also:



840
841
842
843
 
# File 'lib/aws-sdk-athena/client.rb', line 840

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

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

Lists the tags associated with this workgroup.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Lists the tags for the workgroup resource with the specified ARN.

  • :next_token (String) —

    The token for the next set of results, or null if there are no additional results for this request, where the request lists the tags for the workgroup resource with the specified ARN.

  • :max_results (Integer) —

    The maximum number of results to be returned per request that lists the tags for the workgroup resource.

Returns:

See Also:



883
884
885
886
 
# File 'lib/aws-sdk-athena/client.rb', line 883

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

#list_work_groups(params = {}) ⇒ Types::ListWorkGroupsOutput

Lists available workgroups for the account.

Examples:

Request syntax with placeholder values


resp = client.list_work_groups({
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.work_groups #=> Array
resp.work_groups[0].name #=> String
resp.work_groups[0].state #=> String, one of "ENABLED", "DISABLED"
resp.work_groups[0].description #=> String
resp.work_groups[0].creation_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A token to be used by the next request if this request is truncated.

  • :max_results (Integer) —

    The maximum number of workgroups to return in this request.

Returns:

See Also:



921
922
923
924
 
# File 'lib/aws-sdk-athena/client.rb', line 921

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

#start_query_execution(params = {}) ⇒ Types::StartQueryExecutionOutput

Runs the SQL query statements contained in the ‘Query`. Requires you to have access to the workgroup in which the query ran.

For code samples using the AWS SDK for Java, see [Examples and Code Samples] in the *Amazon Athena User Guide*.

[1]: docs.aws.amazon.com/athena/latest/ug/code-samples.html

Examples:

Request syntax with placeholder values


resp = client.start_query_execution({
  query_string: "QueryString", # required
  client_request_token: "IdempotencyToken",
  query_execution_context: {
    database: "DatabaseString",
  },
  result_configuration: {
    output_location: "String",
    encryption_configuration: {
      encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
      kms_key: "String",
    },
  },
  work_group: "WorkGroupName",
})

Response structure


resp.query_execution_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :query_string (required, String) —

    The SQL query statements to be executed.

  • :client_request_token (String) —

    A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another ‘StartQueryExecution` request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the `QueryString`, an error is returned.

    This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.

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

  • :query_execution_context (Types::QueryExecutionContext) —

    The database within which the query executes.

  • :result_configuration (Types::ResultConfiguration) —

    Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup’s settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

  • :work_group (String) —

    The name of the workgroup in which the query is being started.

Returns:

See Also:



999
1000
1001
1002
 
# File 'lib/aws-sdk-athena/client.rb', line 999

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

#stop_query_execution(params = {}) ⇒ Struct

Stops a query execution. Requires you to have access to the workgroup in which the query ran.

For code samples using the AWS SDK for Java, see [Examples and Code Samples] in the *Amazon Athena User Guide*.

[1]: docs.aws.amazon.com/athena/latest/ug/code-samples.html

Examples:

Request syntax with placeholder values


resp = client.stop_query_execution({
  query_execution_id: "QueryExecutionId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :query_execution_id (required, String) —

    The unique ID of the query execution to stop.

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1032
1033
1034
1035
 
# File 'lib/aws-sdk-athena/client.rb', line 1032

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

#tag_resource(params = {}) ⇒ Struct

Adds one or more tags to the resource, such as a workgroup. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize resources (workgroups) in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. For best practices, see [AWS Tagging Strategies]. The key length is from 1 (minimum) to 128 (maximum) Unicode characters in UTF-8. The tag value length is from 0 (minimum) to 256 (maximum) Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one, separate them by commas.

[1]: aws.amazon.com/answers/account-management/aws-tagging-strategies/

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Requests that one or more tags are added to the resource (such as a workgroup) for the specified ARN.

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

    One or more tags, separated by commas, to be added to the resource, such as a workgroup.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1081
1082
1083
1084
 
# File 'lib/aws-sdk-athena/client.rb', line 1081

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

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the workgroup resource. Takes as an input a list of TagKey Strings separated by commas, and removes their tags at the same time.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Removes one or more tags from the workgroup resource for the specified ARN.

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

    Removes the tags associated with one or more tag keys from the workgroup resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1111
1112
1113
1114
 
# File 'lib/aws-sdk-athena/client.rb', line 1111

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

#update_work_group(params = {}) ⇒ Struct

Updates the workgroup with the specified name. The workgroup’s name cannot be changed.

Examples:

Request syntax with placeholder values


resp = client.update_work_group({
  work_group: "WorkGroupName", # required
  description: "WorkGroupDescriptionString",
  configuration_updates: {
    enforce_work_group_configuration: false,
    result_configuration_updates: {
      output_location: "String",
      remove_output_location: false,
      encryption_configuration: {
        encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
        kms_key: "String",
      },
      remove_encryption_configuration: false,
    },
    publish_cloud_watch_metrics_enabled: false,
    bytes_scanned_cutoff_per_query: 1,
    remove_bytes_scanned_cutoff_per_query: false,
    requester_pays_enabled: false,
  },
  state: "ENABLED", # accepts ENABLED, DISABLED
})

Parameters:

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

    ({})

Options Hash (params):

  • :work_group (required, String) —

    The specified workgroup that will be updated.

  • :description (String) —

    The workgroup description.

  • :configuration_updates (Types::WorkGroupConfigurationUpdates) —

    The workgroup configuration that will be updated for the given workgroup.

  • :state (String) —

    The workgroup state that will be updated for the given workgroup.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1162
1163
1164
1165
 
# File 'lib/aws-sdk-athena/client.rb', line 1162

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1186
1187
1188
 
# File 'lib/aws-sdk-athena/client.rb', line 1186

def waiter_names
  []
end