aws-sdk-launchwizard 1.0.0

data/lib/aws-sdk-launchwizard/types.rb

@@ -0,0 +1,655 @@
+# 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::LaunchWizard
+  module Types
+
+    # @!attribute [rw] 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
+    #   @return [String]
+    #
+    # @!attribute [rw] 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`.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] name
+    #   The name of the deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] specifications
+    #   The settings specified for the deployment. For more information on
+    #   the specifications required for creating a deployment, see [Workload
+    #   specifications][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications.html
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] workload_name
+    #   The name of the 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
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/CreateDeploymentInput AWS API Documentation
+    #
+    class CreateDeploymentInput < Struct.new(
+      :deployment_pattern_name,
+      :dry_run,
+      :name,
+      :specifications,
+      :workload_name)
+      SENSITIVE = [:specifications]
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] deployment_id
+    #   The ID of the deployment.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/CreateDeploymentOutput AWS API Documentation
+    #
+    class CreateDeploymentOutput < Struct.new(
+      :deployment_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] deployment_id
+    #   The ID of the deployment.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/DeleteDeploymentInput AWS API Documentation
+    #
+    class DeleteDeploymentInput < Struct.new(
+      :deployment_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] status
+    #   The status of the deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] status_reason
+    #   The reason for the deployment status.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/DeleteDeploymentOutput AWS API Documentation
+    #
+    class DeleteDeploymentOutput < Struct.new(
+      :status,
+      :status_reason)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The data associated with a deployment.
+    #
+    # @!attribute [rw] created_at
+    #   The time the deployment was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] deleted_at
+    #   The time the deployment was deleted.
+    #   @return [Time]
+    #
+    # @!attribute [rw] id
+    #   The ID of the deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] name
+    #   The name of the deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] pattern_name
+    #   The pattern name of the deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_group
+    #   The resource group of the deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] specifications
+    #   The specifications of the deployment. For more information on
+    #   specifications for each deployment, see [Workload
+    #   specifications][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications.html
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] status
+    #   The status of the deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] workload_name
+    #   The name of the workload.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/DeploymentData AWS API Documentation
+    #
+    class DeploymentData < Struct.new(
+      :created_at,
+      :deleted_at,
+      :id,
+      :name,
+      :pattern_name,
+      :resource_group,
+      :specifications,
+      :status,
+      :workload_name)
+      SENSITIVE = [:specifications]
+      include Aws::Structure
+    end
+
+    # A summary of the deployment data.
+    #
+    # @!attribute [rw] created_at
+    #   The time the deployment was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] id
+    #   The ID of the deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] name
+    #   The name of the deployment
+    #   @return [String]
+    #
+    # @!attribute [rw] pattern_name
+    #   The name of the workload deployment pattern.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] workload_name
+    #   The name of the workload.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/DeploymentDataSummary AWS API Documentation
+    #
+    class DeploymentDataSummary < Struct.new(
+      :created_at,
+      :id,
+      :name,
+      :pattern_name,
+      :status,
+      :workload_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A summary of the deployment event data.
+    #
+    # @!attribute [rw] description
+    #   The description of the deployment event.
+    #   @return [String]
+    #
+    # @!attribute [rw] name
+    #   The name of the deployment event.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the deployment event.
+    #   @return [String]
+    #
+    # @!attribute [rw] status_reason
+    #   The reason of the deployment event status.
+    #   @return [String]
+    #
+    # @!attribute [rw] timestamp
+    #   The timestamp of the deployment event.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/DeploymentEventDataSummary AWS API Documentation
+    #
+    class DeploymentEventDataSummary < Struct.new(
+      :description,
+      :name,
+      :status,
+      :status_reason,
+      :timestamp)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A filter name and value pair that is used to return more specific
+    # results from a describe operation. Filters can be used to match a set
+    # of resources by specific criteria.
+    #
+    # @!attribute [rw] name
+    #   The name of the filter. Filter names are case-sensitive.
+    #   @return [String]
+    #
+    # @!attribute [rw] values
+    #   The filter values. Filter values are case-sensitive. If you specify
+    #   multiple values for a filter, the values are joined with an `OR`,
+    #   and the request returns all results that match any of the specified
+    #   values.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/DeploymentFilter AWS API Documentation
+    #
+    class DeploymentFilter < Struct.new(
+      :name,
+      :values)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] deployment_id
+    #   The ID of the deployment.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetDeploymentInput AWS API Documentation
+    #
+    class GetDeploymentInput < Struct.new(
+      :deployment_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] deployment
+    #   An object that details the deployment.
+    #   @return [Types::DeploymentData]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetDeploymentOutput AWS API Documentation
+    #
+    class GetDeploymentOutput < Struct.new(
+      :deployment)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] workload_name
+    #   The name of the workload.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetWorkloadInput AWS API Documentation
+    #
+    class GetWorkloadInput < Struct.new(
+      :workload_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] workload
+    #   Information about the workload.
+    #   @return [Types::WorkloadData]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetWorkloadOutput AWS API Documentation
+    #
+    class GetWorkloadOutput < Struct.new(
+      :workload)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # An internal error has occurred. Retry your request, but if the problem
+    # persists, contact us with details by posting a question on
+    # [re:Post][1].
+    #
+    #
+    #
+    # [1]: https://repost.aws/
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/InternalServerException AWS API Documentation
+    #
+    class InternalServerException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] deployment_id
+    #   The ID of the deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] 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.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   The token returned from a previous paginated request. Pagination
+    #   continues from the end of the items returned by the previous
+    #   request.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListDeploymentEventsInput AWS API Documentation
+    #
+    class ListDeploymentEventsInput < Struct.new(
+      :deployment_id,
+      :max_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] deployment_events
+    #   Lists the deployment events.
+    #   @return [Array<Types::DeploymentEventDataSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   The token to include in another request to get the next page of
+    #   items. This value is `null` when there are no more items to return.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListDeploymentEventsOutput AWS API Documentation
+    #
+    class ListDeploymentEventsOutput < Struct.new(
+      :deployment_events,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] filters
+    #   Filters to scope the results. The following filters are supported:
+    #
+    #   * `WORKLOAD_NAME`
+    #
+    #   * `DEPLOYMENT_STATUS`
+    #   @return [Array<Types::DeploymentFilter>]
+    #
+    # @!attribute [rw] 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.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   The token returned from a previous paginated request. Pagination
+    #   continues from the end of the items returned by the previous
+    #   request.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListDeploymentsInput AWS API Documentation
+    #
+    class ListDeploymentsInput < Struct.new(
+      :filters,
+      :max_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] deployments
+    #   Lists the deployments.
+    #   @return [Array<Types::DeploymentDataSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   The token to include in another request to get the next page of
+    #   items. This value is `null` when there are no more items to return.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListDeploymentsOutput AWS API Documentation
+    #
+    class ListDeploymentsOutput < Struct.new(
+      :deployments,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] 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.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   The token returned from a previous paginated request. Pagination
+    #   continues from the end of the items returned by the previous
+    #   request.
+    #   @return [String]
+    #
+    # @!attribute [rw] workload_name
+    #   The name of the workload.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListWorkloadDeploymentPatternsInput AWS API Documentation
+    #
+    class ListWorkloadDeploymentPatternsInput < Struct.new(
+      :max_results,
+      :next_token,
+      :workload_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] next_token
+    #   The token to include in another request to get the next page of
+    #   items. This value is `null` when there are no more items to return.
+    #   @return [String]
+    #
+    # @!attribute [rw] workload_deployment_patterns
+    #   Describes the workload deployment patterns.
+    #   @return [Array<Types::WorkloadDeploymentPatternDataSummary>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListWorkloadDeploymentPatternsOutput AWS API Documentation
+    #
+    class ListWorkloadDeploymentPatternsOutput < Struct.new(
+      :next_token,
+      :workload_deployment_patterns)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] 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.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   The token returned from a previous paginated request. Pagination
+    #   continues from the end of the items returned by the previous
+    #   request.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListWorkloadsInput AWS API Documentation
+    #
+    class ListWorkloadsInput < Struct.new(
+      :max_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] next_token
+    #   The token to include in another request to get the next page of
+    #   items. This value is `null` when there are no more items to return.
+    #   @return [String]
+    #
+    # @!attribute [rw] workloads
+    #   Information about the workloads.
+    #   @return [Array<Types::WorkloadDataSummary>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListWorkloadsOutput AWS API Documentation
+    #
+    class ListWorkloadsOutput < Struct.new(
+      :next_token,
+      :workloads)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # You have exceeded an Launch Wizard resource limit. For example, you
+    # might have too many deployments in progress.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ResourceLimitException AWS API Documentation
+    #
+    class ResourceLimitException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The specified workload or deployment resource can't be found.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ResourceNotFoundException AWS API Documentation
+    #
+    class ResourceNotFoundException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The input fails to satisfy the constraints specified by an Amazon Web
+    # Services service.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ValidationException AWS API Documentation
+    #
+    class ValidationException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Describes a workload.
+    #
+    # @!attribute [rw] description
+    #   The description of a workload.
+    #   @return [String]
+    #
+    # @!attribute [rw] display_name
+    #   The display name of a workload.
+    #   @return [String]
+    #
+    # @!attribute [rw] documentation_url
+    #   The URL of a workload document.
+    #   @return [String]
+    #
+    # @!attribute [rw] icon_url
+    #   The URL of a workload icon.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of a workload.
+    #   @return [String]
+    #
+    # @!attribute [rw] status_message
+    #   The message about a workload's status.
+    #   @return [String]
+    #
+    # @!attribute [rw] workload_name
+    #   The name of the workload.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/WorkloadData AWS API Documentation
+    #
+    class WorkloadData < Struct.new(
+      :description,
+      :display_name,
+      :documentation_url,
+      :icon_url,
+      :status,
+      :status_message,
+      :workload_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Describes workload data.
+    #
+    # @!attribute [rw] display_name
+    #   The display name of the workload data.
+    #   @return [String]
+    #
+    # @!attribute [rw] workload_name
+    #   The name of the workload.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/WorkloadDataSummary AWS API Documentation
+    #
+    class WorkloadDataSummary < Struct.new(
+      :display_name,
+      :workload_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Describes a workload deployment pattern.
+    #
+    # @!attribute [rw] deployment_pattern_name
+    #   The name of a workload deployment pattern.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   The description of a workload deployment pattern.
+    #   @return [String]
+    #
+    # @!attribute [rw] display_name
+    #   The display name of a workload deployment pattern.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of a workload deployment pattern.
+    #   @return [String]
+    #
+    # @!attribute [rw] status_message
+    #   A message about a workload deployment pattern's status.
+    #   @return [String]
+    #
+    # @!attribute [rw] workload_name
+    #   The name of the workload.
+    #   @return [String]
+    #
+    # @!attribute [rw] workload_version_name
+    #   The name of the workload deployment pattern version.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/WorkloadDeploymentPatternDataSummary AWS API Documentation
+    #
+    class WorkloadDeploymentPatternDataSummary < Struct.new(
+      :deployment_pattern_name,
+      :description,
+      :display_name,
+      :status,
+      :status_message,
+      :workload_name,
+      :workload_version_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+  end
+end

data/lib/aws-sdk-launchwizard.rb

@@ -0,0 +1,57 @@
+# 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 'aws-sdk-core'
+require 'aws-sigv4'
+
+require_relative 'aws-sdk-launchwizard/types'
+require_relative 'aws-sdk-launchwizard/client_api'
+require_relative 'aws-sdk-launchwizard/plugins/endpoints.rb'
+require_relative 'aws-sdk-launchwizard/client'
+require_relative 'aws-sdk-launchwizard/errors'
+require_relative 'aws-sdk-launchwizard/resource'
+require_relative 'aws-sdk-launchwizard/endpoint_parameters'
+require_relative 'aws-sdk-launchwizard/endpoint_provider'
+require_relative 'aws-sdk-launchwizard/endpoints'
+require_relative 'aws-sdk-launchwizard/customizations'
+
+# This module provides support for AWS Launch Wizard. This module is available in the
+# `aws-sdk-launchwizard` gem.
+#
+# # Client
+#
+# The {Client} class provides one method for each API operation. Operation
+# methods each accept a hash of request parameters and return a response
+# structure.
+#
+#     launch_wizard = Aws::LaunchWizard::Client.new
+#     resp = launch_wizard.create_deployment(params)
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from AWS Launch Wizard are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::LaunchWizard::Errors::ServiceError
+#       # rescues all AWS Launch Wizard API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @!group service
+module Aws::LaunchWizard
+
+  GEM_VERSION = '1.0.0'
+
+end