launchwizard

package
v0.0.0-...-ce01f02 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 27, 2024 License: Apache-2.0, Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package launchwizard provides the client and types for making API requests to AWS Launch Wizard.

Launch Wizard offers a guided way of sizing, configuring, and deploying Amazon Web Services resources for third party applications, such as Microsoft SQL Server Always On and HANA based SAP systems, without the need to manually identify and provision individual Amazon Web Services resources.

See https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10 for more information on this service.

See launchwizard package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/launchwizard/

Using the Client

To contact AWS Launch Wizard with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Launch Wizard client LaunchWizard for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/launchwizard/#New

Index

Constants

View Source
const (
	// DeploymentFilterKeyWorkloadName is a DeploymentFilterKey enum value
	DeploymentFilterKeyWorkloadName = "WORKLOAD_NAME"

	// DeploymentFilterKeyDeploymentStatus is a DeploymentFilterKey enum value
	DeploymentFilterKeyDeploymentStatus = "DEPLOYMENT_STATUS"
)
View Source
const (
	// DeploymentStatusCompleted is a DeploymentStatus enum value
	DeploymentStatusCompleted = "COMPLETED"

	// DeploymentStatusCreating is a DeploymentStatus enum value
	DeploymentStatusCreating = "CREATING"

	// DeploymentStatusDeleteInProgress is a DeploymentStatus enum value
	DeploymentStatusDeleteInProgress = "DELETE_IN_PROGRESS"

	// DeploymentStatusDeleteInitiating is a DeploymentStatus enum value
	DeploymentStatusDeleteInitiating = "DELETE_INITIATING"

	// DeploymentStatusDeleteFailed is a DeploymentStatus enum value
	DeploymentStatusDeleteFailed = "DELETE_FAILED"

	// DeploymentStatusDeleted is a DeploymentStatus enum value
	DeploymentStatusDeleted = "DELETED"

	// DeploymentStatusFailed is a DeploymentStatus enum value
	DeploymentStatusFailed = "FAILED"

	// DeploymentStatusInProgress is a DeploymentStatus enum value
	DeploymentStatusInProgress = "IN_PROGRESS"

	// DeploymentStatusValidating is a DeploymentStatus enum value
	DeploymentStatusValidating = "VALIDATING"
)
View Source
const (
	// EventStatusCanceled is a EventStatus enum value
	EventStatusCanceled = "CANCELED"

	// EventStatusCanceling is a EventStatus enum value
	EventStatusCanceling = "CANCELING"

	// EventStatusCompleted is a EventStatus enum value
	EventStatusCompleted = "COMPLETED"

	// EventStatusCreated is a EventStatus enum value
	EventStatusCreated = "CREATED"

	// EventStatusFailed is a EventStatus enum value
	EventStatusFailed = "FAILED"

	// EventStatusInProgress is a EventStatus enum value
	EventStatusInProgress = "IN_PROGRESS"

	// EventStatusPending is a EventStatus enum value
	EventStatusPending = "PENDING"

	// EventStatusTimedOut is a EventStatus enum value
	EventStatusTimedOut = "TIMED_OUT"
)
View Source
const (
	// WorkloadDeploymentPatternStatusActive is a WorkloadDeploymentPatternStatus enum value
	WorkloadDeploymentPatternStatusActive = "ACTIVE"

	// WorkloadDeploymentPatternStatusInactive is a WorkloadDeploymentPatternStatus enum value
	WorkloadDeploymentPatternStatusInactive = "INACTIVE"

	// WorkloadDeploymentPatternStatusDisabled is a WorkloadDeploymentPatternStatus enum value
	WorkloadDeploymentPatternStatusDisabled = "DISABLED"

	// WorkloadDeploymentPatternStatusDeleted is a WorkloadDeploymentPatternStatus enum value
	WorkloadDeploymentPatternStatusDeleted = "DELETED"
)
View Source
const (
	// WorkloadStatusActive is a WorkloadStatus enum value
	WorkloadStatusActive = "ACTIVE"

	// WorkloadStatusInactive is a WorkloadStatus enum value
	WorkloadStatusInactive = "INACTIVE"

	// WorkloadStatusDisabled is a WorkloadStatus enum value
	WorkloadStatusDisabled = "DISABLED"

	// WorkloadStatusDeleted is a WorkloadStatus enum value
	WorkloadStatusDeleted = "DELETED"
)
View Source
const (

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An internal error has occurred. Retry your request, but if the problem persists,
	// contact us with details by posting a question on re:Post (https://repost.aws/).
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceLimitException for service response error code
	// "ResourceLimitException".
	//
	// You have exceeded an Launch Wizard resource limit. For example, you might
	// have too many deployments in progress.
	ErrCodeResourceLimitException = "ResourceLimitException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified workload or deployment resource can't be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints specified by an Amazon Web Services
	// service.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "Launch Wizard" // Name of service.
	EndpointsID = "launchwizard"  // ID to lookup a service endpoint with.
	ServiceID   = "Launch Wizard" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func DeploymentFilterKey_Values

func DeploymentFilterKey_Values() []string

DeploymentFilterKey_Values returns all elements of the DeploymentFilterKey enum

func DeploymentStatus_Values

func DeploymentStatus_Values() []string

DeploymentStatus_Values returns all elements of the DeploymentStatus enum

func EventStatus_Values

func EventStatus_Values() []string

EventStatus_Values returns all elements of the EventStatus enum

func WorkloadDeploymentPatternStatus_Values

func WorkloadDeploymentPatternStatus_Values() []string

WorkloadDeploymentPatternStatus_Values returns all elements of the WorkloadDeploymentPatternStatus enum

func WorkloadStatus_Values

func WorkloadStatus_Values() []string

WorkloadStatus_Values returns all elements of the WorkloadStatus enum

Types

type CreateDeploymentInput

type CreateDeploymentInput struct {

	// The name of the deployment pattern supported by a given workload. You can
	// use the ListWorkloadDeploymentPatterns (https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html)
	// operation to discover supported values for this parameter.
	//
	// DeploymentPatternName is a required field
	DeploymentPatternName *string `locationName:"deploymentPatternName" min:"1" type:"string" required:"true"`

	// 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.
	DryRun *bool `locationName:"dryRun" type:"boolean"`

	// The name of the deployment.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The settings specified for the deployment. For more information on the specifications
	// required for creating a deployment, see Workload specifications (https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications.html).
	//
	// Specifications is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateDeploymentInput's
	// String and GoString methods.
	//
	// Specifications is a required field
	Specifications map[string]*string `locationName:"specifications" min:"1" type:"map" required:"true" sensitive:"true"`

	// The name of the workload. You can use the ListWorkloadDeploymentPatterns
	// (https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html)
	// operation to discover supported values for this parameter.
	//
	// WorkloadName is a required field
	WorkloadName *string `locationName:"workloadName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDeploymentInput) GoString

func (s CreateDeploymentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeploymentInput) SetDeploymentPatternName

func (s *CreateDeploymentInput) SetDeploymentPatternName(v string) *CreateDeploymentInput

SetDeploymentPatternName sets the DeploymentPatternName field's value.

func (*CreateDeploymentInput) SetDryRun

SetDryRun sets the DryRun field's value.

func (*CreateDeploymentInput) SetName

SetName sets the Name field's value.

func (*CreateDeploymentInput) SetSpecifications

func (s *CreateDeploymentInput) SetSpecifications(v map[string]*string) *CreateDeploymentInput

SetSpecifications sets the Specifications field's value.

func (*CreateDeploymentInput) SetWorkloadName

func (s *CreateDeploymentInput) SetWorkloadName(v string) *CreateDeploymentInput

SetWorkloadName sets the WorkloadName field's value.

func (CreateDeploymentInput) String

func (s CreateDeploymentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeploymentInput) Validate

func (s *CreateDeploymentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDeploymentOutput

type CreateDeploymentOutput struct {

	// The ID of the deployment.
	DeploymentId *string `locationName:"deploymentId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

func (CreateDeploymentOutput) GoString

func (s CreateDeploymentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeploymentOutput) SetDeploymentId

func (s *CreateDeploymentOutput) SetDeploymentId(v string) *CreateDeploymentOutput

SetDeploymentId sets the DeploymentId field's value.

func (CreateDeploymentOutput) String

func (s CreateDeploymentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDeploymentInput

type DeleteDeploymentInput struct {

	// The ID of the deployment.
	//
	// DeploymentId is a required field
	DeploymentId *string `locationName:"deploymentId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDeploymentInput) GoString

func (s DeleteDeploymentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDeploymentInput) SetDeploymentId

func (s *DeleteDeploymentInput) SetDeploymentId(v string) *DeleteDeploymentInput

SetDeploymentId sets the DeploymentId field's value.

func (DeleteDeploymentInput) String

func (s DeleteDeploymentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDeploymentInput) Validate

func (s *DeleteDeploymentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDeploymentOutput

type DeleteDeploymentOutput struct {

	// The status of the deployment.
	Status *string `locationName:"status" type:"string" enum:"DeploymentStatus"`

	// The reason for the deployment status.
	StatusReason *string `locationName:"statusReason" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteDeploymentOutput) GoString

func (s DeleteDeploymentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDeploymentOutput) SetStatus

SetStatus sets the Status field's value.

func (*DeleteDeploymentOutput) SetStatusReason

func (s *DeleteDeploymentOutput) SetStatusReason(v string) *DeleteDeploymentOutput

SetStatusReason sets the StatusReason field's value.

func (DeleteDeploymentOutput) String

func (s DeleteDeploymentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeploymentData

type DeploymentData struct {

	// The time the deployment was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The time the deployment was deleted.
	DeletedAt *time.Time `locationName:"deletedAt" type:"timestamp"`

	// The ID of the deployment.
	Id *string `locationName:"id" min:"2" type:"string"`

	// The name of the deployment.
	Name *string `locationName:"name" type:"string"`

	// The pattern name of the deployment.
	PatternName *string `locationName:"patternName" min:"1" type:"string"`

	// The resource group of the deployment.
	ResourceGroup *string `locationName:"resourceGroup" type:"string"`

	// The specifications of the deployment. For more information on specifications
	// for each deployment, see Workload specifications (https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications.html).
	//
	// Specifications is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeploymentData's
	// String and GoString methods.
	Specifications map[string]*string `locationName:"specifications" min:"1" type:"map" sensitive:"true"`

	// The status of the deployment.
	Status *string `locationName:"status" type:"string" enum:"DeploymentStatus"`

	// The name of the workload.
	WorkloadName *string `locationName:"workloadName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The data associated with a deployment.

func (DeploymentData) GoString

func (s DeploymentData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentData) SetCreatedAt

func (s *DeploymentData) SetCreatedAt(v time.Time) *DeploymentData

SetCreatedAt sets the CreatedAt field's value.

func (*DeploymentData) SetDeletedAt

func (s *DeploymentData) SetDeletedAt(v time.Time) *DeploymentData

SetDeletedAt sets the DeletedAt field's value.

func (*DeploymentData) SetId

func (s *DeploymentData) SetId(v string) *DeploymentData

SetId sets the Id field's value.

func (*DeploymentData) SetName

func (s *DeploymentData) SetName(v string) *DeploymentData

SetName sets the Name field's value.

func (*DeploymentData) SetPatternName

func (s *DeploymentData) SetPatternName(v string) *DeploymentData

SetPatternName sets the PatternName field's value.

func (*DeploymentData) SetResourceGroup

func (s *DeploymentData) SetResourceGroup(v string) *DeploymentData

SetResourceGroup sets the ResourceGroup field's value.

func (*DeploymentData) SetSpecifications

func (s *DeploymentData) SetSpecifications(v map[string]*string) *DeploymentData

SetSpecifications sets the Specifications field's value.

func (*DeploymentData) SetStatus

func (s *DeploymentData) SetStatus(v string) *DeploymentData

SetStatus sets the Status field's value.

func (*DeploymentData) SetWorkloadName

func (s *DeploymentData) SetWorkloadName(v string) *DeploymentData

SetWorkloadName sets the WorkloadName field's value.

func (DeploymentData) String

func (s DeploymentData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeploymentDataSummary

type DeploymentDataSummary struct {

	// The time the deployment was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The ID of the deployment.
	Id *string `locationName:"id" min:"2" type:"string"`

	// The name of the deployment
	Name *string `locationName:"name" type:"string"`

	// The name of the workload deployment pattern.
	PatternName *string `locationName:"patternName" min:"1" type:"string"`

	// The status of the deployment.
	Status *string `locationName:"status" type:"string" enum:"DeploymentStatus"`

	// The name of the workload.
	WorkloadName *string `locationName:"workloadName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

A summary of the deployment data.

func (DeploymentDataSummary) GoString

func (s DeploymentDataSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentDataSummary) SetCreatedAt

SetCreatedAt sets the CreatedAt field's value.

func (*DeploymentDataSummary) SetId

SetId sets the Id field's value.

func (*DeploymentDataSummary) SetName

SetName sets the Name field's value.

func (*DeploymentDataSummary) SetPatternName

func (s *DeploymentDataSummary) SetPatternName(v string) *DeploymentDataSummary

SetPatternName sets the PatternName field's value.

func (*DeploymentDataSummary) SetStatus

SetStatus sets the Status field's value.

func (*DeploymentDataSummary) SetWorkloadName

func (s *DeploymentDataSummary) SetWorkloadName(v string) *DeploymentDataSummary

SetWorkloadName sets the WorkloadName field's value.

func (DeploymentDataSummary) String

func (s DeploymentDataSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeploymentEventDataSummary

type DeploymentEventDataSummary struct {

	// The description of the deployment event.
	Description *string `locationName:"description" type:"string"`

	// The name of the deployment event.
	Name *string `locationName:"name" type:"string"`

	// The status of the deployment event.
	Status *string `locationName:"status" type:"string" enum:"EventStatus"`

	// The reason of the deployment event status.
	StatusReason *string `locationName:"statusReason" type:"string"`

	// The timestamp of the deployment event.
	Timestamp *time.Time `locationName:"timestamp" type:"timestamp"`
	// contains filtered or unexported fields
}

A summary of the deployment event data.

func (DeploymentEventDataSummary) GoString

func (s DeploymentEventDataSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentEventDataSummary) SetDescription

SetDescription sets the Description field's value.

func (*DeploymentEventDataSummary) SetName

SetName sets the Name field's value.

func (*DeploymentEventDataSummary) SetStatus

SetStatus sets the Status field's value.

func (*DeploymentEventDataSummary) SetStatusReason

SetStatusReason sets the StatusReason field's value.

func (*DeploymentEventDataSummary) SetTimestamp

SetTimestamp sets the Timestamp field's value.

func (DeploymentEventDataSummary) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeploymentFilter

type DeploymentFilter struct {

	// The name of the filter. Filter names are case-sensitive.
	Name *string `locationName:"name" type:"string" enum:"DeploymentFilterKey"`

	// 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.
	Values []*string `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

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.

func (DeploymentFilter) GoString

func (s DeploymentFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentFilter) SetName

func (s *DeploymentFilter) SetName(v string) *DeploymentFilter

SetName sets the Name field's value.

func (*DeploymentFilter) SetValues

func (s *DeploymentFilter) SetValues(v []*string) *DeploymentFilter

SetValues sets the Values field's value.

func (DeploymentFilter) String

func (s DeploymentFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDeploymentInput

type GetDeploymentInput struct {

	// The ID of the deployment.
	//
	// DeploymentId is a required field
	DeploymentId *string `locationName:"deploymentId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDeploymentInput) GoString

func (s GetDeploymentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeploymentInput) SetDeploymentId

func (s *GetDeploymentInput) SetDeploymentId(v string) *GetDeploymentInput

SetDeploymentId sets the DeploymentId field's value.

func (GetDeploymentInput) String

func (s GetDeploymentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeploymentInput) Validate

func (s *GetDeploymentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDeploymentOutput

type GetDeploymentOutput struct {

	// An object that details the deployment.
	Deployment *DeploymentData `locationName:"deployment" type:"structure"`
	// contains filtered or unexported fields
}

func (GetDeploymentOutput) GoString

func (s GetDeploymentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeploymentOutput) SetDeployment

SetDeployment sets the Deployment field's value.

func (GetDeploymentOutput) String

func (s GetDeploymentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetWorkloadInput

type GetWorkloadInput struct {

	// The name of the workload.
	//
	// WorkloadName is a required field
	WorkloadName *string `locationName:"workloadName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetWorkloadInput) GoString

func (s GetWorkloadInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWorkloadInput) SetWorkloadName

func (s *GetWorkloadInput) SetWorkloadName(v string) *GetWorkloadInput

SetWorkloadName sets the WorkloadName field's value.

func (GetWorkloadInput) String

func (s GetWorkloadInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWorkloadInput) Validate

func (s *GetWorkloadInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetWorkloadOutput

type GetWorkloadOutput struct {

	// Information about the workload.
	Workload *WorkloadData `locationName:"workload" type:"structure"`
	// contains filtered or unexported fields
}

func (GetWorkloadOutput) GoString

func (s GetWorkloadOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWorkloadOutput) SetWorkload

func (s *GetWorkloadOutput) SetWorkload(v *WorkloadData) *GetWorkloadOutput

SetWorkload sets the Workload field's value.

func (GetWorkloadOutput) String

func (s GetWorkloadOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post (https://repost.aws/).

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LaunchWizard

type LaunchWizard struct {
	*client.Client
}

LaunchWizard provides the API operation methods for making requests to AWS Launch Wizard. See this package's package overview docs for details on the service.

LaunchWizard methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *LaunchWizard

New creates a new instance of the LaunchWizard client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a LaunchWizard client from just a session.
svc := launchwizard.New(mySession)

// Create a LaunchWizard client with additional configuration
svc := launchwizard.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*LaunchWizard) CreateDeployment

func (c *LaunchWizard) CreateDeployment(input *CreateDeploymentInput) (*CreateDeploymentOutput, error)

CreateDeployment API operation for AWS Launch Wizard.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Launch Wizard's API operation CreateDeployment for usage and error information.

Returned Error Types:

  • ResourceLimitException You have exceeded an Launch Wizard resource limit. For example, you might have too many deployments in progress.

  • InternalServerException An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post (https://repost.aws/).

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The specified workload or deployment resource can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/CreateDeployment

func (*LaunchWizard) CreateDeploymentRequest

func (c *LaunchWizard) CreateDeploymentRequest(input *CreateDeploymentInput) (req *request.Request, output *CreateDeploymentOutput)

CreateDeploymentRequest generates a "aws/request.Request" representing the client's request for the CreateDeployment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDeployment for more information on using the CreateDeployment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDeploymentRequest method.
req, resp := client.CreateDeploymentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/CreateDeployment

func (*LaunchWizard) CreateDeploymentWithContext

func (c *LaunchWizard) CreateDeploymentWithContext(ctx aws.Context, input *CreateDeploymentInput, opts ...request.Option) (*CreateDeploymentOutput, error)

CreateDeploymentWithContext is the same as CreateDeployment with the addition of the ability to pass a context and additional request options.

See CreateDeployment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LaunchWizard) DeleteDeployment

func (c *LaunchWizard) DeleteDeployment(input *DeleteDeploymentInput) (*DeleteDeploymentOutput, error)

DeleteDeployment API operation for AWS Launch Wizard.

Deletes a deployment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Launch Wizard's API operation DeleteDeployment for usage and error information.

Returned Error Types:

  • InternalServerException An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post (https://repost.aws/).

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The specified workload or deployment resource can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/DeleteDeployment

func (*LaunchWizard) DeleteDeploymentRequest

func (c *LaunchWizard) DeleteDeploymentRequest(input *DeleteDeploymentInput) (req *request.Request, output *DeleteDeploymentOutput)

DeleteDeploymentRequest generates a "aws/request.Request" representing the client's request for the DeleteDeployment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDeployment for more information on using the DeleteDeployment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDeploymentRequest method.
req, resp := client.DeleteDeploymentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/DeleteDeployment

func (*LaunchWizard) DeleteDeploymentWithContext

func (c *LaunchWizard) DeleteDeploymentWithContext(ctx aws.Context, input *DeleteDeploymentInput, opts ...request.Option) (*DeleteDeploymentOutput, error)

DeleteDeploymentWithContext is the same as DeleteDeployment with the addition of the ability to pass a context and additional request options.

See DeleteDeployment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LaunchWizard) GetDeployment

func (c *LaunchWizard) GetDeployment(input *GetDeploymentInput) (*GetDeploymentOutput, error)

GetDeployment API operation for AWS Launch Wizard.

Returns information about the deployment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Launch Wizard's API operation GetDeployment for usage and error information.

Returned Error Types:

  • InternalServerException An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post (https://repost.aws/).

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The specified workload or deployment resource can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetDeployment

func (*LaunchWizard) GetDeploymentRequest

func (c *LaunchWizard) GetDeploymentRequest(input *GetDeploymentInput) (req *request.Request, output *GetDeploymentOutput)

GetDeploymentRequest generates a "aws/request.Request" representing the client's request for the GetDeployment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDeployment for more information on using the GetDeployment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDeploymentRequest method.
req, resp := client.GetDeploymentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetDeployment

func (*LaunchWizard) GetDeploymentWithContext

func (c *LaunchWizard) GetDeploymentWithContext(ctx aws.Context, input *GetDeploymentInput, opts ...request.Option) (*GetDeploymentOutput, error)

GetDeploymentWithContext is the same as GetDeployment with the addition of the ability to pass a context and additional request options.

See GetDeployment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LaunchWizard) GetWorkload

func (c *LaunchWizard) GetWorkload(input *GetWorkloadInput) (*GetWorkloadOutput, error)

GetWorkload API operation for AWS Launch Wizard.

Returns information about a workload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Launch Wizard's API operation GetWorkload for usage and error information.

Returned Error Types:

  • InternalServerException An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post (https://repost.aws/).

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The specified workload or deployment resource can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetWorkload

func (*LaunchWizard) GetWorkloadRequest

func (c *LaunchWizard) GetWorkloadRequest(input *GetWorkloadInput) (req *request.Request, output *GetWorkloadOutput)

GetWorkloadRequest generates a "aws/request.Request" representing the client's request for the GetWorkload operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetWorkload for more information on using the GetWorkload API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetWorkloadRequest method.
req, resp := client.GetWorkloadRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetWorkload

func (*LaunchWizard) GetWorkloadWithContext

func (c *LaunchWizard) GetWorkloadWithContext(ctx aws.Context, input *GetWorkloadInput, opts ...request.Option) (*GetWorkloadOutput, error)

GetWorkloadWithContext is the same as GetWorkload with the addition of the ability to pass a context and additional request options.

See GetWorkload for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LaunchWizard) ListDeploymentEvents

func (c *LaunchWizard) ListDeploymentEvents(input *ListDeploymentEventsInput) (*ListDeploymentEventsOutput, error)

ListDeploymentEvents API operation for AWS Launch Wizard.

Lists the events of a deployment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Launch Wizard's API operation ListDeploymentEvents for usage and error information.

Returned Error Types:

  • InternalServerException An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post (https://repost.aws/).

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The specified workload or deployment resource can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListDeploymentEvents

func (*LaunchWizard) ListDeploymentEventsPages

func (c *LaunchWizard) ListDeploymentEventsPages(input *ListDeploymentEventsInput, fn func(*ListDeploymentEventsOutput, bool) bool) error

ListDeploymentEventsPages iterates over the pages of a ListDeploymentEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDeploymentEvents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDeploymentEvents operation.
pageNum := 0
err := client.ListDeploymentEventsPages(params,
    func(page *launchwizard.ListDeploymentEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LaunchWizard) ListDeploymentEventsPagesWithContext

func (c *LaunchWizard) ListDeploymentEventsPagesWithContext(ctx aws.Context, input *ListDeploymentEventsInput, fn func(*ListDeploymentEventsOutput, bool) bool, opts ...request.Option) error

ListDeploymentEventsPagesWithContext same as ListDeploymentEventsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LaunchWizard) ListDeploymentEventsRequest

func (c *LaunchWizard) ListDeploymentEventsRequest(input *ListDeploymentEventsInput) (req *request.Request, output *ListDeploymentEventsOutput)

ListDeploymentEventsRequest generates a "aws/request.Request" representing the client's request for the ListDeploymentEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDeploymentEvents for more information on using the ListDeploymentEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDeploymentEventsRequest method.
req, resp := client.ListDeploymentEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListDeploymentEvents

func (*LaunchWizard) ListDeploymentEventsWithContext

func (c *LaunchWizard) ListDeploymentEventsWithContext(ctx aws.Context, input *ListDeploymentEventsInput, opts ...request.Option) (*ListDeploymentEventsOutput, error)

ListDeploymentEventsWithContext is the same as ListDeploymentEvents with the addition of the ability to pass a context and additional request options.

See ListDeploymentEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LaunchWizard) ListDeployments

func (c *LaunchWizard) ListDeployments(input *ListDeploymentsInput) (*ListDeploymentsOutput, error)

ListDeployments API operation for AWS Launch Wizard.

Lists the deployments that have been created.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Launch Wizard's API operation ListDeployments for usage and error information.

Returned Error Types:

  • InternalServerException An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post (https://repost.aws/).

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListDeployments

func (*LaunchWizard) ListDeploymentsPages

func (c *LaunchWizard) ListDeploymentsPages(input *ListDeploymentsInput, fn func(*ListDeploymentsOutput, bool) bool) error

ListDeploymentsPages iterates over the pages of a ListDeployments operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDeployments method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDeployments operation.
pageNum := 0
err := client.ListDeploymentsPages(params,
    func(page *launchwizard.ListDeploymentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LaunchWizard) ListDeploymentsPagesWithContext

func (c *LaunchWizard) ListDeploymentsPagesWithContext(ctx aws.Context, input *ListDeploymentsInput, fn func(*ListDeploymentsOutput, bool) bool, opts ...request.Option) error

ListDeploymentsPagesWithContext same as ListDeploymentsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LaunchWizard) ListDeploymentsRequest

func (c *LaunchWizard) ListDeploymentsRequest(input *ListDeploymentsInput) (req *request.Request, output *ListDeploymentsOutput)

ListDeploymentsRequest generates a "aws/request.Request" representing the client's request for the ListDeployments operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDeployments for more information on using the ListDeployments API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDeploymentsRequest method.
req, resp := client.ListDeploymentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListDeployments

func (*LaunchWizard) ListDeploymentsWithContext

func (c *LaunchWizard) ListDeploymentsWithContext(ctx aws.Context, input *ListDeploymentsInput, opts ...request.Option) (*ListDeploymentsOutput, error)

ListDeploymentsWithContext is the same as ListDeployments with the addition of the ability to pass a context and additional request options.

See ListDeployments for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LaunchWizard) ListWorkloadDeploymentPatterns

ListWorkloadDeploymentPatterns API operation for AWS Launch Wizard.

Lists the workload deployment patterns.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Launch Wizard's API operation ListWorkloadDeploymentPatterns for usage and error information.

Returned Error Types:

  • InternalServerException An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post (https://repost.aws/).

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The specified workload or deployment resource can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListWorkloadDeploymentPatterns

func (*LaunchWizard) ListWorkloadDeploymentPatternsPages

func (c *LaunchWizard) ListWorkloadDeploymentPatternsPages(input *ListWorkloadDeploymentPatternsInput, fn func(*ListWorkloadDeploymentPatternsOutput, bool) bool) error

ListWorkloadDeploymentPatternsPages iterates over the pages of a ListWorkloadDeploymentPatterns operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWorkloadDeploymentPatterns method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListWorkloadDeploymentPatterns operation.
pageNum := 0
err := client.ListWorkloadDeploymentPatternsPages(params,
    func(page *launchwizard.ListWorkloadDeploymentPatternsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LaunchWizard) ListWorkloadDeploymentPatternsPagesWithContext

func (c *LaunchWizard) ListWorkloadDeploymentPatternsPagesWithContext(ctx aws.Context, input *ListWorkloadDeploymentPatternsInput, fn func(*ListWorkloadDeploymentPatternsOutput, bool) bool, opts ...request.Option) error

ListWorkloadDeploymentPatternsPagesWithContext same as ListWorkloadDeploymentPatternsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LaunchWizard) ListWorkloadDeploymentPatternsRequest

func (c *LaunchWizard) ListWorkloadDeploymentPatternsRequest(input *ListWorkloadDeploymentPatternsInput) (req *request.Request, output *ListWorkloadDeploymentPatternsOutput)

ListWorkloadDeploymentPatternsRequest generates a "aws/request.Request" representing the client's request for the ListWorkloadDeploymentPatterns operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWorkloadDeploymentPatterns for more information on using the ListWorkloadDeploymentPatterns API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListWorkloadDeploymentPatternsRequest method.
req, resp := client.ListWorkloadDeploymentPatternsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListWorkloadDeploymentPatterns

func (*LaunchWizard) ListWorkloadDeploymentPatternsWithContext

func (c *LaunchWizard) ListWorkloadDeploymentPatternsWithContext(ctx aws.Context, input *ListWorkloadDeploymentPatternsInput, opts ...request.Option) (*ListWorkloadDeploymentPatternsOutput, error)

ListWorkloadDeploymentPatternsWithContext is the same as ListWorkloadDeploymentPatterns with the addition of the ability to pass a context and additional request options.

See ListWorkloadDeploymentPatterns for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LaunchWizard) ListWorkloads

func (c *LaunchWizard) ListWorkloads(input *ListWorkloadsInput) (*ListWorkloadsOutput, error)

ListWorkloads API operation for AWS Launch Wizard.

Lists the workloads.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Launch Wizard's API operation ListWorkloads for usage and error information.

Returned Error Types:

  • InternalServerException An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post (https://repost.aws/).

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListWorkloads

func (*LaunchWizard) ListWorkloadsPages

func (c *LaunchWizard) ListWorkloadsPages(input *ListWorkloadsInput, fn func(*ListWorkloadsOutput, bool) bool) error

ListWorkloadsPages iterates over the pages of a ListWorkloads operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWorkloads method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListWorkloads operation.
pageNum := 0
err := client.ListWorkloadsPages(params,
    func(page *launchwizard.ListWorkloadsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LaunchWizard) ListWorkloadsPagesWithContext

func (c *LaunchWizard) ListWorkloadsPagesWithContext(ctx aws.Context, input *ListWorkloadsInput, fn func(*ListWorkloadsOutput, bool) bool, opts ...request.Option) error

ListWorkloadsPagesWithContext same as ListWorkloadsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LaunchWizard) ListWorkloadsRequest

func (c *LaunchWizard) ListWorkloadsRequest(input *ListWorkloadsInput) (req *request.Request, output *ListWorkloadsOutput)

ListWorkloadsRequest generates a "aws/request.Request" representing the client's request for the ListWorkloads operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWorkloads for more information on using the ListWorkloads API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListWorkloadsRequest method.
req, resp := client.ListWorkloadsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListWorkloads

func (*LaunchWizard) ListWorkloadsWithContext

func (c *LaunchWizard) ListWorkloadsWithContext(ctx aws.Context, input *ListWorkloadsInput, opts ...request.Option) (*ListWorkloadsOutput, error)

ListWorkloadsWithContext is the same as ListWorkloads with the addition of the ability to pass a context and additional request options.

See ListWorkloads for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ListDeploymentEventsInput

type ListDeploymentEventsInput struct {

	// The ID of the deployment.
	//
	// DeploymentId is a required field
	DeploymentId *string `locationName:"deploymentId" min:"2" type:"string" required:"true"`

	// 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.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token returned from a previous paginated request. Pagination continues
	// from the end of the items returned by the previous request.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDeploymentEventsInput) GoString

func (s ListDeploymentEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDeploymentEventsInput) SetDeploymentId

SetDeploymentId sets the DeploymentId field's value.

func (*ListDeploymentEventsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListDeploymentEventsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDeploymentEventsInput) String

func (s ListDeploymentEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDeploymentEventsInput) Validate

func (s *ListDeploymentEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDeploymentEventsOutput

type ListDeploymentEventsOutput struct {

	// Lists the deployment events.
	DeploymentEvents []*DeploymentEventDataSummary `locationName:"deploymentEvents" type:"list"`

	// 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.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDeploymentEventsOutput) GoString

func (s ListDeploymentEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDeploymentEventsOutput) SetDeploymentEvents

SetDeploymentEvents sets the DeploymentEvents field's value.

func (*ListDeploymentEventsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDeploymentEventsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDeploymentsInput

type ListDeploymentsInput struct {

	// Filters to scope the results. The following filters are supported:
	//
	//    * WORKLOAD_NAME
	//
	//    * DEPLOYMENT_STATUS
	Filters []*DeploymentFilter `locationName:"filters" min:"1" type:"list"`

	// 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.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token returned from a previous paginated request. Pagination continues
	// from the end of the items returned by the previous request.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDeploymentsInput) GoString

func (s ListDeploymentsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDeploymentsInput) SetFilters

SetFilters sets the Filters field's value.

func (*ListDeploymentsInput) SetMaxResults

func (s *ListDeploymentsInput) SetMaxResults(v int64) *ListDeploymentsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDeploymentsInput) SetNextToken

func (s *ListDeploymentsInput) SetNextToken(v string) *ListDeploymentsInput

SetNextToken sets the NextToken field's value.

func (ListDeploymentsInput) String

func (s ListDeploymentsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDeploymentsInput) Validate

func (s *ListDeploymentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDeploymentsOutput

type ListDeploymentsOutput struct {

	// Lists the deployments.
	Deployments []*DeploymentDataSummary `locationName:"deployments" type:"list"`

	// 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.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDeploymentsOutput) GoString

func (s ListDeploymentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDeploymentsOutput) SetDeployments

SetDeployments sets the Deployments field's value.

func (*ListDeploymentsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDeploymentsOutput) String

func (s ListDeploymentsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWorkloadDeploymentPatternsInput

type ListWorkloadDeploymentPatternsInput struct {

	// 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.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token returned from a previous paginated request. Pagination continues
	// from the end of the items returned by the previous request.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The name of the workload.
	//
	// WorkloadName is a required field
	WorkloadName *string `locationName:"workloadName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListWorkloadDeploymentPatternsInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkloadDeploymentPatternsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListWorkloadDeploymentPatternsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListWorkloadDeploymentPatternsInput) SetWorkloadName

SetWorkloadName sets the WorkloadName field's value.

func (ListWorkloadDeploymentPatternsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkloadDeploymentPatternsInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type ListWorkloadDeploymentPatternsOutput

type ListWorkloadDeploymentPatternsOutput struct {

	// 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.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// Describes the workload deployment patterns.
	WorkloadDeploymentPatterns []*WorkloadDeploymentPatternDataSummary `locationName:"workloadDeploymentPatterns" type:"list"`
	// contains filtered or unexported fields
}

func (ListWorkloadDeploymentPatternsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkloadDeploymentPatternsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListWorkloadDeploymentPatternsOutput) SetWorkloadDeploymentPatterns

SetWorkloadDeploymentPatterns sets the WorkloadDeploymentPatterns field's value.

func (ListWorkloadDeploymentPatternsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWorkloadsInput

type ListWorkloadsInput struct {

	// 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.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token returned from a previous paginated request. Pagination continues
	// from the end of the items returned by the previous request.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListWorkloadsInput) GoString

func (s ListWorkloadsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkloadsInput) SetMaxResults

func (s *ListWorkloadsInput) SetMaxResults(v int64) *ListWorkloadsInput

SetMaxResults sets the MaxResults field's value.

func (*ListWorkloadsInput) SetNextToken

func (s *ListWorkloadsInput) SetNextToken(v string) *ListWorkloadsInput

SetNextToken sets the NextToken field's value.

func (ListWorkloadsInput) String

func (s ListWorkloadsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkloadsInput) Validate

func (s *ListWorkloadsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListWorkloadsOutput

type ListWorkloadsOutput struct {

	// 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.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// Information about the workloads.
	Workloads []*WorkloadDataSummary `locationName:"workloads" type:"list"`
	// contains filtered or unexported fields
}

func (ListWorkloadsOutput) GoString

func (s ListWorkloadsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkloadsOutput) SetNextToken

func (s *ListWorkloadsOutput) SetNextToken(v string) *ListWorkloadsOutput

SetNextToken sets the NextToken field's value.

func (*ListWorkloadsOutput) SetWorkloads

SetWorkloads sets the Workloads field's value.

func (ListWorkloadsOutput) String

func (s ListWorkloadsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceLimitException

type ResourceLimitException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You have exceeded an Launch Wizard resource limit. For example, you might have too many deployments in progress.

func (*ResourceLimitException) Code

func (s *ResourceLimitException) Code() string

Code returns the exception type name.

func (*ResourceLimitException) Error

func (s *ResourceLimitException) Error() string

func (ResourceLimitException) GoString

func (s ResourceLimitException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceLimitException) Message

func (s *ResourceLimitException) Message() string

Message returns the exception's message.

func (*ResourceLimitException) OrigErr

func (s *ResourceLimitException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceLimitException) RequestID

func (s *ResourceLimitException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceLimitException) StatusCode

func (s *ResourceLimitException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceLimitException) String

func (s ResourceLimitException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified workload or deployment resource can't be found.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by an Amazon Web Services service.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkloadData

type WorkloadData struct {

	// The description of a workload.
	Description *string `locationName:"description" type:"string"`

	// The display name of a workload.
	DisplayName *string `locationName:"displayName" type:"string"`

	// The URL of a workload document.
	DocumentationUrl *string `locationName:"documentationUrl" type:"string"`

	// The URL of a workload icon.
	IconUrl *string `locationName:"iconUrl" type:"string"`

	// The status of a workload.
	Status *string `locationName:"status" type:"string" enum:"WorkloadStatus"`

	// The message about a workload's status.
	StatusMessage *string `locationName:"statusMessage" type:"string"`

	// The name of the workload.
	WorkloadName *string `locationName:"workloadName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a workload.

func (WorkloadData) GoString

func (s WorkloadData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkloadData) SetDescription

func (s *WorkloadData) SetDescription(v string) *WorkloadData

SetDescription sets the Description field's value.

func (*WorkloadData) SetDisplayName

func (s *WorkloadData) SetDisplayName(v string) *WorkloadData

SetDisplayName sets the DisplayName field's value.

func (*WorkloadData) SetDocumentationUrl

func (s *WorkloadData) SetDocumentationUrl(v string) *WorkloadData

SetDocumentationUrl sets the DocumentationUrl field's value.

func (*WorkloadData) SetIconUrl

func (s *WorkloadData) SetIconUrl(v string) *WorkloadData

SetIconUrl sets the IconUrl field's value.

func (*WorkloadData) SetStatus

func (s *WorkloadData) SetStatus(v string) *WorkloadData

SetStatus sets the Status field's value.

func (*WorkloadData) SetStatusMessage

func (s *WorkloadData) SetStatusMessage(v string) *WorkloadData

SetStatusMessage sets the StatusMessage field's value.

func (*WorkloadData) SetWorkloadName

func (s *WorkloadData) SetWorkloadName(v string) *WorkloadData

SetWorkloadName sets the WorkloadName field's value.

func (WorkloadData) String

func (s WorkloadData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkloadDataSummary

type WorkloadDataSummary struct {

	// The display name of the workload data.
	DisplayName *string `locationName:"displayName" type:"string"`

	// The name of the workload.
	WorkloadName *string `locationName:"workloadName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes workload data.

func (WorkloadDataSummary) GoString

func (s WorkloadDataSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkloadDataSummary) SetDisplayName

func (s *WorkloadDataSummary) SetDisplayName(v string) *WorkloadDataSummary

SetDisplayName sets the DisplayName field's value.

func (*WorkloadDataSummary) SetWorkloadName

func (s *WorkloadDataSummary) SetWorkloadName(v string) *WorkloadDataSummary

SetWorkloadName sets the WorkloadName field's value.

func (WorkloadDataSummary) String

func (s WorkloadDataSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkloadDeploymentPatternDataSummary

type WorkloadDeploymentPatternDataSummary struct {

	// The name of a workload deployment pattern.
	DeploymentPatternName *string `locationName:"deploymentPatternName" min:"1" type:"string"`

	// The description of a workload deployment pattern.
	Description *string `locationName:"description" type:"string"`

	// The display name of a workload deployment pattern.
	DisplayName *string `locationName:"displayName" type:"string"`

	// The status of a workload deployment pattern.
	Status *string `locationName:"status" type:"string" enum:"WorkloadDeploymentPatternStatus"`

	// A message about a workload deployment pattern's status.
	StatusMessage *string `locationName:"statusMessage" type:"string"`

	// The name of the workload.
	WorkloadName *string `locationName:"workloadName" min:"1" type:"string"`

	// The name of the workload deployment pattern version.
	WorkloadVersionName *string `locationName:"workloadVersionName" min:"5" type:"string"`
	// contains filtered or unexported fields
}

Describes a workload deployment pattern.

func (WorkloadDeploymentPatternDataSummary) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkloadDeploymentPatternDataSummary) SetDeploymentPatternName

SetDeploymentPatternName sets the DeploymentPatternName field's value.

func (*WorkloadDeploymentPatternDataSummary) SetDescription

SetDescription sets the Description field's value.

func (*WorkloadDeploymentPatternDataSummary) SetDisplayName

SetDisplayName sets the DisplayName field's value.

func (*WorkloadDeploymentPatternDataSummary) SetStatus

SetStatus sets the Status field's value.

func (*WorkloadDeploymentPatternDataSummary) SetStatusMessage

SetStatusMessage sets the StatusMessage field's value.

func (*WorkloadDeploymentPatternDataSummary) SetWorkloadName

SetWorkloadName sets the WorkloadName field's value.

func (*WorkloadDeploymentPatternDataSummary) SetWorkloadVersionName

SetWorkloadVersionName sets the WorkloadVersionName field's value.

func (WorkloadDeploymentPatternDataSummary) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package launchwizardiface provides an interface to enable mocking the AWS Launch Wizard service client for testing your code.
Package launchwizardiface provides an interface to enable mocking the AWS Launch Wizard service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL