types

package
v1.15.3 Latest Latest
Warning

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

 Go to latest Published: Dec 2, 2025 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

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 don't have permission to perform the action.

Examples

  • The launch template instance profile doesn't pass iam:PassRole verification.

  • There is a mismatch between the account ID and cluster ID.

  • The cluster ID doesn't exist.

  • The EC2 instance isn't present.

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 Accounting added in v1.5.0 

type Accounting struct {

	// The default value for mode is STANDARD . A value of STANDARD means Slurm
	// accounting is enabled.
	//
	// This member is required.
	Mode AccountingMode

	// The default value for all purge settings for slurmdbd.conf . For more
	// information, see the [slurmdbd.conf documentation at SchedMD].
	//
	// The default value for defaultPurgeTimeInDays is -1 .
	//
	// A value of -1 means there is no purge time and records persist as long as the
	// cluster exists.
	//
	// 0 isn't a valid value.
	//
	// [slurmdbd.conf documentation at SchedMD]: https://slurm.schedmd.com/slurmdbd.conf.html
	DefaultPurgeTimeInDays *int32
	// contains filtered or unexported fields
}

The accounting configuration includes configurable settings for Slurm accounting. It's a property of the ClusterSlurmConfiguration object.

type AccountingMode added in v1.5.0 

type AccountingMode string
const (
	AccountingModeStandard AccountingMode = "STANDARD"
	AccountingModeNone     AccountingMode = "NONE"
)

Enum values for AccountingMode

func (AccountingMode) Values added in v1.5.0 

func (AccountingMode) Values() []AccountingMode

Values returns all known values for AccountingMode. 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 AccountingRequest added in v1.5.0 

type AccountingRequest struct {

	// The default value for mode is STANDARD . A value of STANDARD means Slurm
	// accounting is enabled.
	//
	// This member is required.
	Mode AccountingMode

	// The default value for all purge settings for slurmdbd.conf . For more
	// information, see the [slurmdbd.conf documentation at SchedMD].
	//
	// The default value for defaultPurgeTimeInDays is -1 .
	//
	// A value of -1 means there is no purge time and records persist as long as the
	// cluster exists.
	//
	// 0 isn't a valid value.
	//
	// [slurmdbd.conf documentation at SchedMD]: https://slurm.schedmd.com/slurmdbd.conf.html
	DefaultPurgeTimeInDays *int32
	// contains filtered or unexported fields
}

The accounting configuration includes configurable settings for Slurm accounting. It's a property of the ClusterSlurmConfiguration object.

type Cluster 

type Cluster struct {

	// The unique Amazon Resource Name (ARN) of the cluster.
	//
	// This member is required.
	Arn *string

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The generated unique ID of the cluster.
	//
	// This member is required.
	Id *string

	// The date and time the resource was modified.
	//
	// This member is required.
	ModifiedAt *time.Time

	// The name that identifies the cluster.
	//
	// This member is required.
	Name *string

	// The networking configuration for the cluster's control plane.
	//
	// This member is required.
	Networking *Networking

	// The cluster management and job scheduling software associated with the cluster.
	//
	// This member is required.
	Scheduler *Scheduler

	// The size of the cluster.
	//
	//   - SMALL : 32 compute nodes and 256 jobs
	//
	//   - MEDIUM : 512 compute nodes and 8192 jobs
	//
	//   - LARGE : 2048 compute nodes and 16,384 jobs
	//
	// This member is required.
	Size Size

	// The provisioning status of the cluster.
	//
	// The provisioning status doesn't indicate the overall health of the cluster.
	//
	// The resource enters the SUSPENDING and SUSPENDED states when the scheduler is
	// beyond end of life and we have suspended the cluster. When in these states, you
	// can't use the cluster. The cluster controller is down and all compute instances
	// are terminated. The resources still count toward your service quotas. You can
	// delete a resource if its status is SUSPENDED . For more information, see [Frequently asked questions about Slurm versions in PCS] in
	// the PCS User Guide.
	//
	// [Frequently asked questions about Slurm versions in PCS]: https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions_faq.html
	//
	// This member is required.
	Status ClusterStatus

	// The list of endpoints available for interaction with the scheduler.
	Endpoints []Endpoint

	// The list of errors that occurred during cluster provisioning.
	ErrorInfo []ErrorInfo

	// Additional options related to the Slurm scheduler.
	SlurmConfiguration *ClusterSlurmConfiguration
	// contains filtered or unexported fields
}

The cluster resource and configuration.

type ClusterSlurmConfiguration 

type ClusterSlurmConfiguration struct {

	// The accounting configuration includes configurable settings for Slurm
	// accounting.
	Accounting *Accounting

	// The shared Slurm key for authentication, also known as the cluster secret.
	AuthKey *SlurmAuthKey

	// The JWT authentication configuration for Slurm REST API access.
	JwtAuth *JwtAuth

	// The time (in seconds) before an idle node is scaled down.
	//
	// Default: 600
	ScaleDownIdleTimeInSeconds *int32

	// Additional Slurm-specific configuration that directly maps to Slurm settings.
	SlurmCustomSettings []SlurmCustomSetting

	// The Slurm REST API configuration for the cluster.
	SlurmRest *SlurmRest
	// contains filtered or unexported fields
}

Additional options related to the Slurm scheduler.

type ClusterSlurmConfigurationRequest 

type ClusterSlurmConfigurationRequest struct {

	// The accounting configuration includes configurable settings for Slurm
	// accounting.
	Accounting *AccountingRequest

	// The time (in seconds) before an idle node is scaled down.
	//
	// Default: 600
	ScaleDownIdleTimeInSeconds *int32

	// Additional Slurm-specific configuration that directly maps to Slurm settings.
	SlurmCustomSettings []SlurmCustomSetting

	// The Slurm REST API configuration for the cluster.
	SlurmRest *SlurmRestRequest
	// contains filtered or unexported fields
}

Additional options related to the Slurm scheduler.

type ClusterStatus 

type ClusterStatus string
const (
	ClusterStatusCreating     ClusterStatus = "CREATING"
	ClusterStatusActive       ClusterStatus = "ACTIVE"
	ClusterStatusUpdating     ClusterStatus = "UPDATING"
	ClusterStatusDeleting     ClusterStatus = "DELETING"
	ClusterStatusCreateFailed ClusterStatus = "CREATE_FAILED"
	ClusterStatusDeleteFailed ClusterStatus = "DELETE_FAILED"
	ClusterStatusUpdateFailed ClusterStatus = "UPDATE_FAILED"
	ClusterStatusSuspending   ClusterStatus = "SUSPENDING"
	ClusterStatusSuspended    ClusterStatus = "SUSPENDED"
)

Enum values for ClusterStatus

func (ClusterStatus) Values 

func (ClusterStatus) Values() []ClusterStatus

Values returns all known values for ClusterStatus. 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 ClusterSummary 

type ClusterSummary struct {

	// The unique Amazon Resource Name (ARN) of the cluster.
	//
	// This member is required.
	Arn *string

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The generated unique ID of the cluster.
	//
	// This member is required.
	Id *string

	// The date and time the resource was modified.
	//
	// This member is required.
	ModifiedAt *time.Time

	// The name that identifies the cluster.
	//
	// This member is required.
	Name *string

	// The provisioning status of the cluster.
	//
	// The provisioning status doesn't indicate the overall health of the cluster.
	//
	// The resource enters the SUSPENDING and SUSPENDED states when the scheduler is
	// beyond end of life and we have suspended the cluster. When in these states, you
	// can't use the cluster. The cluster controller is down and all compute instances
	// are terminated. The resources still count toward your service quotas. You can
	// delete a resource if its status is SUSPENDED . For more information, see [Frequently asked questions about Slurm versions in PCS] in
	// the PCS User Guide.
	//
	// [Frequently asked questions about Slurm versions in PCS]: https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions_faq.html
	//
	// This member is required.
	Status ClusterStatus
	// contains filtered or unexported fields
}

The object returned by the ListClusters API action.

type ComputeNodeGroup 

type ComputeNodeGroup struct {

	// The unique Amazon Resource Name (ARN) of the compute node group.
	//
	// This member is required.
	Arn *string

	// The ID of the cluster of the compute node group.
	//
	// This member is required.
	ClusterId *string

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// An Amazon EC2 launch template PCS uses to launch compute nodes.
	//
	// This member is required.
	CustomLaunchTemplate *CustomLaunchTemplate

	// The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM
	// role when launching EC2 instances. The role contained in your instance profile
	// must have the pcs:RegisterComputeNodeGroupInstance permission and the role name
	// must start with AWSPCS or must have the path /aws-pcs/ . For more information,
	// see [IAM instance profiles for PCS]in the PCS User Guide.
	//
	// [IAM instance profiles for PCS]: https://docs.aws.amazon.com/pcs/latest/userguide/security-instance-profiles.html
	//
	// This member is required.
	IamInstanceProfileArn *string

	// The generated unique ID of the compute node group.
	//
	// This member is required.
	Id *string

	// A list of EC2 instance configurations that PCS can provision in the compute
	// node group.
	//
	// This member is required.
	InstanceConfigs []InstanceConfig

	// The date and time the resource was modified.
	//
	// This member is required.
	ModifiedAt *time.Time

	// The name that identifies the compute node group.
	//
	// This member is required.
	Name *string

	// Specifies the boundaries of the compute node group auto scaling.
	//
	// This member is required.
	ScalingConfiguration *ScalingConfiguration

	// The provisioning status of the compute node group.
	//
	// The provisioning status doesn't indicate the overall health of the compute node
	// group.
	//
	// The resource enters the SUSPENDING and SUSPENDED states when the scheduler is
	// beyond end of life and we have suspended the cluster. When in these states, you
	// can't use the cluster. The cluster controller is down and all compute instances
	// are terminated. The resources still count toward your service quotas. You can
	// delete a resource if its status is SUSPENDED . For more information, see [Frequently asked questions about Slurm versions in PCS] in
	// the PCS User Guide.
	//
	// [Frequently asked questions about Slurm versions in PCS]: https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions_faq.html
	//
	// This member is required.
	Status ComputeNodeGroupStatus

	// The list of subnet IDs where instances are provisioned by the compute node
	// group. The subnets must be in the same VPC as the cluster.
	//
	// This member is required.
	SubnetIds []string

	// The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. If
	// not provided, PCS uses the AMI ID specified in the custom launch template.
	AmiId *string

	// The list of errors that occurred during compute node group provisioning.
	ErrorInfo []ErrorInfo

	// Specifies how EC2 instances are purchased on your behalf. PCS supports
	// On-Demand Instances, Spot Instances, and Amazon EC2 Capacity Blocks for ML. For
	// more information, see [Amazon EC2 billing and purchasing options]in the Amazon Elastic Compute Cloud User Guide. For more
	// information about PCS support for Capacity Blocks, see [Using Amazon EC2 Capacity Blocks for ML with PCS]in the PCS User Guide.
	// If you don't provide this option, it defaults to On-Demand.
	//
	// [Using Amazon EC2 Capacity Blocks for ML with PCS]: https://docs.aws.amazon.com/pcs/latest/userguide/capacity-blocks.html
	// [Amazon EC2 billing and purchasing options]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html
	PurchaseOption PurchaseOption

	// Additional options related to the Slurm scheduler.
	SlurmConfiguration *ComputeNodeGroupSlurmConfiguration

	// Additional configuration when you specify SPOT as the purchaseOption for the
	// CreateComputeNodeGroup API action.
	SpotOptions *SpotOptions
	// contains filtered or unexported fields
}

A compute node group associated with a cluster.

type ComputeNodeGroupConfiguration 

type ComputeNodeGroupConfiguration struct {

	// The compute node group ID for the compute node group configuration.
	ComputeNodeGroupId *string
	// contains filtered or unexported fields
}

The compute node group configuration for a queue.

type ComputeNodeGroupSlurmConfiguration 

type ComputeNodeGroupSlurmConfiguration struct {

	// Additional Slurm-specific configuration that directly maps to Slurm settings.
	SlurmCustomSettings []SlurmCustomSetting
	// contains filtered or unexported fields
}

Additional options related to the Slurm scheduler.

type ComputeNodeGroupSlurmConfigurationRequest 

type ComputeNodeGroupSlurmConfigurationRequest struct {

	// Additional Slurm-specific configuration that directly maps to Slurm settings.
	SlurmCustomSettings []SlurmCustomSetting
	// contains filtered or unexported fields
}

Additional options related to the Slurm scheduler.

type ComputeNodeGroupStatus 

type ComputeNodeGroupStatus string
const (
	ComputeNodeGroupStatusCreating     ComputeNodeGroupStatus = "CREATING"
	ComputeNodeGroupStatusActive       ComputeNodeGroupStatus = "ACTIVE"
	ComputeNodeGroupStatusUpdating     ComputeNodeGroupStatus = "UPDATING"
	ComputeNodeGroupStatusDeleting     ComputeNodeGroupStatus = "DELETING"
	ComputeNodeGroupStatusCreateFailed ComputeNodeGroupStatus = "CREATE_FAILED"
	ComputeNodeGroupStatusDeleteFailed ComputeNodeGroupStatus = "DELETE_FAILED"
	ComputeNodeGroupStatusUpdateFailed ComputeNodeGroupStatus = "UPDATE_FAILED"
	ComputeNodeGroupStatusDeleted      ComputeNodeGroupStatus = "DELETED"
	ComputeNodeGroupStatusSuspending   ComputeNodeGroupStatus = "SUSPENDING"
	ComputeNodeGroupStatusSuspended    ComputeNodeGroupStatus = "SUSPENDED"
)

Enum values for ComputeNodeGroupStatus

func (ComputeNodeGroupStatus) Values 

func (ComputeNodeGroupStatus) Values() []ComputeNodeGroupStatus

Values returns all known values for ComputeNodeGroupStatus. 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 ComputeNodeGroupSummary 

type ComputeNodeGroupSummary struct {

	// The unique Amazon Resource Name (ARN) of the compute node group.
	//
	// This member is required.
	Arn *string

	// The ID of the cluster of the compute node group.
	//
	// This member is required.
	ClusterId *string

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The generated unique ID of the compute node group.
	//
	// This member is required.
	Id *string

	// The date and time the resource was modified.
	//
	// This member is required.
	ModifiedAt *time.Time

	// The name that identifies the compute node group.
	//
	// This member is required.
	Name *string

	// The provisioning status of the compute node group.
	//
	// The provisioning status doesn't indicate the overall health of the compute node
	// group.
	//
	// The resource enters the SUSPENDING and SUSPENDED states when the scheduler is
	// beyond end of life and we have suspended the cluster. When in these states, you
	// can't use the cluster. The cluster controller is down and all compute instances
	// are terminated. The resources still count toward your service quotas. You can
	// delete a resource if its status is SUSPENDED . For more information, see [Frequently asked questions about Slurm versions in PCS] in
	// the PCS User Guide.
	//
	// [Frequently asked questions about Slurm versions in PCS]: https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions_faq.html
	//
	// This member is required.
	Status ComputeNodeGroupStatus
	// contains filtered or unexported fields
}

The object returned by the ListComputeNodeGroups API action.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

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

Your request has conflicting operations. This can occur if you're trying to perform more than 1 operation on the same resource at the same time.

Examples

  • A cluster with the same name already exists.

  • A cluster isn't in ACTIVE status.

  • A cluster to delete is in an unstable state. For example, because it still has ACTIVE node groups or queues.

  • A queue already exists in a cluster.

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 CustomLaunchTemplate 

type CustomLaunchTemplate struct {

	// The ID of the EC2 launch template to use to provision instances.
	//
	// Example: lt-xxxx
	//
	// This member is required.
	Id *string

	// The version of the EC2 launch template to use to provision instances.
	//
	// This member is required.
	Version *string
	// contains filtered or unexported fields
}

An Amazon EC2 launch template PCS uses to launch compute nodes.

type Endpoint 

type Endpoint struct {

	// The endpoint's connection port number.
	//
	// Example: 1234
	//
	// This member is required.
	Port *string

	// For clusters that use IPv4, this is the endpoint's private IP address.
	//
	// Example: 10.1.2.3
	//
	// For clusters configured to use IPv6, this is an empty string.
	//
	// This member is required.
	PrivateIpAddress *string

	// Indicates the type of endpoint running at the specific IP address.
	//
	// This member is required.
	Type EndpointType

	// The endpoint's IPv6 address.
	//
	// Example: 2001:db8::1
	Ipv6Address *string

	// The endpoint's public IP address.
	//
	// Example: 192.0.2.1
	PublicIpAddress *string
	// contains filtered or unexported fields
}

An endpoint available for interaction with the scheduler.

type EndpointType 

type EndpointType string
const (
	EndpointTypeSlurmctld  EndpointType = "SLURMCTLD"
	EndpointTypeSlurmdbd   EndpointType = "SLURMDBD"
	EndpointTypeSlurmrestd EndpointType = "SLURMRESTD"
)

Enum values for EndpointType

func (EndpointType) Values 

func (EndpointType) Values() []EndpointType

Values returns all known values for EndpointType. 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 ErrorInfo 

type ErrorInfo struct {

	// The short-form error code.
	Code *string

	// The detailed error information.
	Message *string
	// contains filtered or unexported fields
}

An error that occurred during resource creation.

type InstanceConfig 

type InstanceConfig struct {

	// The EC2 instance type that PCS can provision in the compute node group.
	//
	// Example: t2.xlarge
	InstanceType *string
	// contains filtered or unexported fields
}

An EC2 instance configuration PCS uses to launch compute nodes.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

PCS can't process your request right now. Try again later.

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 JwtAuth added in v1.15.0 

type JwtAuth struct {

	// The JWT key for Slurm REST API authentication.
	JwtKey *JwtKey
	// contains filtered or unexported fields
}

The JWT authentication configuration for Slurm REST API access.

type JwtKey added in v1.15.0 

type JwtKey struct {

	// The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the
	// JWT key.
	//
	// This member is required.
	SecretArn *string

	// The version of the AWS Secrets Manager secret containing the JWT key.
	//
	// This member is required.
	SecretVersion *string
	// contains filtered or unexported fields
}

The JWT key stored in AWS Secrets Manager for Slurm REST API authentication.

type NetworkType added in v1.8.0 

type NetworkType string
const (
	NetworkTypeIpv4 NetworkType = "IPV4"
	NetworkTypeIpv6 NetworkType = "IPV6"
)

Enum values for NetworkType

func (NetworkType) Values added in v1.8.0 

func (NetworkType) Values() []NetworkType

Values returns all known values for NetworkType. 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 Networking 

type Networking struct {

	// The IP address version the cluster uses. The default is IPV4 .
	NetworkType NetworkType

	// The list of security group IDs associated with the Elastic Network Interface
	// (ENI) created in subnets.
	//
	// The following rules are required:
	//
	//   - Inbound rule 1
	//
	//   - Protocol: All
	//
	//   - Ports: All
	//
	//   - Source: Self
	//
	//   - Outbound rule 1
	//
	//   - Protocol: All
	//
	//   - Ports: All
	//
	//   - Destination: 0.0.0.0/0 (IPv4) or ::/0 (IPv6)
	//
	//   - Outbound rule 2
	//
	//   - Protocol: All
	//
	//   - Ports: All
	//
	//   - Destination: Self
	SecurityGroupIds []string

	// The ID of the subnet where PCS creates an Elastic Network Interface (ENI) to
	// enable communication between managed controllers and PCS resources. The subnet
	// must have an available IP address, cannot reside in Outposts, Wavelength, or an
	// Amazon Web Services Local Zone.
	//
	// Example: subnet-abcd1234
	SubnetIds []string
	// contains filtered or unexported fields
}

The networking configuration for the cluster's control plane.

type NetworkingRequest 

type NetworkingRequest struct {

	// The IP address version the cluster uses. The default is IPV4 .
	NetworkType NetworkType

	// A list of security group IDs associated with the Elastic Network Interface
	// (ENI) created in subnets.
	SecurityGroupIds []string

	// The list of subnet IDs where PCS creates an Elastic Network Interface (ENI) to
	// enable communication between managed controllers and PCS resources. Subnet IDs
	// have the form subnet-0123456789abcdef0 .
	//
	// Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.
	//
	// PCS currently supports only 1 subnet in this list.
	SubnetIds []string
	// contains filtered or unexported fields
}

The networking configuration for the cluster's control plane.

type PurchaseOption 

type PurchaseOption string
const (
	PurchaseOptionOndemand      PurchaseOption = "ONDEMAND"
	PurchaseOptionSpot          PurchaseOption = "SPOT"
	PurchaseOptionCapacityBlock PurchaseOption = "CAPACITY_BLOCK"
)

Enum values for PurchaseOption

func (PurchaseOption) Values 

func (PurchaseOption) Values() []PurchaseOption

Values returns all known values for PurchaseOption. 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 Queue 

type Queue struct {

	// The unique Amazon Resource Name (ARN) of the queue.
	//
	// This member is required.
	Arn *string

	// The ID of the cluster of the queue.
	//
	// This member is required.
	ClusterId *string

	// The list of compute node group configurations associated with the queue. Queues
	// assign jobs to associated compute node groups.
	//
	// This member is required.
	ComputeNodeGroupConfigurations []ComputeNodeGroupConfiguration

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The generated unique ID of the queue.
	//
	// This member is required.
	Id *string

	// The date and time the resource was modified.
	//
	// This member is required.
	ModifiedAt *time.Time

	// The name that identifies the queue.
	//
	// This member is required.
	Name *string

	// The provisioning status of the queue.
	//
	// The provisioning status doesn't indicate the overall health of the queue.
	//
	// The resource enters the SUSPENDING and SUSPENDED states when the scheduler is
	// beyond end of life and we have suspended the cluster. When in these states, you
	// can't use the cluster. The cluster controller is down and all compute instances
	// are terminated. The resources still count toward your service quotas. You can
	// delete a resource if its status is SUSPENDED . For more information, see [Frequently asked questions about Slurm versions in PCS] in
	// the PCS User Guide.
	//
	// [Frequently asked questions about Slurm versions in PCS]: https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions_faq.html
	//
	// This member is required.
	Status QueueStatus

	// The list of errors that occurred during queue provisioning.
	ErrorInfo []ErrorInfo

	// Additional options related to the Slurm scheduler.
	SlurmConfiguration *QueueSlurmConfiguration
	// contains filtered or unexported fields
}

A queue resource.

type QueueSlurmConfiguration added in v1.14.0 

type QueueSlurmConfiguration struct {

	// Additional Slurm-specific configuration that directly maps to Slurm settings.
	SlurmCustomSettings []SlurmCustomSetting
	// contains filtered or unexported fields
}

Additional options related to the Slurm scheduler.

type QueueSlurmConfigurationRequest added in v1.14.0 

type QueueSlurmConfigurationRequest struct {

	// Additional Slurm-specific configuration that directly maps to Slurm settings.
	SlurmCustomSettings []SlurmCustomSetting
	// contains filtered or unexported fields
}

Additional options related to the Slurm scheduler.

type QueueStatus 

type QueueStatus string
const (
	QueueStatusCreating     QueueStatus = "CREATING"
	QueueStatusActive       QueueStatus = "ACTIVE"
	QueueStatusUpdating     QueueStatus = "UPDATING"
	QueueStatusDeleting     QueueStatus = "DELETING"
	QueueStatusCreateFailed QueueStatus = "CREATE_FAILED"
	QueueStatusDeleteFailed QueueStatus = "DELETE_FAILED"
	QueueStatusUpdateFailed QueueStatus = "UPDATE_FAILED"
	QueueStatusSuspending   QueueStatus = "SUSPENDING"
	QueueStatusSuspended    QueueStatus = "SUSPENDED"
)

Enum values for QueueStatus

func (QueueStatus) Values 

func (QueueStatus) Values() []QueueStatus

Values returns all known values for QueueStatus. 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 QueueSummary 

type QueueSummary struct {

	// The unique Amazon Resource Name (ARN) of the queue.
	//
	// This member is required.
	Arn *string

	// The ID of the cluster of the queue.
	//
	// This member is required.
	ClusterId *string

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The generated unique ID of the queue.
	//
	// This member is required.
	Id *string

	// The date and time the resource was modified.
	//
	// This member is required.
	ModifiedAt *time.Time

	// The name that identifies the queue.
	//
	// This member is required.
	Name *string

	// The provisioning status of the queue.
	//
	// The provisioning status doesn't indicate the overall health of the queue.
	//
	// The resource enters the SUSPENDING and SUSPENDED states when the scheduler is
	// beyond end of life and we have suspended the cluster. When in these states, you
	// can't use the cluster. The cluster controller is down and all compute instances
	// are terminated. The resources still count toward your service quotas. You can
	// delete a resource if its status is SUSPENDED . For more information, see [Frequently asked questions about Slurm versions in PCS] in
	// the PCS User Guide.
	//
	// [Frequently asked questions about Slurm versions in PCS]: https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions_faq.html
	//
	// This member is required.
	Status QueueStatus
	// contains filtered or unexported fields
}

The object returned by the ListQueues API action.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

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

The requested resource can't be found. The cluster, node group, or queue you're attempting to get, update, list, or delete doesn't exist.

Examples

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 ScalingConfiguration 

type ScalingConfiguration struct {

	// The upper bound of the number of instances allowed in the compute fleet.
	//
	// This member is required.
	MaxInstanceCount int32

	// The lower bound of the number of instances allowed in the compute fleet.
	//
	// This member is required.
	MinInstanceCount int32
	// contains filtered or unexported fields
}

Specifies the boundaries of the compute node group auto scaling.

type ScalingConfigurationRequest 

type ScalingConfigurationRequest struct {

	// The upper bound of the number of instances allowed in the compute fleet.
	//
	// This member is required.
	MaxInstanceCount int32

	// The lower bound of the number of instances allowed in the compute fleet.
	//
	// This member is required.
	MinInstanceCount int32
	// contains filtered or unexported fields
}

Specifies the boundaries of the compute node group auto scaling.

type Scheduler 

type Scheduler struct {

	// The software PCS uses to manage cluster scaling and job scheduling.
	//
	// This member is required.
	Type SchedulerType

	// The version of the specified scheduling software that PCS uses to manage
	// cluster scaling and job scheduling. For more information, see [Slurm versions in PCS]in the PCS User
	// Guide.
	//
	// Valid Values: 23.11 | 24.05 | 24.11
	//
	// [Slurm versions in PCS]: https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions.html
	//
	// This member is required.
	Version *string
	// contains filtered or unexported fields
}

The cluster management and job scheduling software associated with the cluster.

type SchedulerRequest 

type SchedulerRequest struct {

	// The software PCS uses to manage cluster scaling and job scheduling.
	//
	// This member is required.
	Type SchedulerType

	// The version of the specified scheduling software that PCS uses to manage
	// cluster scaling and job scheduling. For more information, see [Slurm versions in PCS]in the PCS User
	// Guide.
	//
	// Valid Values: 23.11 | 24.05 | 24.11
	//
	// [Slurm versions in PCS]: https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions.html
	//
	// This member is required.
	Version *string
	// contains filtered or unexported fields
}

The cluster management and job scheduling software associated with the cluster.

type SchedulerType 

type SchedulerType string
const (
	SchedulerTypeSlurm SchedulerType = "SLURM"
)

Enum values for SchedulerType

func (SchedulerType) Values 

func (SchedulerType) Values() []SchedulerType

Values returns all known values for SchedulerType. 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 ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

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

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account. To learn how to increase your service quota, see Requesting a quota increasein the Service Quotas User Guide

Examples

  • The max number of clusters or queues has been reached for the account.

  • The max number of compute node groups has been reached for the associated cluster.

  • The total of maxInstances across all compute node groups has been reached for associated cluster.

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 Size 

type Size string
const (
	SizeSmall  Size = "SMALL"
	SizeMedium Size = "MEDIUM"
	SizeLarge  Size = "LARGE"
)

Enum values for Size

func (Size) Values 

func (Size) Values() []Size

Values returns all known values for Size. 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 SlurmAuthKey 

type SlurmAuthKey struct {

	// The Amazon Resource Name (ARN) of the shared Slurm key.
	//
	// This member is required.
	SecretArn *string

	// The version of the shared Slurm key.
	//
	// This member is required.
	SecretVersion *string
	// contains filtered or unexported fields
}

The shared Slurm key for authentication, also known as the cluster secret.

type SlurmCustomSetting 

type SlurmCustomSetting struct {

	// PCS supports custom Slurm settings for clusters, compute node groups, and
	// queues. For more information, see [Configuring custom Slurm settings in PCS]in the PCS User Guide.
	//
	// [Configuring custom Slurm settings in PCS]: https://docs.aws.amazon.com/pcs/latest/userguide/slurm-custom-settings.html
	//
	// This member is required.
	ParameterName *string

	// The values for the configured Slurm settings.
	//
	// This member is required.
	ParameterValue *string
	// contains filtered or unexported fields
}

Additional settings that directly map to Slurm settings.

PCS supports a subset of Slurm settings. For more information, see Configuring custom Slurm settings in PCS in the PCS User Guide.

type SlurmRest added in v1.15.0 

type SlurmRest struct {

	// The default value for mode is STANDARD . A value of STANDARD means the Slurm
	// REST API is enabled.
	//
	// This member is required.
	Mode SlurmRestMode
	// contains filtered or unexported fields
}

The Slurm REST API configuration includes settings for enabling and configuring the Slurm REST API. It's a property of the ClusterSlurmConfiguration object.

type SlurmRestMode added in v1.15.0 

type SlurmRestMode string
const (
	SlurmRestModeStandard SlurmRestMode = "STANDARD"
	SlurmRestModeNone     SlurmRestMode = "NONE"
)

Enum values for SlurmRestMode

func (SlurmRestMode) Values added in v1.15.0 

func (SlurmRestMode) Values() []SlurmRestMode

Values returns all known values for SlurmRestMode. 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 SlurmRestRequest added in v1.15.0 

type SlurmRestRequest struct {

	// The default value for mode is STANDARD . A value of STANDARD means the Slurm
	// REST API is enabled.
	//
	// This member is required.
	Mode SlurmRestMode
	// contains filtered or unexported fields
}

The Slurm REST API configuration includes settings for enabling and configuring the Slurm REST API. It's a property of the ClusterSlurmConfiguration object.

type SpotAllocationStrategy 

type SpotAllocationStrategy string
const (
	SpotAllocationStrategyLowestPrice            SpotAllocationStrategy = "lowest-price"
	SpotAllocationStrategyCapacityOptimized      SpotAllocationStrategy = "capacity-optimized"
	SpotAllocationStrategyPriceCapacityOptimized SpotAllocationStrategy = "price-capacity-optimized"
)

Enum values for SpotAllocationStrategy

func (SpotAllocationStrategy) Values 

func (SpotAllocationStrategy) Values() []SpotAllocationStrategy

Values returns all known values for SpotAllocationStrategy. 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 SpotOptions 

type SpotOptions struct {

	// The Amazon EC2 allocation strategy PCS uses to provision EC2 instances. PCS
	// supports lowest price, capacity optimized, and price capacity optimized. For
	// more information, see [Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity]in the Amazon Elastic Compute Cloud User Guide. If you
	// don't provide this option, it defaults to price capacity optimized.
	//
	// [Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html
	AllocationStrategy SpotAllocationStrategy
	// contains filtered or unexported fields
}

Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

Your request exceeded a request rate quota. Check the resource's request rate quota and try again.

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 UpdateAccountingRequest added in v1.14.0 

type UpdateAccountingRequest struct {

	// The default value for all purge settings for slurmdbd.conf . For more
	// information, see the [slurmdbd.conf documentation at SchedMD].
	//
	// The default value for defaultPurgeTimeInDays is -1 .
	//
	// A value of -1 means there is no purge time and records persist as long as the
	// cluster exists.
	//
	// 0 isn't a valid value.
	//
	// [slurmdbd.conf documentation at SchedMD]: https://slurm.schedmd.com/slurmdbd.conf.html
	DefaultPurgeTimeInDays *int32

	// The default value for mode is STANDARD . A value of STANDARD means Slurm
	// accounting is enabled.
	Mode AccountingMode
	// contains filtered or unexported fields
}

The accounting configuration includes configurable settings for Slurm accounting.

type UpdateClusterSlurmConfigurationRequest added in v1.14.0 

type UpdateClusterSlurmConfigurationRequest struct {

	// The accounting configuration includes configurable settings for Slurm
	// accounting.
	Accounting *UpdateAccountingRequest

	// The time (in seconds) before an idle node is scaled down.
	//
	// Default: 600
	ScaleDownIdleTimeInSeconds *int32

	// Additional Slurm-specific configuration that directly maps to Slurm settings.
	SlurmCustomSettings []SlurmCustomSetting

	// The Slurm REST API configuration for the cluster.
	SlurmRest *UpdateSlurmRestRequest
	// contains filtered or unexported fields
}

Additional options related to the Slurm scheduler.

type UpdateComputeNodeGroupSlurmConfigurationRequest 

type UpdateComputeNodeGroupSlurmConfigurationRequest struct {

	// Additional Slurm-specific configuration that directly maps to Slurm settings.
	SlurmCustomSettings []SlurmCustomSetting
	// contains filtered or unexported fields
}

Additional options related to the Slurm scheduler.

type UpdateQueueSlurmConfigurationRequest added in v1.14.0 

type UpdateQueueSlurmConfigurationRequest struct {

	// Additional Slurm-specific configuration that directly maps to Slurm settings.
	SlurmCustomSettings []SlurmCustomSetting
	// contains filtered or unexported fields
}

Additional options related to the Slurm scheduler.

type UpdateSlurmRestRequest added in v1.15.0 

type UpdateSlurmRestRequest struct {

	// The default value for mode is STANDARD . A value of STANDARD means the Slurm
	// REST API is enabled.
	Mode SlurmRestMode
	// contains filtered or unexported fields
}

The Slurm REST API configuration includes settings for enabling and configuring the Slurm REST API.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

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

The request isn't valid.

Examples

  • Your request contains malformed JSON or unsupported characters.

  • The scheduler version isn't supported.

  • There are networking related errors, such as network validation failure.

  • AMI type is CUSTOM and the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.

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 body of the exception.
	//
	// This member is required.
	Message *string

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

Stores information about a field in a request that caused an exception.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "unknownOperation"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "cannotParse"
	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.

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.