types

package
v1.13.6 Latest Latest
Warning

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

 Go to latest Published: Nov 18, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type ConflictException added in v1.9.0 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

This exception is thrown when an attempt to update or delete a resource would cause an inconsistent state.

func (*ConflictException) Error added in v1.9.0 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode added in v1.9.0 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault added in v1.9.0 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage added in v1.9.0 

func (e *ConflictException) ErrorMessage() string

type DataType 

type DataType string
const (
	DataTypeString     DataType = "STRING"
	DataTypeInteger    DataType = "INTEGER"
	DataTypeStringlist DataType = "STRINGLIST"
	DataTypeStringmap  DataType = "STRINGMAP"
)

Enum values for DataType

func (DataType) Values 

func (DataType) Values() []DataType

Values returns all known values for DataType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An internal error has occurred.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type MigrationWorkflowStatusEnum 

type MigrationWorkflowStatusEnum string
const (
	MigrationWorkflowStatusEnumCreating              MigrationWorkflowStatusEnum = "CREATING"
	MigrationWorkflowStatusEnumNotStarted            MigrationWorkflowStatusEnum = "NOT_STARTED"
	MigrationWorkflowStatusEnumCreationFailed        MigrationWorkflowStatusEnum = "CREATION_FAILED"
	MigrationWorkflowStatusEnumStarting              MigrationWorkflowStatusEnum = "STARTING"
	MigrationWorkflowStatusEnumInProgress            MigrationWorkflowStatusEnum = "IN_PROGRESS"
	MigrationWorkflowStatusEnumWorkflowFailed        MigrationWorkflowStatusEnum = "WORKFLOW_FAILED"
	MigrationWorkflowStatusEnumPaused                MigrationWorkflowStatusEnum = "PAUSED"
	MigrationWorkflowStatusEnumPausing               MigrationWorkflowStatusEnum = "PAUSING"
	MigrationWorkflowStatusEnumPausingFailed         MigrationWorkflowStatusEnum = "PAUSING_FAILED"
	MigrationWorkflowStatusEnumUserAttentionRequired MigrationWorkflowStatusEnum = "USER_ATTENTION_REQUIRED"
	MigrationWorkflowStatusEnumDeleting              MigrationWorkflowStatusEnum = "DELETING"
	MigrationWorkflowStatusEnumDeletionFailed        MigrationWorkflowStatusEnum = "DELETION_FAILED"
	MigrationWorkflowStatusEnumDeleted               MigrationWorkflowStatusEnum = "DELETED"
	MigrationWorkflowStatusEnumCompleted             MigrationWorkflowStatusEnum = "COMPLETED"
)

Enum values for MigrationWorkflowStatusEnum

func (MigrationWorkflowStatusEnum) Values 

func (MigrationWorkflowStatusEnum) Values() []MigrationWorkflowStatusEnum

Values returns all known values for MigrationWorkflowStatusEnum. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MigrationWorkflowSummary 

type MigrationWorkflowSummary struct {

	// The name of the application configured in Application Discovery Service.
	AdsApplicationConfigurationName *string

	// The steps completed in the migration workflow.
	CompletedSteps *int32

	// The time at which the migration workflow was created.
	CreationTime *time.Time

	// The time at which the migration workflow ended.
	EndTime *time.Time

	// The ID of the migration workflow.
	Id *string

	// The name of the migration workflow.
	Name *string

	// The status of the migration workflow.
	Status MigrationWorkflowStatusEnum

	// The status message of the migration workflow.
	StatusMessage *string

	// The ID of the template.
	TemplateId *string

	// All the steps in a migration workflow.
	TotalSteps *int32
	// contains filtered or unexported fields
}

The summary of a migration workflow.

type Owner 

type Owner string
const (
	OwnerAWSManaged Owner = "AWS_MANAGED"
	OwnerCustom     Owner = "CUSTOM"
)

Enum values for Owner

func (Owner) Values 

func (Owner) Values() []Owner

Values returns all known values for Owner. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PlatformCommand 

type PlatformCommand struct {

	// Command for Linux.
	Linux *string

	// Command for Windows.
	Windows *string
	// contains filtered or unexported fields
}

Command to be run on a particular operating system.

type PlatformScriptKey 

type PlatformScriptKey struct {

	// The script location for Linux.
	Linux *string

	// The script location for Windows.
	Windows *string
	// contains filtered or unexported fields
}

The script location for a particular operating system.

type PluginHealth 

type PluginHealth string
const (
	PluginHealthPluginHealthy   PluginHealth = "HEALTHY"
	PluginHealthPluginUnhealthy PluginHealth = "UNHEALTHY"
)

Enum values for PluginHealth

func (PluginHealth) Values 

func (PluginHealth) Values() []PluginHealth

Values returns all known values for PluginHealth. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PluginSummary 

type PluginSummary struct {

	// The name of the host.
	Hostname *string

	// The IP address at which the plugin is located.
	IpAddress *string

	// The ID of the plugin.
	PluginId *string

	// The time at which the plugin was registered.
	RegisteredTime *string

	// The status of the plugin.
	Status PluginHealth

	// The version of the plugin.
	Version *string
	// contains filtered or unexported fields
}

The summary of the Migration Hub Orchestrator plugin.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource is not available.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type RunEnvironment 

type RunEnvironment string
const (
	RunEnvironmentAws       RunEnvironment = "AWS"
	RunEnvironmentOnpremise RunEnvironment = "ONPREMISE"
)

Enum values for RunEnvironment

func (RunEnvironment) Values 

func (RunEnvironment) Values() []RunEnvironment

Values returns all known values for RunEnvironment. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StepActionType 

type StepActionType string
const (
	StepActionTypeManual    StepActionType = "MANUAL"
	StepActionTypeAutomated StepActionType = "AUTOMATED"
)

Enum values for StepActionType

func (StepActionType) Values 

func (StepActionType) Values() []StepActionType

Values returns all known values for StepActionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StepAutomationConfiguration 

type StepAutomationConfiguration struct {

	// The command to run the script.
	Command *PlatformCommand

	// The source or target environment.
	RunEnvironment RunEnvironment

	// The Amazon S3 bucket where the script is located.
	ScriptLocationS3Bucket *string

	// The Amazon S3 key for the script location.
	ScriptLocationS3Key *PlatformScriptKey

	// The servers on which to run the script.
	TargetType TargetType
	// contains filtered or unexported fields
}

The custom script to run tests on source or target environments.

type StepGroupStatus 

type StepGroupStatus string
const (
	StepGroupStatusAwaitingDependencies  StepGroupStatus = "AWAITING_DEPENDENCIES"
	StepGroupStatusReady                 StepGroupStatus = "READY"
	StepGroupStatusInProgress            StepGroupStatus = "IN_PROGRESS"
	StepGroupStatusCompleted             StepGroupStatus = "COMPLETED"
	StepGroupStatusFailed                StepGroupStatus = "FAILED"
	StepGroupStatusPaused                StepGroupStatus = "PAUSED"
	StepGroupStatusPausing               StepGroupStatus = "PAUSING"
	StepGroupStatusUserAttentionRequired StepGroupStatus = "USER_ATTENTION_REQUIRED"
)

Enum values for StepGroupStatus

func (StepGroupStatus) Values 

func (StepGroupStatus) Values() []StepGroupStatus

Values returns all known values for StepGroupStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StepInput 

type StepInput interface {
	// contains filtered or unexported methods
}

A map of key value pairs that is generated when you create a migration workflow. The key value pairs will differ based on your selection of the template.

The following types satisfy this interface: 

StepInputMemberIntegerValue
StepInputMemberListOfStringsValue
StepInputMemberMapOfStringValue
StepInputMemberStringValue
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/migrationhuborchestrator/types"
)

func main() {
	var union types.StepInput
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.StepInputMemberIntegerValue:
		_ = v.Value // Value is int32

	case *types.StepInputMemberListOfStringsValue:
		_ = v.Value // Value is []string

	case *types.StepInputMemberMapOfStringValue:
		_ = v.Value // Value is map[string]string

	case *types.StepInputMemberStringValue:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type StepInputMemberIntegerValue 

type StepInputMemberIntegerValue struct {
	Value int32
	// contains filtered or unexported fields
}

The value of the integer.

type StepInputMemberListOfStringsValue 

type StepInputMemberListOfStringsValue struct {
	Value []string
	// contains filtered or unexported fields
}

List of string values.

type StepInputMemberMapOfStringValue 

type StepInputMemberMapOfStringValue struct {
	Value map[string]string
	// contains filtered or unexported fields
}

Map of string values.

type StepInputMemberStringValue 

type StepInputMemberStringValue struct {
	Value string
	// contains filtered or unexported fields
}

String value.

type StepOutput 

type StepOutput struct {

	// The data type of the step output.
	DataType DataType

	// The name of the step.
	Name *string

	// Determine if an output is required from a step.
	Required *bool
	// contains filtered or unexported fields
}

The output of the step.

type StepStatus 

type StepStatus string
const (
	StepStatusAwaitingDependencies  StepStatus = "AWAITING_DEPENDENCIES"
	StepStatusSkipped               StepStatus = "SKIPPED"
	StepStatusReady                 StepStatus = "READY"
	StepStatusInProgress            StepStatus = "IN_PROGRESS"
	StepStatusCompleted             StepStatus = "COMPLETED"
	StepStatusFailed                StepStatus = "FAILED"
	StepStatusPaused                StepStatus = "PAUSED"
	StepStatusUserAttentionRequired StepStatus = "USER_ATTENTION_REQUIRED"
)

Enum values for StepStatus

func (StepStatus) Values 

func (StepStatus) Values() []StepStatus

Values returns all known values for StepStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TargetType 

type TargetType string
const (
	TargetTypeSingle TargetType = "SINGLE"
	TargetTypeAll    TargetType = "ALL"
	TargetTypeNone   TargetType = "NONE"
)

Enum values for TargetType

func (TargetType) Values 

func (TargetType) Values() []TargetType

Values returns all known values for TargetType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TemplateInput 

type TemplateInput struct {

	// The data type of the template input.
	DataType DataType

	// The name of the template.
	InputName *string

	// Determine if an input is required from the template.
	Required *bool
	// contains filtered or unexported fields
}

The input parameters of a template.

type TemplateSource added in v1.9.0 

type TemplateSource interface {
	// contains filtered or unexported methods
}

The migration workflow template used as the source for the new template.

The following types satisfy this interface: 

TemplateSourceMemberWorkflowId
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/migrationhuborchestrator/types"
)

func main() {
	var union types.TemplateSource
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.TemplateSourceMemberWorkflowId:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type TemplateSourceMemberWorkflowId added in v1.9.0 

type TemplateSourceMemberWorkflowId struct {
	Value string
	// contains filtered or unexported fields
}

The ID of the workflow from the source migration workflow template.

type TemplateStatus 

type TemplateStatus string
const (
	TemplateStatusCreated         TemplateStatus = "CREATED"
	TemplateStatusReady           TemplateStatus = "READY"
	TemplateStatusPendingCreation TemplateStatus = "PENDING_CREATION"
	TemplateStatusCreating        TemplateStatus = "CREATING"
	TemplateStatusCreationFailed  TemplateStatus = "CREATION_FAILED"
)

Enum values for TemplateStatus

func (TemplateStatus) Values 

func (TemplateStatus) Values() []TemplateStatus

Values returns all known values for TemplateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TemplateStepGroupSummary 

type TemplateStepGroupSummary struct {

	// The ID of the step group.
	Id *string

	// The name of the step group.
	Name *string

	// The next step group.
	Next []string

	// The previous step group.
	Previous []string
	// contains filtered or unexported fields
}

The summary of the step group in the template.

type TemplateStepSummary 

type TemplateStepSummary struct {

	// The ID of the step.
	Id *string

	// The name of the step.
	Name *string

	// The next step.
	Next []string

	// The owner of the step.
	Owner Owner

	// The previous step.
	Previous []string

	// The action type of the step. You must run and update the status of a manual
	// step for the workflow to continue after the completion of the step.
	StepActionType StepActionType

	// The ID of the step group.
	StepGroupId *string

	// The servers on which to run the script.
	TargetType TargetType

	// The ID of the template.
	TemplateId *string
	// contains filtered or unexported fields
}

The summary of the step.

type TemplateSummary 

type TemplateSummary struct {

	// The Amazon Resource Name (ARN) of the template.
	Arn *string

	// The description of the template.
	Description *string

	// The ID of the template.
	Id *string

	// The name of the template.
	Name *string
	// contains filtered or unexported fields
}

The summary of the template.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type Tool 

type Tool struct {

	// The name of an AWS service.
	Name *string

	// The URL of an AWS service.
	Url *string
	// contains filtered or unexported fields
}

List of AWS services utilized in a migration workflow.

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by an AWS service.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type WorkflowStepAutomationConfiguration 

type WorkflowStepAutomationConfiguration struct {

	// The command required to run the script.
	Command *PlatformCommand

	// The source or target environment.
	RunEnvironment RunEnvironment

	// The Amazon S3 bucket where the script is located.
	ScriptLocationS3Bucket *string

	// The Amazon S3 key for the script location.
	ScriptLocationS3Key *PlatformScriptKey

	// The servers on which to run the script.
	TargetType TargetType
	// contains filtered or unexported fields
}

The custom script to run tests on source or target environments.

type WorkflowStepGroupSummary 

type WorkflowStepGroupSummary struct {

	// The ID of the step group.
	Id *string

	// The name of the step group.
	Name *string

	// The next step group.
	Next []string

	// The owner of the step group.
	Owner Owner

	// The previous step group.
	Previous []string

	// The status of the step group.
	Status StepGroupStatus
	// contains filtered or unexported fields
}

The summary of a step group in a workflow.

type WorkflowStepOutput 

type WorkflowStepOutput struct {

	// The data type of the output.
	DataType DataType

	// The name of the step.
	Name *string

	// Determine if an output is required from a step.
	Required *bool

	// The value of the output.
	Value WorkflowStepOutputUnion
	// contains filtered or unexported fields
}

The output of a step.

type WorkflowStepOutputUnion 

type WorkflowStepOutputUnion interface {
	// contains filtered or unexported methods
}

A structure to hold multiple values of an output.

The following types satisfy this interface: 

WorkflowStepOutputUnionMemberIntegerValue
WorkflowStepOutputUnionMemberListOfStringValue
WorkflowStepOutputUnionMemberStringValue
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/migrationhuborchestrator/types"
)

func main() {
	var union types.WorkflowStepOutputUnion
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.WorkflowStepOutputUnionMemberIntegerValue:
		_ = v.Value // Value is int32

	case *types.WorkflowStepOutputUnionMemberListOfStringValue:
		_ = v.Value // Value is []string

	case *types.WorkflowStepOutputUnionMemberStringValue:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type WorkflowStepOutputUnionMemberIntegerValue 

type WorkflowStepOutputUnionMemberIntegerValue struct {
	Value int32
	// contains filtered or unexported fields
}

The integer value.

type WorkflowStepOutputUnionMemberListOfStringValue 

type WorkflowStepOutputUnionMemberListOfStringValue struct {
	Value []string
	// contains filtered or unexported fields
}

The list of string value.

type WorkflowStepOutputUnionMemberStringValue 

type WorkflowStepOutputUnionMemberStringValue struct {
	Value string
	// contains filtered or unexported fields
}

The string value.

type WorkflowStepSummary 

type WorkflowStepSummary struct {

	// The description of the step.
	Description *string

	// The name of the step.
	Name *string

	// The next step.
	Next []string

	// The number of servers that have been migrated.
	NoOfSrvCompleted *int32

	// The number of servers that have failed to migrate.
	NoOfSrvFailed *int32

	// The owner of the step.
	Owner Owner

	// The previous step.
	Previous []string

	// The location of the script.
	ScriptLocation *string

	// The status of the step.
	Status StepStatus

	// The status message of the migration workflow.
	StatusMessage *string

	// The action type of the step. You must run and update the status of a manual
	// step for the workflow to continue after the completion of the step.
	StepActionType StepActionType

	// The ID of the step.
	StepId *string

	// The total number of servers that have been migrated.
	TotalNoOfSrv *int32
	// contains filtered or unexported fields
}

The summary of the step in a migration workflow.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.