types

package
v1.13.4 Latest Latest
Warning

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

 Go to latest Published: May 23, 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
}

The account or role doesn't have the right permissions to make the request.

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 AlternateKey 

type AlternateKey struct {

	// A strictly positive integer value representing the length of the alternate key.
	//
	// This member is required.
	Length int32

	// A positive integer value representing the offset to mark the start of the
	// alternate key part in the record byte array.
	//
	// This member is required.
	Offset int32

	// Indicates whether the alternate key values are supposed to be unique for the
	// given data set.
	AllowDuplicates bool

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

Defines an alternate key. This value is optional. A legacy data set might not have any alternate key defined but if those alternate keys definitions exist, provide them, as some applications will make use of them.

type ApplicationDeploymentLifecycle 

type ApplicationDeploymentLifecycle string
const (
	ApplicationDeploymentLifecycleDeploying ApplicationDeploymentLifecycle = "Deploying"
	ApplicationDeploymentLifecycleDeployed  ApplicationDeploymentLifecycle = "Deployed"
)

Enum values for ApplicationDeploymentLifecycle

func (ApplicationDeploymentLifecycle) Values 

func (ApplicationDeploymentLifecycle) Values() []ApplicationDeploymentLifecycle

Values returns all known values for ApplicationDeploymentLifecycle. 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 ApplicationLifecycle 

type ApplicationLifecycle string
const (
	ApplicationLifecycleCreating                ApplicationLifecycle = "Creating"
	ApplicationLifecycleCreated                 ApplicationLifecycle = "Created"
	ApplicationLifecycleAvailable               ApplicationLifecycle = "Available"
	ApplicationLifecycleReady                   ApplicationLifecycle = "Ready"
	ApplicationLifecycleStarting                ApplicationLifecycle = "Starting"
	ApplicationLifecycleRunning                 ApplicationLifecycle = "Running"
	ApplicationLifecycleStopping                ApplicationLifecycle = "Stopping"
	ApplicationLifecycleStopped                 ApplicationLifecycle = "Stopped"
	ApplicationLifecycleFailed                  ApplicationLifecycle = "Failed"
	ApplicationLifecycleDeleting                ApplicationLifecycle = "Deleting"
	ApplicationLifecycleDeletingFromEnvironment ApplicationLifecycle = "Deleting From Environment"
)

Enum values for ApplicationLifecycle

func (ApplicationLifecycle) Values 

func (ApplicationLifecycle) Values() []ApplicationLifecycle

Values returns all known values for ApplicationLifecycle. 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 ApplicationSummary 

type ApplicationSummary struct {

	// The Amazon Resource Name (ARN) of the application.
	//
	// This member is required.
	ApplicationArn *string

	// The unique identifier of the application.
	//
	// This member is required.
	ApplicationId *string

	// The version of the application.
	//
	// This member is required.
	ApplicationVersion *int32

	// The timestamp when the application was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The type of the target platform for this application.
	//
	// This member is required.
	EngineType EngineType

	// The name of the application.
	//
	// This member is required.
	Name *string

	// The status of the application.
	//
	// This member is required.
	Status ApplicationLifecycle

	// Indicates either an ongoing deployment or if the application has ever deployed
	// successfully.
	DeploymentStatus ApplicationDeploymentLifecycle

	// The description of the application.
	Description *string

	// The unique identifier of the runtime environment that hosts this application.
	EnvironmentId *string

	// The timestamp when you last started the application. Null until the application
	// runs for the first time.
	LastStartTime *time.Time

	// The Amazon Resource Name (ARN) of the role associated with the application.
	RoleArn *string

	// Indicates the status of the latest version of the application.
	VersionStatus ApplicationVersionLifecycle
	// contains filtered or unexported fields
}

A subset of the possible application attributes. Used in the application list.

type ApplicationVersionLifecycle 

type ApplicationVersionLifecycle string
const (
	ApplicationVersionLifecycleCreating  ApplicationVersionLifecycle = "Creating"
	ApplicationVersionLifecycleAvailable ApplicationVersionLifecycle = "Available"
	ApplicationVersionLifecycleFailed    ApplicationVersionLifecycle = "Failed"
)

Enum values for ApplicationVersionLifecycle

func (ApplicationVersionLifecycle) Values 

func (ApplicationVersionLifecycle) Values() []ApplicationVersionLifecycle

Values returns all known values for ApplicationVersionLifecycle. 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 ApplicationVersionSummary 

type ApplicationVersionSummary struct {

	// The application version.
	//
	// This member is required.
	ApplicationVersion *int32

	// The timestamp when the application version was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The status of the application.
	//
	// This member is required.
	Status ApplicationVersionLifecycle

	// The reason for the reported status.
	StatusReason *string
	// contains filtered or unexported fields
}

Defines an application version summary.

type BatchJobDefinition 

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

Defines the details of a batch job.

The following types satisfy this interface: 

BatchJobDefinitionMemberFileBatchJobDefinition
BatchJobDefinitionMemberScriptBatchJobDefinition
Example (OutputUsage) 
package main

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

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

	case *types.BatchJobDefinitionMemberScriptBatchJobDefinition:
		_ = v.Value // Value is types.ScriptBatchJobDefinition

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

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

	}
}

Output:

type BatchJobDefinitionMemberFileBatchJobDefinition 

type BatchJobDefinitionMemberFileBatchJobDefinition struct {
	Value FileBatchJobDefinition
	// contains filtered or unexported fields
}

Specifies a file containing a batch job definition.

type BatchJobDefinitionMemberScriptBatchJobDefinition 

type BatchJobDefinitionMemberScriptBatchJobDefinition struct {
	Value ScriptBatchJobDefinition
	// contains filtered or unexported fields
}

A script containing a batch job definition.

type BatchJobExecutionStatus 

type BatchJobExecutionStatus string
const (
	BatchJobExecutionStatusSubmitting           BatchJobExecutionStatus = "Submitting"
	BatchJobExecutionStatusHolding              BatchJobExecutionStatus = "Holding"
	BatchJobExecutionStatusDispatch             BatchJobExecutionStatus = "Dispatching"
	BatchJobExecutionStatusRunning              BatchJobExecutionStatus = "Running"
	BatchJobExecutionStatusCancelling           BatchJobExecutionStatus = "Cancelling"
	BatchJobExecutionStatusCancelled            BatchJobExecutionStatus = "Cancelled"
	BatchJobExecutionStatusSucceeded            BatchJobExecutionStatus = "Succeeded"
	BatchJobExecutionStatusFailed               BatchJobExecutionStatus = "Failed"
	BatchJobExecutionStatusPurged               BatchJobExecutionStatus = "Purged"
	BatchJobExecutionStatusSucceededWithWarning BatchJobExecutionStatus = "Succeeded With Warning"
)

Enum values for BatchJobExecutionStatus

func (BatchJobExecutionStatus) Values 

func (BatchJobExecutionStatus) Values() []BatchJobExecutionStatus

Values returns all known values for BatchJobExecutionStatus. 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 BatchJobExecutionSummary 

type BatchJobExecutionSummary struct {

	// The unique identifier of the application that hosts this batch job.
	//
	// This member is required.
	ApplicationId *string

	// The unique identifier of this execution of the batch job.
	//
	// This member is required.
	ExecutionId *string

	// The timestamp when a particular batch job execution started.
	//
	// This member is required.
	StartTime *time.Time

	// The status of a particular batch job execution.
	//
	// This member is required.
	Status BatchJobExecutionStatus

	// The unique identifier of this batch job.
	BatchJobIdentifier BatchJobIdentifier

	// The timestamp when this batch job execution ended.
	EndTime *time.Time

	// The unique identifier of a particular batch job.
	JobId *string

	// The name of a particular batch job.
	JobName *string

	// The type of a particular batch job execution.
	JobType BatchJobType

	// The batch job return code from either the Blu Age or Micro Focus runtime
	// engines. For more information, see [Batch return codes]in the IBM WebSphere Application Server
	// documentation.
	//
	// [Batch return codes]: https://www.ibm.com/docs/en/was/8.5.5?topic=model-batch-return-codes
	ReturnCode *string
	// contains filtered or unexported fields
}

A subset of the possible batch job attributes. Used in the batch job list.

type BatchJobIdentifier 

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

Identifies a specific batch job.

The following types satisfy this interface: 

BatchJobIdentifierMemberFileBatchJobIdentifier
BatchJobIdentifierMemberRestartBatchJobIdentifier
BatchJobIdentifierMemberS3BatchJobIdentifier
BatchJobIdentifierMemberScriptBatchJobIdentifier
Example (OutputUsage) 
package main

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

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

	case *types.BatchJobIdentifierMemberRestartBatchJobIdentifier:
		_ = v.Value // Value is types.RestartBatchJobIdentifier

	case *types.BatchJobIdentifierMemberS3BatchJobIdentifier:
		_ = v.Value // Value is types.S3BatchJobIdentifier

	case *types.BatchJobIdentifierMemberScriptBatchJobIdentifier:
		_ = v.Value // Value is types.ScriptBatchJobIdentifier

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

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

	}
}

Output:

type BatchJobIdentifierMemberFileBatchJobIdentifier 

type BatchJobIdentifierMemberFileBatchJobIdentifier struct {
	Value FileBatchJobIdentifier
	// contains filtered or unexported fields
}

Specifies a file associated with a specific batch job.

type BatchJobIdentifierMemberRestartBatchJobIdentifier added in v1.13.0 

type BatchJobIdentifierMemberRestartBatchJobIdentifier struct {
	Value RestartBatchJobIdentifier
	// contains filtered or unexported fields
}

Specifies the required information for restart, including execution ID and jobsteprestartmarker.

type BatchJobIdentifierMemberS3BatchJobIdentifier added in v1.8.0 

type BatchJobIdentifierMemberS3BatchJobIdentifier struct {
	Value S3BatchJobIdentifier
	// contains filtered or unexported fields
}

Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.

type BatchJobIdentifierMemberScriptBatchJobIdentifier 

type BatchJobIdentifierMemberScriptBatchJobIdentifier struct {
	Value ScriptBatchJobIdentifier
	// contains filtered or unexported fields
}

A batch job identifier in which the batch job to run is identified by the script name.

type BatchJobType 

type BatchJobType string
const (
	BatchJobTypeVse  BatchJobType = "VSE"
	BatchJobTypeJes2 BatchJobType = "JES2"
	BatchJobTypeJes3 BatchJobType = "JES3"
)

Enum values for BatchJobType

func (BatchJobType) Values 

func (BatchJobType) Values() []BatchJobType

Values returns all known values for BatchJobType. 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 ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The parameters provided in the request conflict with existing resources.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

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

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type DataSet 

type DataSet struct {

	// The logical identifier for a specific data set (in mainframe format).
	//
	// This member is required.
	DatasetName *string

	// The type of dataset. The only supported value is VSAM.
	//
	// This member is required.
	DatasetOrg DatasetOrgAttributes

	// The length of a record.
	//
	// This member is required.
	RecordLength *RecordLength

	// The relative location of the data set in the database or file system.
	RelativePath *string

	// The storage type of the data set: database or file system. For Micro Focus,
	// database corresponds to datastore and file system corresponds to EFS/FSX. For
	// Blu Age, there is no support of file system and database corresponds to Blusam.
	StorageType *string
	// contains filtered or unexported fields
}

Defines a data set.

type DataSetImportConfig 

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

Identifies one or more data sets you want to import with the CreateDataSetImportTask operation.

The following types satisfy this interface: 

DataSetImportConfigMemberDataSets
DataSetImportConfigMemberS3Location
Example (OutputUsage) 
package main

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

func main() {
	var union types.DataSetImportConfig
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.DataSetImportConfigMemberDataSets:
		_ = v.Value // Value is []types.DataSetImportItem

	case *types.DataSetImportConfigMemberS3Location:
		_ = 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 DataSetImportConfigMemberDataSets 

type DataSetImportConfigMemberDataSets struct {
	Value []DataSetImportItem
	// contains filtered or unexported fields
}

The data sets.

type DataSetImportConfigMemberS3Location 

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

The Amazon S3 location of the data sets.

type DataSetImportItem 

type DataSetImportItem struct {

	// The data set.
	//
	// This member is required.
	DataSet *DataSet

	// The location of the data set.
	//
	// This member is required.
	ExternalLocation ExternalLocation
	// contains filtered or unexported fields
}

Identifies a specific data set to import from an external location.

type DataSetImportSummary 

type DataSetImportSummary struct {

	// The number of data set imports that have failed.
	//
	// This member is required.
	Failed int32

	// The number of data set imports that are in progress.
	//
	// This member is required.
	InProgress int32

	// The number of data set imports that are pending.
	//
	// This member is required.
	Pending int32

	// The number of data set imports that have succeeded.
	//
	// This member is required.
	Succeeded int32

	// The total number of data set imports.
	//
	// This member is required.
	Total int32
	// contains filtered or unexported fields
}

Represents a summary of data set imports.

type DataSetImportTask 

type DataSetImportTask struct {

	// The status of the data set import task.
	//
	// This member is required.
	Status DataSetTaskLifecycle

	// A summary of the data set import task.
	//
	// This member is required.
	Summary *DataSetImportSummary

	// The identifier of the data set import task.
	//
	// This member is required.
	TaskId *string

	// If dataset import failed, the failure reason will show here.
	StatusReason *string
	// contains filtered or unexported fields
}

Contains information about a data set import task.

type DataSetSummary 

type DataSetSummary struct {

	// The name of the data set.
	//
	// This member is required.
	DataSetName *string

	// The timestamp when the data set was created.
	CreationTime *time.Time

	// The type of data set. The only supported value is VSAM.
	DataSetOrg *string

	// The format of the data set.
	Format *string

	// The last time the data set was referenced.
	LastReferencedTime *time.Time

	// The last time the data set was updated.
	LastUpdatedTime *time.Time
	// contains filtered or unexported fields
}

A subset of the possible data set attributes.

type DataSetTaskLifecycle 

type DataSetTaskLifecycle string
const (
	DataSetTaskLifecycleCreating  DataSetTaskLifecycle = "Creating"
	DataSetTaskLifecycleRunning   DataSetTaskLifecycle = "Running"
	DataSetTaskLifecycleCompleted DataSetTaskLifecycle = "Completed"
	DataSetTaskLifecycleFailed    DataSetTaskLifecycle = "Failed"
)

Enum values for DataSetTaskLifecycle

func (DataSetTaskLifecycle) Values 

func (DataSetTaskLifecycle) Values() []DataSetTaskLifecycle

Values returns all known values for DataSetTaskLifecycle. 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 DatasetDetailOrgAttributes 

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

Additional details about the data set. Different attributes correspond to different data set organizations. The values are populated based on datasetOrg, storageType and backend (Blu Age or Micro Focus).

The following types satisfy this interface: 

DatasetDetailOrgAttributesMemberGdg
DatasetDetailOrgAttributesMemberPo
DatasetDetailOrgAttributesMemberPs
DatasetDetailOrgAttributesMemberVsam
Example (OutputUsage) 
package main

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

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

	case *types.DatasetDetailOrgAttributesMemberPo:
		_ = v.Value // Value is types.PoDetailAttributes

	case *types.DatasetDetailOrgAttributesMemberPs:
		_ = v.Value // Value is types.PsDetailAttributes

	case *types.DatasetDetailOrgAttributesMemberVsam:
		_ = v.Value // Value is types.VsamDetailAttributes

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

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

	}
}

Output:

type DatasetDetailOrgAttributesMemberGdg 

type DatasetDetailOrgAttributesMemberGdg struct {
	Value GdgDetailAttributes
	// contains filtered or unexported fields
}

The generation data group of the data set.

type DatasetDetailOrgAttributesMemberPo added in v1.5.0 

type DatasetDetailOrgAttributesMemberPo struct {
	Value PoDetailAttributes
	// contains filtered or unexported fields
}

The details of a PO type data set.

type DatasetDetailOrgAttributesMemberPs added in v1.5.0 

type DatasetDetailOrgAttributesMemberPs struct {
	Value PsDetailAttributes
	// contains filtered or unexported fields
}

The details of a PS type data set.

type DatasetDetailOrgAttributesMemberVsam 

type DatasetDetailOrgAttributesMemberVsam struct {
	Value VsamDetailAttributes
	// contains filtered or unexported fields
}

The details of a VSAM data set.

type DatasetOrgAttributes 

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

Additional details about the data set. Different attributes correspond to different data set organizations. The values are populated based on datasetOrg, storageType and backend (Blu Age or Micro Focus).

The following types satisfy this interface: 

DatasetOrgAttributesMemberGdg
DatasetOrgAttributesMemberPo
DatasetOrgAttributesMemberPs
DatasetOrgAttributesMemberVsam
Example (OutputUsage) 
package main

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

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

	case *types.DatasetOrgAttributesMemberPo:
		_ = v.Value // Value is types.PoAttributes

	case *types.DatasetOrgAttributesMemberPs:
		_ = v.Value // Value is types.PsAttributes

	case *types.DatasetOrgAttributesMemberVsam:
		_ = v.Value // Value is types.VsamAttributes

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

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

	}
}

Output:

type DatasetOrgAttributesMemberGdg 

type DatasetOrgAttributesMemberGdg struct {
	Value GdgAttributes
	// contains filtered or unexported fields
}

The generation data group of the data set.

type DatasetOrgAttributesMemberPo added in v1.5.0 

type DatasetOrgAttributesMemberPo struct {
	Value PoAttributes
	// contains filtered or unexported fields
}

The details of a PO type data set.

type DatasetOrgAttributesMemberPs added in v1.5.0 

type DatasetOrgAttributesMemberPs struct {
	Value PsAttributes
	// contains filtered or unexported fields
}

The details of a PS type data set.

type DatasetOrgAttributesMemberVsam 

type DatasetOrgAttributesMemberVsam struct {
	Value VsamAttributes
	// contains filtered or unexported fields
}

The details of a VSAM data set.

type Definition 

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

The application definition for a particular application.

The following types satisfy this interface: 

DefinitionMemberContent
DefinitionMemberS3Location
Example (OutputUsage) 
package main

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

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

	case *types.DefinitionMemberS3Location:
		_ = 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 DefinitionMemberContent 

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

The content of the application definition. This is a JSON object that contains the resource configuration/definitions that identify an application.

type DefinitionMemberS3Location 

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

The S3 bucket that contains the application definition.

type DeployedVersionSummary 

type DeployedVersionSummary struct {

	// The version of the deployed application.
	//
	// This member is required.
	ApplicationVersion *int32

	// The status of the deployment.
	//
	// This member is required.
	Status DeploymentLifecycle

	// The reason for the reported status.
	StatusReason *string
	// contains filtered or unexported fields
}

Contains a summary of a deployed application.

type DeploymentLifecycle 

type DeploymentLifecycle string
const (
	DeploymentLifecycleDeploying    DeploymentLifecycle = "Deploying"
	DeploymentLifecycleSucceeded    DeploymentLifecycle = "Succeeded"
	DeploymentLifecycleFailed       DeploymentLifecycle = "Failed"
	DeploymentLifecycleDeployUpdate DeploymentLifecycle = "Updating Deployment"
)

Enum values for DeploymentLifecycle

func (DeploymentLifecycle) Values 

func (DeploymentLifecycle) Values() []DeploymentLifecycle

Values returns all known values for DeploymentLifecycle. 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 DeploymentSummary 

type DeploymentSummary struct {

	// The unique identifier of the application.
	//
	// This member is required.
	ApplicationId *string

	// The version of the application.
	//
	// This member is required.
	ApplicationVersion *int32

	// The timestamp when the deployment was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The unique identifier of the deployment.
	//
	// This member is required.
	DeploymentId *string

	// The unique identifier of the runtime environment.
	//
	// This member is required.
	EnvironmentId *string

	// The current status of the deployment.
	//
	// This member is required.
	Status DeploymentLifecycle

	// The reason for the reported status.
	StatusReason *string
	// contains filtered or unexported fields
}

A subset of information about a specific deployment.

type EfsStorageConfiguration 

type EfsStorageConfiguration struct {

	// The file system identifier.
	//
	// This member is required.
	FileSystemId *string

	// The mount point for the file system.
	//
	// This member is required.
	MountPoint *string
	// contains filtered or unexported fields
}

Defines the storage configuration for an Amazon EFS file system.

type EngineType 

type EngineType string
const (
	EngineTypeMicrofocus EngineType = "microfocus"
	EngineTypeBluage     EngineType = "bluage"
)

Enum values for EngineType

func (EngineType) Values 

func (EngineType) Values() []EngineType

Values returns all known values for EngineType. 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 EngineVersionsSummary 

type EngineVersionsSummary struct {

	// The type of target platform for the application.
	//
	// This member is required.
	EngineType *string

	// The version of the engine type used by the application.
	//
	// This member is required.
	EngineVersion *string
	// contains filtered or unexported fields
}

A subset of information about the engine version for a specific application.

type EnvironmentLifecycle 

type EnvironmentLifecycle string
const (
	EnvironmentLifecycleCreating  EnvironmentLifecycle = "Creating"
	EnvironmentLifecycleAvailable EnvironmentLifecycle = "Available"
	EnvironmentLifecycleUpdating  EnvironmentLifecycle = "Updating"
	EnvironmentLifecycleDeleting  EnvironmentLifecycle = "Deleting"
	EnvironmentLifecycleFailed    EnvironmentLifecycle = "Failed"
)

Enum values for EnvironmentLifecycle

func (EnvironmentLifecycle) Values 

func (EnvironmentLifecycle) Values() []EnvironmentLifecycle

Values returns all known values for EnvironmentLifecycle. 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 EnvironmentSummary 

type EnvironmentSummary struct {

	// The timestamp when the runtime environment was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The target platform for the runtime environment.
	//
	// This member is required.
	EngineType EngineType

	// The version of the runtime engine.
	//
	// This member is required.
	EngineVersion *string

	// The Amazon Resource Name (ARN) of a particular runtime environment.
	//
	// This member is required.
	EnvironmentArn *string

	// The unique identifier of a particular runtime environment.
	//
	// This member is required.
	EnvironmentId *string

	// The instance type of the runtime environment.
	//
	// This member is required.
	InstanceType *string

	// The name of the runtime environment.
	//
	// This member is required.
	Name *string

	// The status of the runtime environment
	//
	// This member is required.
	Status EnvironmentLifecycle
	// contains filtered or unexported fields
}

Contains a subset of the possible runtime environment attributes. Used in the environment list.

type ExecutionTimeoutException added in v1.8.0 

type ExecutionTimeoutException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}
Failed to connect to server, or didn’t receive response within expected time

period.

func (*ExecutionTimeoutException) Error added in v1.8.0 

func (e *ExecutionTimeoutException) Error() string

func (*ExecutionTimeoutException) ErrorCode added in v1.8.0 

func (e *ExecutionTimeoutException) ErrorCode() string

func (*ExecutionTimeoutException) ErrorFault added in v1.8.0 

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

func (*ExecutionTimeoutException) ErrorMessage added in v1.8.0 

func (e *ExecutionTimeoutException) ErrorMessage() string

type ExternalLocation 

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

Defines an external storage location.

The following types satisfy this interface: 

ExternalLocationMemberS3Location
Example (OutputUsage) 
package main

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

func main() {
	var union types.ExternalLocation
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ExternalLocationMemberS3Location:
		_ = 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 ExternalLocationMemberS3Location 

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

The URI of the Amazon S3 bucket.

type FileBatchJobDefinition 

type FileBatchJobDefinition struct {

	// The name of the file containing the batch job definition.
	//
	// This member is required.
	FileName *string

	// The path to the file containing the batch job definition.
	FolderPath *string
	// contains filtered or unexported fields
}

A file containing a batch job definition.

type FileBatchJobIdentifier 

type FileBatchJobIdentifier struct {

	// The file name for the batch job identifier.
	//
	// This member is required.
	FileName *string

	// The relative path to the file name for the batch job identifier.
	FolderPath *string
	// contains filtered or unexported fields
}

A batch job identifier in which the batch job to run is identified by the file name and the relative path to the file name.

type FsxStorageConfiguration 

type FsxStorageConfiguration struct {

	// The file system identifier.
	//
	// This member is required.
	FileSystemId *string

	// The mount point for the file system.
	//
	// This member is required.
	MountPoint *string
	// contains filtered or unexported fields
}

Defines the storage configuration for an Amazon FSx file system.

type GdgAttributes 

type GdgAttributes struct {

	// The maximum number of generation data sets, up to 255, in a GDG.
	Limit int32

	// The disposition of the data set in the catalog.
	RollDisposition *string
	// contains filtered or unexported fields
}

The required attributes for a generation data group data set. A generation data set is one of a collection of successive, historically related, catalogued data sets that together are known as a generation data group (GDG). Use this structure when you want to import a GDG. For more information on GDG, see Generation data sets.

type GdgDetailAttributes 

type GdgDetailAttributes struct {

	// The maximum number of generation data sets, up to 255, in a GDG.
	Limit int32

	// The disposition of the data set in the catalog.
	RollDisposition *string
	// contains filtered or unexported fields
}

The required attributes for a generation data group data set. A generation data set is one of a collection of successive, historically related, catalogued data sets that together are known as a generation data group (GDG). Use this structure when you want to import a GDG. For more information on GDG, see Generation data sets.

type HighAvailabilityConfig 

type HighAvailabilityConfig struct {

	// The number of instances in a high availability configuration. The minimum
	// possible value is 1 and the maximum is 100.
	//
	// This member is required.
	DesiredCapacity *int32
	// contains filtered or unexported fields
}

Defines the details of a high availability configuration.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds int32
	// contains filtered or unexported fields
}

An unexpected error occurred during the processing of the request.

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 JobIdentifier added in v1.8.0 

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

Identifies a specific batch job.

The following types satisfy this interface: 

JobIdentifierMemberFileName
JobIdentifierMemberScriptName
Example (OutputUsage) 
package main

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

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

	case *types.JobIdentifierMemberScriptName:
		_ = 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 JobIdentifierMemberFileName added in v1.8.0 

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

The name of the file that contains the batch job definition.

type JobIdentifierMemberScriptName added in v1.8.0 

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

The name of the script that contains the batch job definition.

type JobStep added in v1.13.0 

type JobStep struct {

	// The name of a procedure step.
	ProcStepName *string

	// The number of a procedure step.
	ProcStepNumber int32

	// The condition code of a step.
	StepCondCode *string

	// The name of a step.
	StepName *string

	// The number of a step.
	StepNumber int32

	// Specifies if a step can be restarted or not.
	StepRestartable bool
	// contains filtered or unexported fields
}

Provides information related to a job step.

type JobStepRestartMarker added in v1.13.0 

type JobStepRestartMarker struct {

	// The step name that a batch job restart was from.
	//
	// This member is required.
	FromStep *string

	// The procedure step name that a job was restarted from.
	FromProcStep *string

	// The procedure step name that a batch job was restarted to.
	ToProcStep *string

	// The step name that a job was restarted to.
	ToStep *string
	// contains filtered or unexported fields
}

Provides restart step information for the most recent restart operation.

type LogGroupSummary 

type LogGroupSummary struct {

	// The name of the log group.
	//
	// This member is required.
	LogGroupName *string

	// The type of log.
	//
	// This member is required.
	LogType *string
	// contains filtered or unexported fields
}

A subset of the attributes that describe a log group. In CloudWatch a log group is a group of log streams that share the same retention, monitoring, and access control settings.

type MaintenanceSchedule 

type MaintenanceSchedule struct {

	// The time the scheduled maintenance is to end.
	EndTime *time.Time

	// The time the scheduled maintenance is to start.
	StartTime *time.Time
	// contains filtered or unexported fields
}

The information about the maintenance schedule.

type PendingMaintenance 

type PendingMaintenance struct {

	// The specific runtime engine that the maintenance schedule applies to.
	EngineVersion *string

	// The maintenance schedule for the runtime engine version.
	Schedule *MaintenanceSchedule
	// contains filtered or unexported fields
}

The scheduled maintenance for a runtime engine.

type PoAttributes added in v1.5.0 

type PoAttributes struct {

	// The format of the data set records.
	//
	// This member is required.
	Format *string

	// An array containing one or more filename extensions, allowing you to specify
	// which files to be included as PDS member.
	//
	// This member is required.
	MemberFileExtensions []string

	// The character set encoding of the data set.
	Encoding *string
	// contains filtered or unexported fields
}

The supported properties for a PO type data set.

type PoDetailAttributes added in v1.5.0 

type PoDetailAttributes struct {

	// The character set encoding of the data set.
	//
	// This member is required.
	Encoding *string

	// The format of the data set records.
	//
	// This member is required.
	Format *string
	// contains filtered or unexported fields
}

The supported properties for a PO type data set.

type PrimaryKey 

type PrimaryKey struct {

	// A strictly positive integer value representing the length of the primary key.
	//
	// This member is required.
	Length int32

	// A positive integer value representing the offset to mark the start of the
	// primary key in the record byte array.
	//
	// This member is required.
	Offset int32

	// A name for the Primary Key.
	Name *string
	// contains filtered or unexported fields
}

The primary key for a KSDS data set.

type PsAttributes added in v1.5.0 

type PsAttributes struct {

	// The format of the data set records.
	//
	// This member is required.
	Format *string

	// The character set encoding of the data set.
	Encoding *string
	// contains filtered or unexported fields
}

The supported properties for a PS type data set.

type PsDetailAttributes added in v1.5.0 

type PsDetailAttributes struct {

	// The character set encoding of the data set.
	//
	// This member is required.
	Encoding *string

	// The format of the data set records.
	//
	// This member is required.
	Format *string
	// contains filtered or unexported fields
}

The supported properties for a PS type data set.

type RecordLength 

type RecordLength struct {

	// The maximum record length. In case of fixed, both minimum and maximum are the
	// same.
	//
	// This member is required.
	Max int32

	// The minimum record length of a record.
	//
	// This member is required.
	Min int32
	// contains filtered or unexported fields
}

The length of the records in the data set.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The specified resource was not found.

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 RestartBatchJobIdentifier added in v1.13.0 

type RestartBatchJobIdentifier struct {

	// The executionId from the StartBatchJob response when the job ran for the first
	// time.
	//
	// This member is required.
	ExecutionId *string

	// The restart step information for the most recent restart operation.
	//
	// This member is required.
	JobStepRestartMarker *JobStepRestartMarker
	// contains filtered or unexported fields
}

An identifier for the StartBatchJob API to show that it is a restart operation.

type S3BatchJobIdentifier added in v1.8.0 

type S3BatchJobIdentifier struct {

	// The Amazon S3 bucket that contains the batch job definitions.
	//
	// This member is required.
	Bucket *string

	// Identifies the batch job definition. This identifier can also point to any
	// batch job definition that already exists in the application or to one of the
	// batch job definitions within the directory that is specified in keyPrefix .
	//
	// This member is required.
	Identifier JobIdentifier

	// The key prefix that specifies the path to the folder in the S3 bucket that has
	// the batch job definitions.
	KeyPrefix *string
	// contains filtered or unexported fields
}

A batch job identifier in which the batch jobs to run are identified by an Amazon S3 location.

type ScriptBatchJobDefinition 

type ScriptBatchJobDefinition struct {

	// The name of the script containing the batch job definition.
	//
	// This member is required.
	ScriptName *string
	// contains filtered or unexported fields
}

A batch job definition contained in a script.

type ScriptBatchJobIdentifier 

type ScriptBatchJobIdentifier struct {

	// The name of the script containing the batch job definition.
	//
	// This member is required.
	ScriptName *string
	// contains filtered or unexported fields
}

A batch job identifier in which the batch job to run is identified by the script name.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	ServiceCode  *string
	QuotaCode    *string
	// contains filtered or unexported fields
}

One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

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

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type ServiceUnavailableException added in v1.8.0 

type ServiceUnavailableException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Server cannot process the request at the moment.

func (*ServiceUnavailableException) Error added in v1.8.0 

func (e *ServiceUnavailableException) Error() string

func (*ServiceUnavailableException) ErrorCode added in v1.8.0 

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault added in v1.8.0 

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

func (*ServiceUnavailableException) ErrorMessage added in v1.8.0 

func (e *ServiceUnavailableException) ErrorMessage() string

type StorageConfiguration 

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

Defines the storage configuration for a runtime environment.

The following types satisfy this interface: 

StorageConfigurationMemberEfs
StorageConfigurationMemberFsx
Example (OutputUsage) 
package main

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

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

	case *types.StorageConfigurationMemberFsx:
		_ = v.Value // Value is types.FsxStorageConfiguration

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

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

	}
}

Output:

type StorageConfigurationMemberEfs 

type StorageConfigurationMemberEfs struct {
	Value EfsStorageConfiguration
	// contains filtered or unexported fields
}

Defines the storage configuration for an Amazon EFS file system.

type StorageConfigurationMemberFsx 

type StorageConfigurationMemberFsx struct {
	Value FsxStorageConfiguration
	// contains filtered or unexported fields
}

Defines the storage configuration for an Amazon FSx file system.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	ServiceCode       *string
	QuotaCode         *string
	RetryAfterSeconds int32
	// contains filtered or unexported fields
}

The number of requests made exceeds the limit.

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 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

	Reason    ValidationExceptionReason
	FieldList []ValidationExceptionField
	// contains filtered or unexported fields
}

One or more parameters provided in the request is not valid.

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 ValidationExceptionField 

type ValidationExceptionField struct {

	// The message of the exception field.
	//
	// This member is required.
	Message *string

	// The name of the exception field.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Contains information about a validation exception field.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation         ValidationExceptionReason = "unknownOperation"
	ValidationExceptionReasonCannotParse              ValidationExceptionReason = "cannotParse"
	ValidationExceptionReasonFeatureNotAvailable      ValidationExceptionReason = "featureNotAvailable"
	ValidationExceptionReasonUnsupportedEngineVersion ValidationExceptionReason = "unsupportedEngineVersion"
	ValidationExceptionReasonFieldValidationFailed    ValidationExceptionReason = "fieldValidationFailed"
	ValidationExceptionReasonOther                    ValidationExceptionReason = "other"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. 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 VsamAttributes 

type VsamAttributes struct {

	// The record format of the data set.
	//
	// This member is required.
	Format *string

	// The alternate key definitions, if any. A legacy dataset might not have any
	// alternate key defined, but if those alternate keys definitions exist, provide
	// them as some applications will make use of them.
	AlternateKeys []AlternateKey

	// Indicates whether indexes for this dataset are stored as compressed values. If
	// you have a large data set (typically > 100 Mb), consider setting this flag to
	// True.
	Compressed bool

	// The character set used by the data set. Can be ASCII, EBCDIC, or unknown.
	Encoding *string

	// The primary key of the data set.
	PrimaryKey *PrimaryKey
	// contains filtered or unexported fields
}

The attributes of a VSAM type data set.

type VsamDetailAttributes 

type VsamDetailAttributes struct {

	// The alternate key definitions, if any. A legacy dataset might not have any
	// alternate key defined, but if those alternate keys definitions exist, provide
	// them as some applications will make use of them.
	AlternateKeys []AlternateKey

	// If set to True, enforces loading the data set into cache before it’s used by
	// the application.
	CacheAtStartup *bool

	// Indicates whether indexes for this dataset are stored as compressed values. If
	// you have a large data set (typically > 100 Mb), consider setting this flag to
	// True.
	Compressed *bool

	// The character set used by the data set. Can be ASCII, EBCDIC, or unknown.
	Encoding *string

	// The primary key of the data set.
	PrimaryKey *PrimaryKey

	// The record format of the data set.
	RecordFormat *string
	// contains filtered or unexported fields
}

The attributes of a VSAM type data set.

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.