require 'aws-sdk-core' # 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 module Aws::CodeDeployCommand module Types # This exception indicates that the request failed due to the fault of # the customer (either an invalid request was provided, referred to a # non-existant object, or another reason within the client's control). # class ClientException < Aws::EmptyStructure; end # The DeploymentSpecification contains an envelope for the generic # client metadata, and if there is variant-specific metadata, the ID of # the variant for the host and the envelope containing that variant's # metadata. All fields are optional, though an empty # DeploymentSpecification is likely indicative of an error. # # @!attribute [rw] generic_envelope # For an Envelope used for host command diagnostics, Format is limited # to 64 characters and Payload is limited to 8192 characters. # @return [Types::Envelope] # # @!attribute [rw] variant_id # @return [String] # # @!attribute [rw] variant_envelope # For an Envelope used for host command diagnostics, Format is limited # to 64 characters and Payload is limited to 8192 characters. # @return [Types::Envelope] # class DeploymentSpecification < Struct.new( :generic_envelope, :variant_id, :variant_envelope) SENSITIVE = [] include Aws::Structure end # For an Envelope used for host command diagnostics, Format is limited # to 64 characters and Payload is limited to 8192 characters. # # @note When making an API call, you may pass Envelope # data as a hash: # # { # format: "Format", # payload: "Payload", # } # # @!attribute [rw] format # @return [String] # # @!attribute [rw] payload # @return [String] # class Envelope < Struct.new( :format, :payload) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetDeploymentSpecificationInput # data as a hash: # # { # deployment_execution_id: "DeploymentExecutionId", # required # host_identifier: "HostIdentifier", # required # } # # @!attribute [rw] deployment_execution_id # @return [String] # # @!attribute [rw] host_identifier # An identifier for referring to a unit of capacity. # @return [String] # class GetDeploymentSpecificationInput < Struct.new( :deployment_execution_id, :host_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] deployment_system # @return [String] # # @!attribute [rw] deployment_specification # The DeploymentSpecification contains an envelope for the generic # client metadata, and if there is variant-specific metadata, the ID # of the variant for the host and the envelope containing that # variant's metadata. All fields are optional, though an empty # DeploymentSpecification is likely indicative of an error. # @return [Types::DeploymentSpecification] # class GetDeploymentSpecificationOutput < Struct.new( :deployment_system, :deployment_specification) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] host_command_identifier # @return [String] # # @!attribute [rw] host_identifier # An identifier for referring to a unit of capacity. # @return [String] # # @!attribute [rw] deployment_execution_id # @return [String] # # @!attribute [rw] command_name # @return [String] # # @!attribute [rw] nonce # @return [Integer] # class HostCommandInstance < Struct.new( :host_command_identifier, :host_identifier, :deployment_execution_id, :command_name, :nonce) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass PollHostCommandInput # data as a hash: # # { # host_identifier: "HostIdentifier", # required # } # # @!attribute [rw] host_identifier # An identifier for referring to a unit of capacity. # @return [String] # class PollHostCommandInput < Struct.new( :host_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] host_command # @return [Types::HostCommandInstance] # class PollHostCommandOutput < Struct.new( :host_command) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass PostHostCommandUpdateInput # data as a hash: # # { # host_command_identifier: "HostCommandIdentifier", # required # estimated_completion_time: Time.now, # diagnostics: { # format: "Format", # payload: "Payload", # }, # } # # @!attribute [rw] host_command_identifier # @return [String] # # @!attribute [rw] estimated_completion_time # @return [Time] # # @!attribute [rw] diagnostics # For an Envelope used for host command diagnostics, Format is limited # to 64 characters and Payload is limited to 8192 characters. # @return [Types::Envelope] # class PostHostCommandUpdateInput < Struct.new( :host_command_identifier, :estimated_completion_time, :diagnostics) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] command_status # @return [String] # class PostHostCommandUpdateOutput < Struct.new( :command_status) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass PutHostCommandAcknowledgementInput # data as a hash: # # { # host_command_identifier: "HostCommandIdentifier", # required # diagnostics: { # format: "Format", # payload: "Payload", # }, # } # # @!attribute [rw] host_command_identifier # @return [String] # # @!attribute [rw] diagnostics # For an Envelope used for host command diagnostics, Format is limited # to 64 characters and Payload is limited to 8192 characters. # @return [Types::Envelope] # class PutHostCommandAcknowledgementInput < Struct.new( :host_command_identifier, :diagnostics) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] command_status # @return [String] # class PutHostCommandAcknowledgementOutput < Struct.new( :command_status) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass PutHostCommandCompleteInput # data as a hash: # # { # host_command_identifier: "HostCommandIdentifier", # required # command_status: "Pending", # required, accepts Pending, InProgress, Succeeded, Failed # diagnostics: { # format: "Format", # payload: "Payload", # }, # } # # @!attribute [rw] host_command_identifier # @return [String] # # @!attribute [rw] command_status # @return [String] # # @!attribute [rw] diagnostics # For an Envelope used for host command diagnostics, Format is limited # to 64 characters and Payload is limited to 8192 characters. # @return [Types::Envelope] # class PutHostCommandCompleteInput < Struct.new( :host_command_identifier, :command_status, :diagnostics) SENSITIVE = [] include Aws::Structure end # This exception indicates that the request failed due to a problem on # the server, or with the server's dependencies. # class ServerException < Aws::EmptyStructure; end end end # 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 module Aws::CodeDeployCommand # @api private module ClientApi include Seahorse::Model ClientException = Shapes::StructureShape.new(name: 'ClientException') DeploymentCommandName = Shapes::StringShape.new(name: 'DeploymentCommandName') DeploymentCommandStatus = Shapes::StringShape.new(name: 'DeploymentCommandStatus') DeploymentExecutionId = Shapes::StringShape.new(name: 'DeploymentExecutionId') DeploymentSpecification = Shapes::StructureShape.new(name: 'DeploymentSpecification') Envelope = Shapes::StructureShape.new(name: 'Envelope') Format = Shapes::StringShape.new(name: 'Format') GenericDateTimestamp = Shapes::TimestampShape.new(name: 'GenericDateTimestamp') GenericLong = Shapes::IntegerShape.new(name: 'GenericLong') GenericString = Shapes::StringShape.new(name: 'GenericString') GetDeploymentSpecificationInput = Shapes::StructureShape.new(name: 'GetDeploymentSpecificationInput') GetDeploymentSpecificationOutput = Shapes::StructureShape.new(name: 'GetDeploymentSpecificationOutput') HostCommandIdentifier = Shapes::StringShape.new(name: 'HostCommandIdentifier') HostCommandInstance = Shapes::StructureShape.new(name: 'HostCommandInstance') HostIdentifier = Shapes::StringShape.new(name: 'HostIdentifier') Payload = Shapes::StringShape.new(name: 'Payload') PollHostCommandInput = Shapes::StructureShape.new(name: 'PollHostCommandInput') PollHostCommandOutput = Shapes::StructureShape.new(name: 'PollHostCommandOutput') PostHostCommandUpdateInput = Shapes::StructureShape.new(name: 'PostHostCommandUpdateInput') PostHostCommandUpdateOutput = Shapes::StructureShape.new(name: 'PostHostCommandUpdateOutput') PutHostCommandAcknowledgementInput = Shapes::StructureShape.new(name: 'PutHostCommandAcknowledgementInput') PutHostCommandAcknowledgementOutput = Shapes::StructureShape.new(name: 'PutHostCommandAcknowledgementOutput') PutHostCommandCompleteInput = Shapes::StructureShape.new(name: 'PutHostCommandCompleteInput') ServerException = Shapes::StructureShape.new(name: 'ServerException') VariantId = Shapes::StringShape.new(name: 'VariantId') ClientException.struct_class = Types::ClientException DeploymentSpecification.add_member(:generic_envelope, Shapes::ShapeRef.new(shape: Envelope, location_name: "GenericEnvelope")) DeploymentSpecification.add_member(:variant_id, Shapes::ShapeRef.new(shape: VariantId, location_name: "VariantId")) DeploymentSpecification.add_member(:variant_envelope, Shapes::ShapeRef.new(shape: Envelope, location_name: "VariantEnvelope")) DeploymentSpecification.struct_class = Types::DeploymentSpecification Envelope.add_member(:format, Shapes::ShapeRef.new(shape: Format, location_name: "Format")) Envelope.add_member(:payload, Shapes::ShapeRef.new(shape: Payload, location_name: "Payload")) Envelope.struct_class = Types::Envelope GetDeploymentSpecificationInput.add_member(:deployment_execution_id, Shapes::ShapeRef.new(shape: DeploymentExecutionId, required: true, location_name: "DeploymentExecutionId")) GetDeploymentSpecificationInput.add_member(:host_identifier, Shapes::ShapeRef.new(shape: HostIdentifier, required: true, location_name: "HostIdentifier")) GetDeploymentSpecificationInput.struct_class = Types::GetDeploymentSpecificationInput GetDeploymentSpecificationOutput.add_member(:deployment_system, Shapes::ShapeRef.new(shape: GenericString, location_name: "DeploymentSystem")) GetDeploymentSpecificationOutput.add_member(:deployment_specification, Shapes::ShapeRef.new(shape: DeploymentSpecification, location_name: "DeploymentSpecification")) GetDeploymentSpecificationOutput.struct_class = Types::GetDeploymentSpecificationOutput HostCommandInstance.add_member(:host_command_identifier, Shapes::ShapeRef.new(shape: HostCommandIdentifier, location_name: "HostCommandIdentifier")) HostCommandInstance.add_member(:host_identifier, Shapes::ShapeRef.new(shape: HostIdentifier, location_name: "HostIdentifier")) HostCommandInstance.add_member(:deployment_execution_id, Shapes::ShapeRef.new(shape: DeploymentExecutionId, location_name: "DeploymentExecutionId")) HostCommandInstance.add_member(:command_name, Shapes::ShapeRef.new(shape: DeploymentCommandName, location_name: "CommandName")) HostCommandInstance.add_member(:nonce, Shapes::ShapeRef.new(shape: GenericLong, location_name: "Nonce")) HostCommandInstance.struct_class = Types::HostCommandInstance PollHostCommandInput.add_member(:host_identifier, Shapes::ShapeRef.new(shape: HostIdentifier, required: true, location_name: "HostIdentifier")) PollHostCommandInput.struct_class = Types::PollHostCommandInput PollHostCommandOutput.add_member(:host_command, Shapes::ShapeRef.new(shape: HostCommandInstance, location_name: "HostCommand")) PollHostCommandOutput.struct_class = Types::PollHostCommandOutput PostHostCommandUpdateInput.add_member(:host_command_identifier, Shapes::ShapeRef.new(shape: HostCommandIdentifier, required: true, location_name: "HostCommandIdentifier")) PostHostCommandUpdateInput.add_member(:estimated_completion_time, Shapes::ShapeRef.new(shape: GenericDateTimestamp, location_name: "EstimatedCompletionTime")) PostHostCommandUpdateInput.add_member(:diagnostics, Shapes::ShapeRef.new(shape: Envelope, location_name: "Diagnostics")) PostHostCommandUpdateInput.struct_class = Types::PostHostCommandUpdateInput PostHostCommandUpdateOutput.add_member(:command_status, Shapes::ShapeRef.new(shape: DeploymentCommandStatus, location_name: "CommandStatus")) PostHostCommandUpdateOutput.struct_class = Types::PostHostCommandUpdateOutput PutHostCommandAcknowledgementInput.add_member(:host_command_identifier, Shapes::ShapeRef.new(shape: HostCommandIdentifier, required: true, location_name: "HostCommandIdentifier")) PutHostCommandAcknowledgementInput.add_member(:diagnostics, Shapes::ShapeRef.new(shape: Envelope, location_name: "Diagnostics")) PutHostCommandAcknowledgementInput.struct_class = Types::PutHostCommandAcknowledgementInput PutHostCommandAcknowledgementOutput.add_member(:command_status, Shapes::ShapeRef.new(shape: DeploymentCommandStatus, location_name: "CommandStatus")) PutHostCommandAcknowledgementOutput.struct_class = Types::PutHostCommandAcknowledgementOutput PutHostCommandCompleteInput.add_member(:host_command_identifier, Shapes::ShapeRef.new(shape: HostCommandIdentifier, required: true, location_name: "HostCommandIdentifier")) PutHostCommandCompleteInput.add_member(:command_status, Shapes::ShapeRef.new(shape: DeploymentCommandStatus, required: true, location_name: "CommandStatus")) PutHostCommandCompleteInput.add_member(:diagnostics, Shapes::ShapeRef.new(shape: Envelope, location_name: "Diagnostics")) PutHostCommandCompleteInput.struct_class = Types::PutHostCommandCompleteInput ServerException.struct_class = Types::ServerException # @api private API = Seahorse::Model::Api.new.tap do |api| api.version = "2019-11-11" api.metadata = { "apiVersion" => "2019-11-11", "endpointPrefix" => "codedeploy-commands-secure", "jsonVersion" => "1.1", "protocol" => "json", "serviceAbbreviation" => "CodeDeployCommandSecure", "serviceFullName" => "AWS CodeDeploy Command Service", "signatureVersion" => "v4", "targetPrefix" => "CodeDeployCommandService", } api.add_operation(:get_deployment_specification, Seahorse::Model::Operation.new.tap do |o| o.name = "GetDeploymentSpecification" o.http_method = "POST" o.http_request_uri = "/" o.input = Shapes::ShapeRef.new(shape: GetDeploymentSpecificationInput) o.output = Shapes::ShapeRef.new(shape: GetDeploymentSpecificationOutput) o.errors << Shapes::ShapeRef.new(shape: ClientException) o.errors << Shapes::ShapeRef.new(shape: ServerException) end) api.add_operation(:poll_host_command, Seahorse::Model::Operation.new.tap do |o| o.name = "PollHostCommand" o.http_method = "POST" o.http_request_uri = "/" o.input = Shapes::ShapeRef.new(shape: PollHostCommandInput) o.output = Shapes::ShapeRef.new(shape: PollHostCommandOutput) o.errors << Shapes::ShapeRef.new(shape: ClientException) o.errors << Shapes::ShapeRef.new(shape: ServerException) end) api.add_operation(:post_host_command_update, Seahorse::Model::Operation.new.tap do |o| o.name = "PostHostCommandUpdate" o.http_method = "POST" o.http_request_uri = "/" o.input = Shapes::ShapeRef.new(shape: PostHostCommandUpdateInput) o.output = Shapes::ShapeRef.new(shape: PostHostCommandUpdateOutput) o.errors << Shapes::ShapeRef.new(shape: ClientException) o.errors << Shapes::ShapeRef.new(shape: ServerException) end) api.add_operation(:put_host_command_acknowledgement, Seahorse::Model::Operation.new.tap do |o| o.name = "PutHostCommandAcknowledgement" o.http_method = "POST" o.http_request_uri = "/" o.input = Shapes::ShapeRef.new(shape: PutHostCommandAcknowledgementInput) o.output = Shapes::ShapeRef.new(shape: PutHostCommandAcknowledgementOutput) o.errors << Shapes::ShapeRef.new(shape: ClientException) o.errors << Shapes::ShapeRef.new(shape: ServerException) end) api.add_operation(:put_host_command_complete, Seahorse::Model::Operation.new.tap do |o| o.name = "PutHostCommandComplete" o.http_method = "POST" o.http_request_uri = "/" o.input = Shapes::ShapeRef.new(shape: PutHostCommandCompleteInput) o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure)) o.errors << Shapes::ShapeRef.new(shape: ClientException) o.errors << Shapes::ShapeRef.new(shape: ServerException) end) end end end # 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/signature_v4.rb' require 'aws-sdk-core/plugins/protocols/json_rpc.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:codedeploycommand) module Aws::CodeDeployCommand # An API client for CodeDeployCommand. To construct a client, you need to configure a `:region` and `:credentials`. # # client = Aws::CodeDeployCommand::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 = :codedeploycommand 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::SignatureV4) add_plugin(Aws::Plugins::Protocols::JsonRpc) # @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. # # @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 [Boolean] :disable_host_prefix_injection (false) # Set to true to disable SDK automatically adding host prefix # to default service endpoint when available. # # @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 [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 [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] :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 [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # # @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 [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. # # @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 [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 # Retrieve the deployment specification for the deployment and host, # consisting of the client metadata provided when the deployment was # created. The generic client metadata will be provided, as well as the # client metadata for the host's variant (if variant-specific metadata # was provided). Throws DeploymentNotFoundException if the # DeploymentExecutionId does not identify a current deployment. Throws # HostNotFoundException if the host is not recognized by the deployment # engine. Throws ServerException for failures caused by the deployment # system or its dependencies. # # @option params [required, String] :deployment_execution_id # # @option params [required, String] :host_identifier # An identifier for referring to a unit of capacity. # # @return [Types::GetDeploymentSpecificationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetDeploymentSpecificationOutput#deployment_system #deployment_system} => String # * {Types::GetDeploymentSpecificationOutput#deployment_specification #deployment_specification} => Types::DeploymentSpecification # # @example Request syntax with placeholder values # # resp = client.get_deployment_specification({ # deployment_execution_id: "DeploymentExecutionId", # required # host_identifier: "HostIdentifier", # required # }) # # @example Response structure # # resp.deployment_system #=> String # resp.deployment_specification.generic_envelope.format #=> String # resp.deployment_specification.generic_envelope.payload #=> String # resp.deployment_specification.variant_id #=> String # resp.deployment_specification.variant_envelope.format #=> String # resp.deployment_specification.variant_envelope.payload #=> String # # @overload get_deployment_specification(params = {}) # @param [Hash] params ({}) def get_deployment_specification(params = {}, options = {}) req = build_request(:get_deployment_specification, params) req.send_request(options) end # This requests a command from the deployment workflow engine. If no # command is ready to be dispatched, the output will be empty # (HostCommand will be null). Throws HostNotFoundException if the host # is not recognized by the deployment engine. Throws ServerException for # failures caused by the deployment system or its dependencies. # # @option params [required, String] :host_identifier # An identifier for referring to a unit of capacity. # # @return [Types::PollHostCommandOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::PollHostCommandOutput#host_command #host_command} => Types::HostCommandInstance # # @example Request syntax with placeholder values # # resp = client.poll_host_command({ # host_identifier: "HostIdentifier", # required # }) # # @example Response structure # # resp.host_command.host_command_identifier #=> String # resp.host_command.host_identifier #=> String # resp.host_command.deployment_execution_id #=> String # resp.host_command.command_name #=> String # resp.host_command.nonce #=> Integer # # @overload poll_host_command(params = {}) # @param [Hash] params ({}) def poll_host_command(params = {}, options = {}) req = build_request(:poll_host_command, params) req.send_request(options) end # This updates the central workflow engine with the current progress of # the host command. This will also return the status of the host command # centrally if possible, so agents can skip processing the command if it # has been aborted / timed out. However, the status is optional, so if # no status is returned the agent should treat it as if it was ok to # continue. Throws ClientException for an invalid HostCommandIdentifier # or Diagnostics. Throws ServerException for failures caused by the # deployment system or its dependencies. # # @option params [required, String] :host_command_identifier # # @option params [Time,DateTime,Date,Integer,String] :estimated_completion_time # # @option params [Types::Envelope] :diagnostics # For an Envelope used for host command diagnostics, Format is limited # to 64 characters and Payload is limited to 8192 characters. # # @return [Types::PostHostCommandUpdateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::PostHostCommandUpdateOutput#command_status #command_status} => String # # @example Request syntax with placeholder values # # resp = client.post_host_command_update({ # host_command_identifier: "HostCommandIdentifier", # required # estimated_completion_time: Time.now, # diagnostics: { # format: "Format", # payload: "Payload", # }, # }) # # @example Response structure # # resp.command_status #=> String, one of "Pending", "InProgress", "Succeeded", "Failed" # # @overload post_host_command_update(params = {}) # @param [Hash] params ({}) def post_host_command_update(params = {}, options = {}) req = build_request(:post_host_command_update, params) req.send_request(options) end # This notifies the central workflow engine that the agent has received # the specified command and is ready to start execution. This will also # return the status of the host command centrally if possible, so agents # can skip processing the command if it has been aborted / timed out. # However, the status is optional, so if no status is returned the agent # should treat it as if it was ok to continue. Throws ClientException # for an invalid HostCommandIdentifier or Diagnostics. Throws # ServerException for failures caused by the deployment system or its # dependencies. # # @option params [required, String] :host_command_identifier # # @option params [Types::Envelope] :diagnostics # For an Envelope used for host command diagnostics, Format is limited # to 64 characters and Payload is limited to 8192 characters. # # @return [Types::PutHostCommandAcknowledgementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::PutHostCommandAcknowledgementOutput#command_status #command_status} => String # # @example Request syntax with placeholder values # # resp = client.put_host_command_acknowledgement({ # host_command_identifier: "HostCommandIdentifier", # required # diagnostics: { # format: "Format", # payload: "Payload", # }, # }) # # @example Response structure # # resp.command_status #=> String, one of "Pending", "InProgress", "Succeeded", "Failed" # # @overload put_host_command_acknowledgement(params = {}) # @param [Hash] params ({}) def put_host_command_acknowledgement(params = {}, options = {}) req = build_request(:put_host_command_acknowledgement, params) req.send_request(options) end # This reports completion of the command back to the workflow engine. # Throws ClientException for an invalid HostCommandIdentifier or # Diagnostics. Throws ServerException for failures caused by the # deployment system or its dependencies. # # @option params [required, String] :host_command_identifier # # @option params [required, String] :command_status # # @option params [Types::Envelope] :diagnostics # For an Envelope used for host command diagnostics, Format is limited # to 64 characters and Payload is limited to 8192 characters. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.put_host_command_complete({ # host_command_identifier: "HostCommandIdentifier", # required # command_status: "Pending", # required, accepts Pending, InProgress, Succeeded, Failed # diagnostics: { # format: "Format", # payload: "Payload", # }, # }) # # @overload put_host_command_complete(params = {}) # @param [Hash] params ({}) def put_host_command_complete(params = {}, options = {}) req = build_request(:put_host_command_complete, 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-codedeploycommand' context[:gem_version] = '1.0.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 # 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 module Aws::CodeDeployCommand # When CodeDeployCommand returns an error response, the Ruby SDK constructs and raises an error. # These errors all extend Aws::CodeDeployCommand::Errors::ServiceError < {Aws::Errors::ServiceError} # # You can rescue all CodeDeployCommand errors using ServiceError: # # begin # # do stuff # rescue Aws::CodeDeployCommand::Errors::ServiceError # # rescues all CodeDeployCommand API errors # end # # # ## Request Context # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns # information about the request that generated the error. # See {Seahorse::Client::RequestContext} for more information. # # ## Error Classes # * {ClientException} # * {ServerException} # # Additionally, error classes are dynamically generated for service errors based on the error code # if they are not defined above. module Errors extend Aws::Errors::DynamicErrors class ClientException < ServiceError # @param [Seahorse::Client::RequestContext] context # @param [String] message # @param [Aws::CodeDeployCommand::Types::ClientException] data def initialize(context, message, data = Aws::EmptyStructure.new) super(context, message, data) end end class ServerException < ServiceError # @param [Seahorse::Client::RequestContext] context # @param [String] message # @param [Aws::CodeDeployCommand::Types::ServerException] data def initialize(context, message, data = Aws::EmptyStructure.new) super(context, message, data) end end end end # 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 module Aws::CodeDeployCommand class Resource # @param options ({}) # @option options [Client] :client def initialize(options = {}) @client = options[:client] || Client.new(options) end # @return [Client] def client @client end end end