lib/aws-sdk-glacier/client.rb in aws-sdk-glacier-1.12.0 vs lib/aws-sdk-glacier/client.rb in aws-sdk-glacier-1.13.0
- old
+ new
@@ -58,130 +58,132 @@
add_plugin(Aws::Plugins::Protocols::RestJson)
add_plugin(Aws::Glacier::Plugins::AccountId)
add_plugin(Aws::Glacier::Plugins::ApiVersion)
add_plugin(Aws::Glacier::Plugins::Checksums)
- # @option options [required, Aws::CredentialProvider] :credentials
- # Your AWS credentials. This can be an instance of any one of the
- # following classes:
+ # @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::Credentials` - Used for configuring static, non-refreshing
+ # credentials.
#
- # * `Aws::InstanceProfileCredentials` - Used for loading credentials
- # from an EC2 IMDS on an EC2 instance.
+ # * `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::SharedCredentials` - Used for loading credentials from a
+ # shared file, such as `~/.aws/config`.
#
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
#
- # When `:credentials` are not configured directly, the following
- # locations will be searched for credentials:
+ # 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 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.
+ # * `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 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.
#
- # @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 search for in the following locations:
+ # @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 search for in the following locations:
#
- # * `Aws.config[:region]`
- # * `ENV['AWS_REGION']`
- # * `ENV['AMAZON_REGION']`
- # * `ENV['AWS_DEFAULT_REGION']`
- # * `~/.aws/credentials`
- # * `~/.aws/config`
+ # * `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 [String] :access_key_id
#
- # @option options [String] :account_id ("-")
- # The default Glacier AWS account ID to use for all glacier
- # operations. The default value of `-` uses the account
- # your `:credentials` belong to.
+ # @option options [String] :account_id ("-")
+ # The default Glacier AWS account ID to use for all glacier
+ # operations. The default value of `-` uses the account
+ # your `:credentials` belong to.
#
- # @option options [Boolean] :client_side_monitoring (false)
- # When `true`, client-side metrics will be collected for all API requests from
- # this client.
+ # @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_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 [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 [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 [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] :convert_params (true)
+ # When `true`, an attempt is made to coerce request parameters into
+ # the required types.
#
- # @option options [String] :endpoint
- # 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.
+ # @option options [String] :endpoint
+ # 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.
#
- # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
- # The log formatter.
+ # @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 [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 [Logger] :logger
+ # The Logger instance to send log messages to. If this option
+ # is not set, logging will be disabled.
#
- # @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 [String] :profile ("default")
+ # Used when loading credentials from the shared credentials file
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
#
- # @option options [Float] :retry_base_delay (0.3)
- # The base delay in seconds used by the default backoff function.
+ # @option options [Float] :retry_base_delay (0.3)
+ # The base delay in seconds used by the default backoff function.
#
- # @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.
+ # @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.
#
- # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
+ # @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 and auth
- # errors from expired credentials.
+ # @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 and auth
+ # errors from expired credentials.
#
- # @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.
+ # @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.
#
- # @option options [String] :secret_access_key
+ # @option options [String] :secret_access_key
#
- # @option options [String] :session_token
+ # @option options [String] :session_token
#
- # @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.
+ # @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.
+ # ** Please note ** When response stubbing is enabled, no HTTP
+ # requests are made, and retries are disabled.
#
- # @option options [Boolean] :validate_params (true)
- # When `true`, request parameters are validated before
- # sending the request.
+ # @option options [Boolean] :validate_params (true)
+ # When `true`, request parameters are validated before
+ # sending the request.
#
def initialize(*args)
super
end
@@ -3208,10 +3210,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-glacier'
- context[:gem_version] = '1.12.0'
+ context[:gem_version] = '1.13.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#