lib/aws-sdk-glue/client.rb in aws-sdk-glue-1.50.0 vs lib/aws-sdk-glue/client.rb in aws-sdk-glue-1.51.0
- old
+ new
@@ -30,15 +30,15 @@
Aws::Plugins::GlobalConfiguration.add_identifier(:glue)
module Aws::Glue
# An API client for Glue. To construct a client, you need to configure a `:region` and `:credentials`.
#
- # client = Aws::Glue::Client.new(
- # region: region_name,
- # credentials: credentials,
- # # ...
- # )
+ # client = Aws::Glue::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.
@@ -227,20 +227,24 @@
# 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.
#
+ # * `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] :secret_access_key
#
# @option options [String] :session_token
#
# @option options [Boolean] :simple_json (false)
@@ -273,12 +277,11 @@
# seconds to wait when opening a HTTP session before raising a
# `Timeout::Error`.
#
# @option options [Integer] :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 yielded by {#session_for}.
+ # 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.
@@ -286,11 +289,11 @@
# @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 yielded by {#session_for}.
+ # request on the session.
#
# @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`,
@@ -1287,11 +1290,11 @@
# resp = client.create_connection({
# catalog_id: "CatalogIdString",
# connection_input: { # required
# name: "NameString", # required
# description: "DescriptionString",
- # connection_type: "JDBC", # required, accepts JDBC, SFTP
+ # connection_type: "JDBC", # required, accepts JDBC, SFTP, MONGODB
# match_criteria: ["NameString"],
# connection_properties: { # required
# "HOST" => "ValueString",
# },
# physical_connection_requirements: {
@@ -3118,10 +3121,12 @@
# @return [Types::GetClassifiersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetClassifiersResponse#classifiers #classifiers} => Array<Types::Classifier>
# * {Types::GetClassifiersResponse#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.get_classifiers({
# max_results: 1,
# next_token: "Token",
@@ -3201,11 +3206,11 @@
#
# @example Response structure
#
# resp.connection.name #=> String
# resp.connection.description #=> String
- # resp.connection.connection_type #=> String, one of "JDBC", "SFTP"
+ # resp.connection.connection_type #=> String, one of "JDBC", "SFTP", "MONGODB"
# resp.connection.match_criteria #=> Array
# resp.connection.match_criteria[0] #=> String
# resp.connection.connection_properties #=> Hash
# resp.connection.connection_properties["ConnectionPropertyKey"] #=> String
# resp.connection.physical_connection_requirements.subnet_id #=> String
@@ -3251,17 +3256,19 @@
# @return [Types::GetConnectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetConnectionsResponse#connection_list #connection_list} => Array<Types::Connection>
# * {Types::GetConnectionsResponse#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.get_connections({
# catalog_id: "CatalogIdString",
# filter: {
# match_criteria: ["NameString"],
- # connection_type: "JDBC", # accepts JDBC, SFTP
+ # connection_type: "JDBC", # accepts JDBC, SFTP, MONGODB
# },
# hide_password: false,
# next_token: "Token",
# max_results: 1,
# })
@@ -3269,11 +3276,11 @@
# @example Response structure
#
# resp.connection_list #=> Array
# resp.connection_list[0].name #=> String
# resp.connection_list[0].description #=> String
- # resp.connection_list[0].connection_type #=> String, one of "JDBC", "SFTP"
+ # resp.connection_list[0].connection_type #=> String, one of "JDBC", "SFTP", "MONGODB"
# resp.connection_list[0].match_criteria #=> Array
# resp.connection_list[0].match_criteria[0] #=> String
# resp.connection_list[0].connection_properties #=> Hash
# resp.connection_list[0].connection_properties["ConnectionPropertyKey"] #=> String
# resp.connection_list[0].physical_connection_requirements.subnet_id #=> String
@@ -3374,10 +3381,12 @@
# @return [Types::GetCrawlerMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetCrawlerMetricsResponse#crawler_metrics_list #crawler_metrics_list} => Array<Types::CrawlerMetrics>
# * {Types::GetCrawlerMetricsResponse#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.get_crawler_metrics({
# crawler_name_list: ["NameString"],
# max_results: 1,
@@ -3417,10 +3426,12 @@
# @return [Types::GetCrawlersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetCrawlersResponse#crawlers #crawlers} => Array<Types::Crawler>
# * {Types::GetCrawlersResponse#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.get_crawlers({
# max_results: 1,
# next_token: "Token",
@@ -3569,10 +3580,12 @@
# @return [Types::GetDatabasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetDatabasesResponse#database_list #database_list} => Array<Types::Database>
# * {Types::GetDatabasesResponse#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.get_databases({
# catalog_id: "CatalogIdString",
# next_token: "Token",
@@ -3723,10 +3736,12 @@
# @return [Types::GetDevEndpointsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetDevEndpointsResponse#dev_endpoints #dev_endpoints} => Array<Types::DevEndpoint>
# * {Types::GetDevEndpointsResponse#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.get_dev_endpoints({
# max_results: 1,
# next_token: "GenericString",
@@ -3938,10 +3953,12 @@
# @return [Types::GetJobRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetJobRunsResponse#job_runs #job_runs} => Array<Types::JobRun>
# * {Types::GetJobRunsResponse#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.get_job_runs({
# job_name: "NameString", # required
# next_token: "GenericString",
@@ -3998,10 +4015,12 @@
# @return [Types::GetJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetJobsResponse#jobs #jobs} => Array<Types::Job>
# * {Types::GetJobsResponse#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.get_jobs({
# next_token: "GenericString",
# max_results: 1,
@@ -4136,10 +4155,12 @@
# @return [Types::GetMLTaskRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetMLTaskRunsResponse#task_runs #task_runs} => Array<Types::TaskRun>
# * {Types::GetMLTaskRunsResponse#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.get_ml_task_runs({
# transform_id: "HashString", # required
# next_token: "PaginationToken",
@@ -4295,10 +4316,12 @@
# @return [Types::GetMLTransformsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetMLTransformsResponse#transforms #transforms} => Array<Types::MLTransform>
# * {Types::GetMLTransformsResponse#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.get_ml_transforms({
# next_token: "PaginationToken",
# max_results: 1,
@@ -4642,10 +4665,12 @@
# @return [Types::GetPartitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetPartitionsResponse#partitions #partitions} => Array<Types::Partition>
# * {Types::GetPartitionsResponse#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.get_partitions({
# catalog_id: "CatalogIdString",
# database_name: "NameString", # required
@@ -4868,10 +4893,12 @@
# @return [Types::GetSecurityConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetSecurityConfigurationsResponse#security_configurations #security_configurations} => Array<Types::SecurityConfiguration>
# * {Types::GetSecurityConfigurationsResponse#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.get_security_configurations({
# max_results: 1,
# next_token: "GenericString",
@@ -5109,10 +5136,12 @@
# @return [Types::GetTableVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetTableVersionsResponse#table_versions #table_versions} => Array<Types::TableVersion>
# * {Types::GetTableVersionsResponse#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.get_table_versions({
# catalog_id: "CatalogIdString",
# database_name: "NameString", # required
@@ -5211,10 +5240,12 @@
# @return [Types::GetTablesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetTablesResponse#table_list #table_list} => Array<Types::Table>
# * {Types::GetTablesResponse#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.get_tables({
# catalog_id: "CatalogIdString",
# database_name: "NameString", # required
@@ -5383,10 +5414,12 @@
# @return [Types::GetTriggersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetTriggersResponse#triggers #triggers} => Array<Types::Trigger>
# * {Types::GetTriggersResponse#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.get_triggers({
# next_token: "GenericString",
# dependent_job_name: "NameString",
@@ -5495,10 +5528,12 @@
# @return [Types::GetUserDefinedFunctionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetUserDefinedFunctionsResponse#user_defined_functions #user_defined_functions} => Array<Types::UserDefinedFunction>
# * {Types::GetUserDefinedFunctionsResponse#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.get_user_defined_functions({
# catalog_id: "CatalogIdString",
# database_name: "NameString", # required
@@ -5864,10 +5899,12 @@
# @return [Types::GetWorkflowRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetWorkflowRunsResponse#runs #runs} => Array<Types::WorkflowRun>
# * {Types::GetWorkflowRunsResponse#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.get_workflow_runs({
# name: "NameString", # required
# include_graph: false,
@@ -6008,10 +6045,12 @@
# @return [Types::ListCrawlersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListCrawlersResponse#crawler_names #crawler_names} => Array<String>
# * {Types::ListCrawlersResponse#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_crawlers({
# max_results: 1,
# next_token: "Token",
@@ -6057,10 +6096,12 @@
# @return [Types::ListDevEndpointsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListDevEndpointsResponse#dev_endpoint_names #dev_endpoint_names} => Array<String>
# * {Types::ListDevEndpointsResponse#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_dev_endpoints({
# next_token: "GenericString",
# max_results: 1,
@@ -6105,10 +6146,12 @@
# @return [Types::ListJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListJobsResponse#job_names #job_names} => Array<String>
# * {Types::ListJobsResponse#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_jobs({
# next_token: "GenericString",
# max_results: 1,
@@ -6159,10 +6202,12 @@
# @return [Types::ListMLTransformsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListMLTransformsResponse#transform_ids #transform_ids} => Array<String>
# * {Types::ListMLTransformsResponse#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_ml_transforms({
# next_token: "PaginationToken",
# max_results: 1,
@@ -6232,10 +6277,12 @@
# @return [Types::ListTriggersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListTriggersResponse#trigger_names #trigger_names} => Array<String>
# * {Types::ListTriggersResponse#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_triggers({
# next_token: "GenericString",
# dependent_job_name: "NameString",
@@ -6271,10 +6318,12 @@
# @return [Types::ListWorkflowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListWorkflowsResponse#workflows #workflows} => Array<String>
# * {Types::ListWorkflowsResponse#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_workflows({
# next_token: "GenericString",
# max_results: 1,
@@ -6487,10 +6536,12 @@
# @return [Types::SearchTablesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::SearchTablesResponse#next_token #next_token} => String
# * {Types::SearchTablesResponse#table_list #table_list} => 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.search_tables({
# catalog_id: "CatalogIdString",
# next_token: "Token",
@@ -7232,11 +7283,11 @@
# catalog_id: "CatalogIdString",
# name: "NameString", # required
# connection_input: { # required
# name: "NameString", # required
# description: "DescriptionString",
- # connection_type: "JDBC", # required, accepts JDBC, SFTP
+ # connection_type: "JDBC", # required, accepts JDBC, SFTP, MONGODB
# match_criteria: ["NameString"],
# connection_properties: { # required
# "HOST" => "ValueString",
# },
# physical_connection_requirements: {
@@ -8074,10 +8125,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-glue'
- context[:gem_version] = '1.50.0'
+ context[:gem_version] = '1.51.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated