# 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/invocation_id.rb' require 'aws-sdk-core/plugins/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/client_metrics_plugin.rb' require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb' require 'aws-sdk-core/plugins/transfer_encoding.rb' require 'aws-sdk-core/plugins/http_checksum.rb' require 'aws-sdk-core/plugins/checksum_algorithm.rb' require 'aws-sdk-core/plugins/request_compression.rb' require 'aws-sdk-core/plugins/defaults_mode.rb' require 'aws-sdk-core/plugins/recursion_detection.rb' require 'aws-sdk-core/plugins/sign.rb' require 'aws-sdk-core/plugins/protocols/rest_json.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:launchwizard) module Aws::LaunchWizard # An API client for LaunchWizard. To construct a client, you need to configure a `:region` and `:credentials`. # # client = Aws::LaunchWizard::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 = :launchwizard 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::InvocationId) add_plugin(Aws::Plugins::JsonvalueConverter) add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) add_plugin(Aws::Plugins::TransferEncoding) add_plugin(Aws::Plugins::HttpChecksum) add_plugin(Aws::Plugins::ChecksumAlgorithm) add_plugin(Aws::Plugins::RequestCompression) add_plugin(Aws::Plugins::DefaultsMode) add_plugin(Aws::Plugins::RecursionDetection) add_plugin(Aws::Plugins::Sign) add_plugin(Aws::Plugins::Protocols::RestJson) add_plugin(Aws::LaunchWizard::Plugins::Endpoints) # @overload initialize(options) # @param [Hash] options # # @option options [Array] :plugins ([]]) # A list of plugins to apply to the client. Each plugin is either a # class name or an instance of a plugin class. # # @option options [required, Aws::CredentialProvider] :credentials # Your AWS credentials. This can be an instance of any one of the # following classes: # # * `Aws::Credentials` - Used for configuring static, non-refreshing # credentials. # # * `Aws::SharedCredentials` - Used for loading static credentials from a # shared file, such as `~/.aws/config`. # # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. # # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to # assume a role after providing credentials via the web. # # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an # access token generated from `aws login`. # # * `Aws::ProcessCredentials` - Used for loading credentials from a # process that outputs to stdout. # # * `Aws::InstanceProfileCredentials` - Used for loading credentials # from an EC2 IMDS on an EC2 instance. # # * `Aws::ECSCredentials` - Used for loading credentials from # instances running in ECS. # # * `Aws::CognitoIdentityCredentials` - Used for loading credentials # from the Cognito Identity service. # # When `:credentials` are not configured directly, the following # locations will be searched for credentials: # # * `Aws.config[:credentials]` # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] # * `~/.aws/credentials` # * `~/.aws/config` # * EC2/ECS IMDS instance profile - When used by default, the timeouts # are very aggressive. Construct and pass an instance of # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to # enable retries and extended timeouts. Instance profile credential # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] # to true. # # @option options [required, String] :region # The AWS region to connect to. The configured `:region` is # used to determine the service `:endpoint`. When not passed, # a default `:region` is searched for in the following locations: # # * `Aws.config[:region]` # * `ENV['AWS_REGION']` # * `ENV['AMAZON_REGION']` # * `ENV['AWS_DEFAULT_REGION']` # * `~/.aws/credentials` # * `~/.aws/config` # # @option options [String] :access_key_id # # @option options [Boolean] :active_endpoint_cache (false) # When set to `true`, a thread polling for endpoints will be running in # the background every 60 secs (default). Defaults to `false`. # # @option options [Boolean] :adaptive_retry_wait_to_fill (true) # Used only in `adaptive` retry mode. When true, the request will sleep # until there is sufficent client side capacity to retry the request. # When false, the request will raise a `RetryCapacityNotAvailableError` and will # not retry instead of sleeping. # # @option options [Boolean] :client_side_monitoring (false) # When `true`, client-side metrics will be collected for all API requests from # this client. # # @option options [String] :client_side_monitoring_client_id ("") # Allows you to provide an identifier for this client which will be attached to # all generated client side metrics. Defaults to an empty string. # # @option options [String] :client_side_monitoring_host ("127.0.0.1") # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client # side monitoring agent is running on, where client metrics will be published via UDP. # # @option options [Integer] :client_side_monitoring_port (31000) # Required for publishing client metrics. The port that the client side monitoring # agent is running on, where client metrics will be published via UDP. # # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) # Allows you to provide a custom client-side monitoring publisher class. By default, # will use the Client Side Monitoring Agent Publisher. # # @option options [Boolean] :convert_params (true) # When `true`, an attempt is made to coerce request parameters into # the required types. # # @option options [Boolean] :correct_clock_skew (true) # Used only in `standard` and adaptive retry modes. Specifies whether to apply # a clock skew correction and retry requests with skewed client clocks. # # @option options [String] :defaults_mode ("legacy") # See {Aws::DefaultsModeConfiguration} for a list of the # accepted modes and the configuration defaults that are included. # # @option options [Boolean] :disable_host_prefix_injection (false) # Set to true to disable SDK automatically adding host prefix # to default service endpoint when available. # # @option options [Boolean] :disable_request_compression (false) # When set to 'true' the request body will not be compressed # for supported operations. # # @option options [String, URI::HTTPS, URI::HTTP] :endpoint # Normally you should not configure the `:endpoint` option # directly. This is normally constructed from the `:region` # option. Configuring `:endpoint` is normally reserved for # connecting to test or custom endpoints. The endpoint should # be a URI formatted like: # # 'http://example.com' # 'https://example.com' # 'http://example.com:123' # # @option options [Integer] :endpoint_cache_max_entries (1000) # Used for the maximum size limit of the LRU cache storing endpoints data # for endpoint discovery enabled operations. Defaults to 1000. # # @option options [Integer] :endpoint_cache_max_threads (10) # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. # # @option options [Integer] :endpoint_cache_poll_interval (60) # When :endpoint_discovery and :active_endpoint_cache is enabled, # Use this option to config the time interval in seconds for making # requests fetching endpoints information. Defaults to 60 sec. # # @option options [Boolean] :endpoint_discovery (false) # When set to `true`, endpoint discovery will be enabled for operations when available. # # @option options [Boolean] :ignore_configured_endpoint_urls # Setting to true disables use of endpoint URLs provided via environment # variables and the shared configuration file. # # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) # The log formatter. # # @option options [Symbol] :log_level (:info) # The log level to send messages to the `:logger` at. # # @option options [Logger] :logger # The Logger instance to send log messages to. If this option # is not set, logging will be disabled. # # @option options [Integer] :max_attempts (3) # An integer representing the maximum number attempts that will be made for # a single request, including the initial attempt. For example, # setting this value to 5 will result in a request being retried up to # 4 times. Used in `standard` and `adaptive` retry modes. # # @option options [String] :profile ("default") # Used when loading credentials from the shared credentials file # at HOME/.aws/credentials. When not specified, 'default' is used. # # @option options [Integer] :request_min_compression_size_bytes (10240) # The minimum size in bytes that triggers compression for request # bodies. The value must be non-negative integer value between 0 # and 10485780 bytes inclusive. # # @option options [Proc] :retry_backoff # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. # This option is only used in the `legacy` retry mode. # # @option options [Float] :retry_base_delay (0.3) # The base delay in seconds used by the default backoff function. This option # is only used in the `legacy` retry mode. # # @option options [Symbol] :retry_jitter (:none) # A delay randomiser function used by the default backoff function. # Some predefined functions can be referenced by name - :none, :equal, :full, # otherwise a Proc that takes and returns a number. This option is only used # in the `legacy` retry mode. # # @see https://www.awsarchitectureblog.com/2015/03/backoff.html # # @option options [Integer] :retry_limit (3) # The maximum number of times to retry failed requests. Only # ~ 500 level server errors and certain ~ 400 level client errors # are retried. Generally, these are throttling errors, data # checksum errors, networking errors, timeout errors, auth errors, # endpoint discovery, and errors from expired credentials. # This option is only used in the `legacy` retry mode. # # @option options [Integer] :retry_max_delay (0) # The maximum number of seconds to delay between retries (0 for no limit) # used by the default backoff function. This option is only used in the # `legacy` retry mode. # # @option options [String] :retry_mode ("legacy") # Specifies which retry algorithm to use. Values are: # # * `legacy` - The pre-existing retry behavior. This is default value if # no retry mode is provided. # # * `standard` - A standardized set of retry rules across the AWS SDKs. # This includes support for retry quotas, which limit the number of # unsuccessful retries a client can make. # # * `adaptive` - An experimental retry mode that includes all the # functionality of `standard` mode along with automatic client side # throttling. This is a provisional mode that may change behavior # in the future. # # @option options [String] :sdk_ua_app_id # A unique and opaque application ID that is appended to the # User-Agent header as app/sdk_ua_app_id. It should have a # maximum length of 50. This variable is sourced from environment # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. # # @option options [String] :secret_access_key # # @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. # # ** Please note ** When response stubbing is enabled, no HTTP # requests are made, and retries are disabled. # # @option options [Aws::TokenProvider] :token_provider # A Bearer Token Provider. This can be an instance of any one of the # following classes: # # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing # tokens. # # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an # access token generated from `aws login`. # # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain` # will be used to search for tokens configured for your profile in shared configuration files. # # @option options [Boolean] :use_dualstack_endpoint # When set to `true`, dualstack enabled endpoints (with `.aws` TLD) # will be used if available. # # @option options [Boolean] :use_fips_endpoint # When set to `true`, fips compatible endpoints will be used if available. # When a `fips` region is used, the region is normalized and this config # is set to `true`. # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # # @option options [Aws::LaunchWizard::EndpointProvider] :endpoint_provider # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::LaunchWizard::EndpointParameters` # # @option options [Float] :http_continue_timeout (1) # The number of seconds to wait for a 100-continue response before sending the # request body. This option has no effect unless the request has "Expect" # header set to "100-continue". Defaults to `nil` which disables this # behaviour. This value can safely be set per request on the session. # # @option options [Float] :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_open_timeout (15) # The default number of seconds to wait for response data. # This value can safely be set per-request on the session. # # @option options [URI::HTTP,String] :http_proxy # A proxy to send requests through. Formatted like 'http://proxy.com:123'. # # @option options [Float] :http_read_timeout (60) # The default number of seconds to wait for response data. # This value can safely be set per-request on the session. # # @option options [Boolean] :http_wire_trace (false) # When `true`, HTTP debug output will be sent to the `:logger`. # # @option options [Proc] :on_chunk_received # When a Proc object is provided, it will be used as callback when each chunk # of the response body is received. It provides three arguments: the chunk, # the number of bytes received, and the total number of # bytes in the response (or nil if the server did not send a `content-length`). # # @option options [Proc] :on_chunk_sent # When a Proc object is provided, it will be used as callback when each chunk # of the request body is sent. It provides three arguments: the chunk, # the number of bytes read from the body, and the total number of # bytes in the body. # # @option options [Boolean] :raise_response_errors (true) # When `true`, response errors are raised. # # @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. # # @option options [String] :ssl_ca_store # Sets the X509::Store to verify peer certificate. # # @option options [Float] :ssl_timeout # Sets the SSL timeout in seconds # # @option options [Boolean] :ssl_verify_peer (true) # When `true`, SSL peer certificates are verified when establishing a connection. # def initialize(*args) super end # @!group API Operations # Creates a deployment for the given workload. Deployments created by # this operation are not available in the Launch Wizard console to use # the `Clone deployment` action on. # # @option params [required, String] :deployment_pattern_name # The name of the deployment pattern supported by a given workload. You # can use the [ `ListWorkloadDeploymentPatterns` ][1] operation to # discover supported values for this parameter. # # # # [1]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html # # @option params [Boolean] :dry_run # Checks whether you have the required permissions for the action, # without actually making the request, and provides an error response. # If you have the required permissions, the error response is # `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. # # @option params [required, String] :name # The name of the deployment. # # @option params [required, Hash] :specifications # The settings specified for the deployment. These settings define how # to deploy and configure your resources created by the deployment. For # more information about the specifications required for creating a # deployment for a SAP workload, see [SAP deployment specifications][1]. # To retrieve the specifications required to create a deployment for # other workloads, use the [ `GetWorkloadDeploymentPattern` ][2] # operation. # # # # [1]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications-sap.html # [2]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_GetWorkloadDeploymentPattern.html # # @option params [Hash] :tags # The tags to add to the deployment. # # @option params [required, String] :workload_name # The name of the workload. You can use the [ `ListWorkloads` ][1] # operation to discover supported values for this parameter. # # # # [1]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloads.html # # @return [Types::CreateDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDeploymentOutput#deployment_id #deployment_id} => String # # @example Request syntax with placeholder values # # resp = client.create_deployment({ # deployment_pattern_name: "DeploymentPatternName", # required # dry_run: false, # name: "DeploymentName", # required # specifications: { # required # "KeyString" => "ValueString", # }, # tags: { # "TagKey" => "TagValue", # }, # workload_name: "WorkloadName", # required # }) # # @example Response structure # # resp.deployment_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/CreateDeployment AWS API Documentation # # @overload create_deployment(params = {}) # @param [Hash] params ({}) def create_deployment(params = {}, options = {}) req = build_request(:create_deployment, params) req.send_request(options) end # Deletes a deployment. # # @option params [required, String] :deployment_id # The ID of the deployment. # # @return [Types::DeleteDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteDeploymentOutput#status #status} => String # * {Types::DeleteDeploymentOutput#status_reason #status_reason} => String # # @example Request syntax with placeholder values # # resp = client.delete_deployment({ # deployment_id: "DeploymentId", # required # }) # # @example Response structure # # resp.status #=> String, one of "COMPLETED", "CREATING", "DELETE_IN_PROGRESS", "DELETE_INITIATING", "DELETE_FAILED", "DELETED", "FAILED", "IN_PROGRESS", "VALIDATING" # resp.status_reason #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/DeleteDeployment AWS API Documentation # # @overload delete_deployment(params = {}) # @param [Hash] params ({}) def delete_deployment(params = {}, options = {}) req = build_request(:delete_deployment, params) req.send_request(options) end # Returns information about the deployment. # # @option params [required, String] :deployment_id # The ID of the deployment. # # @return [Types::GetDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetDeploymentOutput#deployment #deployment} => Types::DeploymentData # # @example Request syntax with placeholder values # # resp = client.get_deployment({ # deployment_id: "DeploymentId", # required # }) # # @example Response structure # # resp.deployment.created_at #=> Time # resp.deployment.deleted_at #=> Time # resp.deployment.deployment_arn #=> String # resp.deployment.id #=> String # resp.deployment.name #=> String # resp.deployment.pattern_name #=> String # resp.deployment.resource_group #=> String # resp.deployment.specifications #=> Hash # resp.deployment.specifications["KeyString"] #=> String # resp.deployment.status #=> String, one of "COMPLETED", "CREATING", "DELETE_IN_PROGRESS", "DELETE_INITIATING", "DELETE_FAILED", "DELETED", "FAILED", "IN_PROGRESS", "VALIDATING" # resp.deployment.tags #=> Hash # resp.deployment.tags["TagKey"] #=> String # resp.deployment.workload_name #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetDeployment AWS API Documentation # # @overload get_deployment(params = {}) # @param [Hash] params ({}) def get_deployment(params = {}, options = {}) req = build_request(:get_deployment, params) req.send_request(options) end # Returns information about a workload. # # @option params [required, String] :workload_name # The name of the workload. # # @return [Types::GetWorkloadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetWorkloadOutput#workload #workload} => Types::WorkloadData # # @example Request syntax with placeholder values # # resp = client.get_workload({ # workload_name: "WorkloadName", # required # }) # # @example Response structure # # resp.workload.description #=> String # resp.workload.display_name #=> String # resp.workload.documentation_url #=> String # resp.workload.icon_url #=> String # resp.workload.status #=> String, one of "ACTIVE", "INACTIVE", "DISABLED", "DELETED" # resp.workload.status_message #=> String # resp.workload.workload_name #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetWorkload AWS API Documentation # # @overload get_workload(params = {}) # @param [Hash] params ({}) def get_workload(params = {}, options = {}) req = build_request(:get_workload, params) req.send_request(options) end # Returns details for a given workload and deployment pattern, including # the available specifications. You can use the [ListWorkloads][1] # operation to discover the available workload names and the # [ListWorkloadDeploymentPatterns][2] operation to discover the # available deployment pattern names of a given workload. # # # # [1]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloads.html # [2]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html # # @option params [required, String] :deployment_pattern_name # The name of the deployment pattern. # # @option params [required, String] :workload_name # The name of the workload. # # @return [Types::GetWorkloadDeploymentPatternOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetWorkloadDeploymentPatternOutput#workload_deployment_pattern #workload_deployment_pattern} => Types::WorkloadDeploymentPatternData # # @example Request syntax with placeholder values # # resp = client.get_workload_deployment_pattern({ # deployment_pattern_name: "DeploymentPatternName", # required # workload_name: "WorkloadName", # required # }) # # @example Response structure # # resp.workload_deployment_pattern.deployment_pattern_name #=> String # resp.workload_deployment_pattern.description #=> String # resp.workload_deployment_pattern.display_name #=> String # resp.workload_deployment_pattern.specifications #=> Array # resp.workload_deployment_pattern.specifications[0].allowed_values #=> Array # resp.workload_deployment_pattern.specifications[0].allowed_values[0] #=> String # resp.workload_deployment_pattern.specifications[0].conditionals #=> Array # resp.workload_deployment_pattern.specifications[0].conditionals[0].comparator #=> String # resp.workload_deployment_pattern.specifications[0].conditionals[0].name #=> String # resp.workload_deployment_pattern.specifications[0].conditionals[0].value #=> String # resp.workload_deployment_pattern.specifications[0].description #=> String # resp.workload_deployment_pattern.specifications[0].name #=> String # resp.workload_deployment_pattern.specifications[0].required #=> String # resp.workload_deployment_pattern.status #=> String, one of "ACTIVE", "INACTIVE", "DISABLED", "DELETED" # resp.workload_deployment_pattern.status_message #=> String # resp.workload_deployment_pattern.workload_name #=> String # resp.workload_deployment_pattern.workload_version_name #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetWorkloadDeploymentPattern AWS API Documentation # # @overload get_workload_deployment_pattern(params = {}) # @param [Hash] params ({}) def get_workload_deployment_pattern(params = {}, options = {}) req = build_request(:get_workload_deployment_pattern, params) req.send_request(options) end # Lists the events of a deployment. # # @option params [required, String] :deployment_id # The ID of the deployment. # # @option params [Integer] :max_results # The maximum number of items to return for this request. To get the # next page of items, make another request with the token returned in # the output. # # @option params [String] :next_token # The token returned from a previous paginated request. Pagination # continues from the end of the items returned by the previous request. # # @return [Types::ListDeploymentEventsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListDeploymentEventsOutput#deployment_events #deployment_events} => Array<Types::DeploymentEventDataSummary> # * {Types::ListDeploymentEventsOutput#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_deployment_events({ # deployment_id: "DeploymentId", # required # max_results: 1, # next_token: "NextToken", # }) # # @example Response structure # # resp.deployment_events #=> Array # resp.deployment_events[0].description #=> String # resp.deployment_events[0].name #=> String # resp.deployment_events[0].status #=> String, one of "CANCELED", "CANCELING", "COMPLETED", "CREATED", "FAILED", "IN_PROGRESS", "PENDING", "TIMED_OUT" # resp.deployment_events[0].status_reason #=> String # resp.deployment_events[0].timestamp #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListDeploymentEvents AWS API Documentation # # @overload list_deployment_events(params = {}) # @param [Hash] params ({}) def list_deployment_events(params = {}, options = {}) req = build_request(:list_deployment_events, params) req.send_request(options) end # Lists the deployments that have been created. # # @option params [Array] :filters # Filters to scope the results. The following filters are supported: # # * `WORKLOAD_NAME` - The name used in deployments. # # * `DEPLOYMENT_STATUS` - `COMPLETED` \| `CREATING` \| # `DELETE_IN_PROGRESS` \| `DELETE_INITIATING` \| `DELETE_FAILED` \| # `DELETED` \| `FAILED` \| `IN_PROGRESS` \| `VALIDATING` # # @option params [Integer] :max_results # The maximum number of items to return for this request. To get the # next page of items, make another request with the token returned in # the output. # # @option params [String] :next_token # The token returned from a previous paginated request. Pagination # continues from the end of the items returned by the previous request. # # @return [Types::ListDeploymentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListDeploymentsOutput#deployments #deployments} => Array<Types::DeploymentDataSummary> # * {Types::ListDeploymentsOutput#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_deployments({ # filters: [ # { # name: "WORKLOAD_NAME", # accepts WORKLOAD_NAME, DEPLOYMENT_STATUS # values: ["DeploymentFilterValuesMemberString"], # }, # ], # max_results: 1, # next_token: "NextToken", # }) # # @example Response structure # # resp.deployments #=> Array # resp.deployments[0].created_at #=> Time # resp.deployments[0].id #=> String # resp.deployments[0].name #=> String # resp.deployments[0].pattern_name #=> String # resp.deployments[0].status #=> String, one of "COMPLETED", "CREATING", "DELETE_IN_PROGRESS", "DELETE_INITIATING", "DELETE_FAILED", "DELETED", "FAILED", "IN_PROGRESS", "VALIDATING" # resp.deployments[0].workload_name #=> String # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListDeployments AWS API Documentation # # @overload list_deployments(params = {}) # @param [Hash] params ({}) def list_deployments(params = {}, options = {}) req = build_request(:list_deployments, params) req.send_request(options) end # Lists the tags associated with a specified resource. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the resource. # # @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForResourceOutput#tags #tags} => Hash<String,String> # # @example Request syntax with placeholder values # # resp = client.list_tags_for_resource({ # resource_arn: "String", # required # }) # # @example Response structure # # resp.tags #=> Hash # resp.tags["TagKey"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListTagsForResource AWS API Documentation # # @overload list_tags_for_resource(params = {}) # @param [Hash] params ({}) def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end # Lists the workload deployment patterns for a given workload name. You # can use the [ListWorkloads][1] operation to discover the available # workload names. # # # # [1]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloads.html # # @option params [Integer] :max_results # The maximum number of items to return for this request. To get the # next page of items, make another request with the token returned in # the output. # # @option params [String] :next_token # The token returned from a previous paginated request. Pagination # continues from the end of the items returned by the previous request. # # @option params [required, String] :workload_name # The name of the workload. # # @return [Types::ListWorkloadDeploymentPatternsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListWorkloadDeploymentPatternsOutput#next_token #next_token} => String # * {Types::ListWorkloadDeploymentPatternsOutput#workload_deployment_patterns #workload_deployment_patterns} => Array<Types::WorkloadDeploymentPatternDataSummary> # # 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_workload_deployment_patterns({ # max_results: 1, # next_token: "NextToken", # workload_name: "WorkloadName", # required # }) # # @example Response structure # # resp.next_token #=> String # resp.workload_deployment_patterns #=> Array # resp.workload_deployment_patterns[0].deployment_pattern_name #=> String # resp.workload_deployment_patterns[0].description #=> String # resp.workload_deployment_patterns[0].display_name #=> String # resp.workload_deployment_patterns[0].status #=> String, one of "ACTIVE", "INACTIVE", "DISABLED", "DELETED" # resp.workload_deployment_patterns[0].status_message #=> String # resp.workload_deployment_patterns[0].workload_name #=> String # resp.workload_deployment_patterns[0].workload_version_name #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListWorkloadDeploymentPatterns AWS API Documentation # # @overload list_workload_deployment_patterns(params = {}) # @param [Hash] params ({}) def list_workload_deployment_patterns(params = {}, options = {}) req = build_request(:list_workload_deployment_patterns, params) req.send_request(options) end # Lists the available workload names. You can use the # [ListWorkloadDeploymentPatterns][1] operation to discover the # available deployment patterns for a given workload. # # # # [1]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html # # @option params [Integer] :max_results # The maximum number of items to return for this request. To get the # next page of items, make another request with the token returned in # the output. # # @option params [String] :next_token # The token returned from a previous paginated request. Pagination # continues from the end of the items returned by the previous request. # # @return [Types::ListWorkloadsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListWorkloadsOutput#next_token #next_token} => String # * {Types::ListWorkloadsOutput#workloads #workloads} => Array<Types::WorkloadDataSummary> # # 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_workloads({ # max_results: 1, # next_token: "NextToken", # }) # # @example Response structure # # resp.next_token #=> String # resp.workloads #=> Array # resp.workloads[0].display_name #=> String # resp.workloads[0].workload_name #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListWorkloads AWS API Documentation # # @overload list_workloads(params = {}) # @param [Hash] params ({}) def list_workloads(params = {}, options = {}) req = build_request(:list_workloads, params) req.send_request(options) end # Adds the specified tags to the given resource. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the resource. # # @option params [required, Hash] :tags # One or more tags to attach to the resource. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.tag_resource({ # resource_arn: "String", # required # tags: { # required # "TagKey" => "TagValue", # }, # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/TagResource AWS API Documentation # # @overload tag_resource(params = {}) # @param [Hash] params ({}) def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end # Removes the specified tags from the given resource. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the resource. # # @option params [required, Array] :tag_keys # Keys identifying the tags to remove. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.untag_resource({ # resource_arn: "String", # required # tag_keys: ["TagKey"], # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/UntagResource AWS API Documentation # # @overload untag_resource(params = {}) # @param [Hash] params ({}) def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end # @!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-launchwizard' context[:gem_version] = '1.8.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