pcs

package module
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: 47 Imported by: 2

Documentation

Overview

Package pcs provides the API client, operations, and parameter types for AWS Parallel Computing Service.

Parallel Computing Service (PCS) is a managed service that makes it easier for you to run and scale your high performance computing (HPC) workloads, and build scientific and engineering models on Amazon Web Services using Slurm. For more information, see the Parallel Computing Service User Guide.

This reference describes the actions and data types of the service management API. You can use the Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API actions manually. These API actions manage the service through an Amazon Web Services account.

The API actions operate on PCS resources. A resource is an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use the features of the service. Examples of PCS resources include clusters, compute node groups, and queues. For more information about resources in Amazon Web Services, see Resourcein the Resource Explorer User Guide.

An PCS compute node is an Amazon EC2 instance. You don't launch compute nodes directly. PCS uses configuration information that you provide to launch compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes. PCS automatically terminates your compute nodes when you delete the PCS resources related to those compute nodes.

Index

Constants

View Source
const ServiceAPIVersion = "2023-02-10"
View Source
const ServiceID = "PCS"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS Parallel Computing Service.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateCluster

func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error)

Creates a cluster in your account. PCS creates the cluster controller in a service-owned account. The cluster controller communicates with the cluster resources in your account. The subnets and security groups for the cluster must already exist before you use this API action.

It takes time for PCS to create the cluster. The cluster is in a Creating state until it is ready to use. There can only be 1 cluster in a Creating state per Amazon Web Services Region per Amazon Web Services account. CreateCluster fails with a ServiceQuotaExceededException if there is already a cluster in a Creating state.

func (*Client) CreateComputeNodeGroup

func (c *Client) CreateComputeNodeGroup(ctx context.Context, params *CreateComputeNodeGroupInput, optFns ...func(*Options)) (*CreateComputeNodeGroupOutput, error)

Creates a managed set of compute nodes. You associate a compute node group with a cluster through 1 or more PCS queues or as part of the login fleet. A compute node group includes the definition of the compute properties and lifecycle management. PCS uses the information you provide to this API action to launch compute nodes in your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive billing charges for the compute nodes that PCS launches in your account. You must already have a launch template before you call this API. For more information, see Launch an instance from a launch templatein the Amazon Elastic Compute Cloud User Guide for Linux Instances.

func (*Client) CreateQueue

func (c *Client) CreateQueue(ctx context.Context, params *CreateQueueInput, optFns ...func(*Options)) (*CreateQueueOutput, error)

Creates a job queue. You must associate 1 or more compute node groups with the queue. You can associate 1 compute node group with multiple queues.

func (*Client) DeleteCluster

func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, optFns ...func(*Options)) (*DeleteClusterOutput, error)

Deletes a cluster and all its linked resources. You must delete all queues and compute node groups associated with the cluster before you can delete the cluster.

func (*Client) DeleteComputeNodeGroup

func (c *Client) DeleteComputeNodeGroup(ctx context.Context, params *DeleteComputeNodeGroupInput, optFns ...func(*Options)) (*DeleteComputeNodeGroupOutput, error)

Deletes a compute node group. You must delete all queues associated with the compute node group first.

func (*Client) DeleteQueue

func (c *Client) DeleteQueue(ctx context.Context, params *DeleteQueueInput, optFns ...func(*Options)) (*DeleteQueueOutput, error)

Deletes a job queue. If the compute node group associated with this queue isn't associated with any other queues, PCS terminates all the compute nodes for this queue.

func (*Client) GetCluster

func (c *Client) GetCluster(ctx context.Context, params *GetClusterInput, optFns ...func(*Options)) (*GetClusterOutput, error)

Returns detailed information about a running cluster in your account. This API action provides networking information, endpoint information for communication with the scheduler, and provisioning status.

func (*Client) GetComputeNodeGroup

func (c *Client) GetComputeNodeGroup(ctx context.Context, params *GetComputeNodeGroupInput, optFns ...func(*Options)) (*GetComputeNodeGroupOutput, error)

Returns detailed information about a compute node group. This API action provides networking information, EC2 instance type, compute node group status, and scheduler (such as Slurm) configuration.

func (*Client) GetQueue

func (c *Client) GetQueue(ctx context.Context, params *GetQueueInput, optFns ...func(*Options)) (*GetQueueOutput, error)

Returns detailed information about a queue. The information includes the compute node groups that the queue uses to schedule jobs.

func (*Client) ListClusters

func (c *Client) ListClusters(ctx context.Context, params *ListClustersInput, optFns ...func(*Options)) (*ListClustersOutput, error)

Returns a list of running clusters in your account.

func (*Client) ListComputeNodeGroups

func (c *Client) ListComputeNodeGroups(ctx context.Context, params *ListComputeNodeGroupsInput, optFns ...func(*Options)) (*ListComputeNodeGroupsOutput, error)

Returns a list of all compute node groups associated with a cluster.

func (*Client) ListQueues

func (c *Client) ListQueues(ctx context.Context, params *ListQueuesInput, optFns ...func(*Options)) (*ListQueuesOutput, error)

Returns a list of all queues associated with a cluster.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Returns a list of all tags on an PCS resource.

func (*Client) Options

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) RegisterComputeNodeGroupInstance

func (c *Client) RegisterComputeNodeGroupInstance(ctx context.Context, params *RegisterComputeNodeGroupInstanceInput, optFns ...func(*Options)) (*RegisterComputeNodeGroupInstanceOutput, error)

This API action isn't intended for you to use.

PCS uses this API action to register the compute nodes it launches in your account.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds or edits tags on an PCS resource. Each tag consists of a tag key and a tag value. The tag key and tag value are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Deletes tags from an PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the PCS resource.

func (*Client) UpdateCluster added in v1.14.0

func (c *Client) UpdateCluster(ctx context.Context, params *UpdateClusterInput, optFns ...func(*Options)) (*UpdateClusterOutput, error)

Updates a cluster configuration. You can modify Slurm scheduler settings, accounting configuration, and security groups for an existing cluster.

You can only update clusters that are in ACTIVE , UPDATE_FAILED , or SUSPENDED state. All associated resources (queues and compute node groups) must be in ACTIVE state before you can update the cluster.

func (*Client) UpdateComputeNodeGroup

func (c *Client) UpdateComputeNodeGroup(ctx context.Context, params *UpdateComputeNodeGroupInput, optFns ...func(*Options)) (*UpdateComputeNodeGroupOutput, error)

Updates a compute node group. You can update many of the fields related to your compute node group including the configurations for networking, compute nodes, and settings specific to your scheduler (such as Slurm).

func (*Client) UpdateQueue

func (c *Client) UpdateQueue(ctx context.Context, params *UpdateQueueInput, optFns ...func(*Options)) (*UpdateQueueOutput, error)

Updates the compute node group configuration of a queue. Use this API to change the compute node groups that the queue can send jobs to.

type CreateClusterInput

type CreateClusterInput struct {

	// A name to identify the cluster. Example: MyCluster
	//
	// This member is required.
	ClusterName *string

	// The networking configuration used to set up the cluster's control plane.
	//
	// This member is required.
	Networking *types.NetworkingRequest

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

	// A value that determines the maximum number of compute nodes in the cluster and
	// the maximum number of jobs (active and queued).
	//
	//   - 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 types.Size

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully, the
	// subsequent retries with the same client token return the result from the
	// original successful request and they have no additional effect. If you don't
	// specify a client token, the CLI and SDK automatically generate 1 for you.
	ClientToken *string

	// Additional options related to the Slurm scheduler.
	SlurmConfiguration *types.ClusterSlurmConfigurationRequest

	// 1 or more tags added to the resource. Each tag consists of a tag key and tag
	// value. The tag value is optional and can be an empty string.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateClusterOutput

type CreateClusterOutput struct {

	// The cluster resource.
	Cluster *types.Cluster

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateComputeNodeGroupInput

type CreateComputeNodeGroupInput struct {

	// The name or ID of the cluster to create a compute node group in.
	//
	// This member is required.
	ClusterIdentifier *string

	// A name to identify the cluster. Example: MyCluster
	//
	// This member is required.
	ComputeNodeGroupName *string

	// An Amazon EC2 launch template PCS uses to launch compute nodes.
	//
	// This member is required.
	CustomLaunchTemplate *types.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

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

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

	// The list of subnet IDs where the compute node group launches instances. 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 compute nodes
	// (Amazon EC2 instances). If you don't provide this value, PCS uses the AMI ID
	// specified in the custom launch template.
	AmiId *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully, the
	// subsequent retries with the same client token return the result from the
	// original successful request and they have no additional effect. If you don't
	// specify a client token, the CLI and SDK automatically generate 1 for you.
	ClientToken *string

	// 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 types.PurchaseOption

	// Additional options related to the Slurm scheduler.
	SlurmConfiguration *types.ComputeNodeGroupSlurmConfigurationRequest

	// Additional configuration when you specify SPOT as the purchaseOption for the
	// CreateComputeNodeGroup API action.
	SpotOptions *types.SpotOptions

	// 1 or more tags added to the resource. Each tag consists of a tag key and tag
	// value. The tag value is optional and can be an empty string.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateComputeNodeGroupOutput

type CreateComputeNodeGroupOutput struct {

	// A compute node group associated with a cluster.
	ComputeNodeGroup *types.ComputeNodeGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateQueueInput

type CreateQueueInput struct {

	// The name or ID of the cluster for which to create a queue.
	//
	// This member is required.
	ClusterIdentifier *string

	// A name to identify the queue.
	//
	// This member is required.
	QueueName *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully, the
	// subsequent retries with the same client token return the result from the
	// original successful request and they have no additional effect. If you don't
	// specify a client token, the CLI and SDK automatically generate 1 for you.
	ClientToken *string

	// The list of compute node group configurations to associate with the queue.
	// Queues assign jobs to associated compute node groups.
	ComputeNodeGroupConfigurations []types.ComputeNodeGroupConfiguration

	// Additional options related to the Slurm scheduler.
	SlurmConfiguration *types.QueueSlurmConfigurationRequest

	// 1 or more tags added to the resource. Each tag consists of a tag key and tag
	// value. The tag value is optional and can be an empty string.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateQueueOutput

type CreateQueueOutput struct {

	// A queue resource.
	Queue *types.Queue

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteClusterInput

type DeleteClusterInput struct {

	// The name or ID of the cluster to delete.
	//
	// This member is required.
	ClusterIdentifier *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully, the
	// subsequent retries with the same client token return the result from the
	// original successful request and they have no additional effect. If you don't
	// specify a client token, the CLI and SDK automatically generate 1 for you.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteClusterOutput

type DeleteClusterOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteComputeNodeGroupInput

type DeleteComputeNodeGroupInput struct {

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

	// The name or ID of the compute node group to delete.
	//
	// This member is required.
	ComputeNodeGroupIdentifier *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully, the
	// subsequent retries with the same client token return the result from the
	// original successful request and they have no additional effect. If you don't
	// specify a client token, the CLI and SDK automatically generate 1 for you.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteComputeNodeGroupOutput

type DeleteComputeNodeGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteQueueInput

type DeleteQueueInput struct {

	// The name or ID of the cluster of the queue.
	//
	// This member is required.
	ClusterIdentifier *string

	// The name or ID of the queue to delete.
	//
	// This member is required.
	QueueIdentifier *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully, the
	// subsequent retries with the same client token return the result from the
	// original successful request and they have no additional effect. If you don't
	// specify a client token, the CLI and SDK automatically generate 1 for you.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteQueueOutput

type DeleteQueueOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetClusterInput

type GetClusterInput struct {

	// The name or ID of the cluster.
	//
	// This member is required.
	ClusterIdentifier *string
	// contains filtered or unexported fields
}

type GetClusterOutput

type GetClusterOutput struct {

	// The cluster resource.
	Cluster *types.Cluster

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetComputeNodeGroupInput

type GetComputeNodeGroupInput struct {

	// The name or ID of the cluster.
	//
	// This member is required.
	ClusterIdentifier *string

	// The name or ID of the compute node group.
	//
	// This member is required.
	ComputeNodeGroupIdentifier *string
	// contains filtered or unexported fields
}

type GetComputeNodeGroupOutput

type GetComputeNodeGroupOutput struct {

	// A compute node group associated with a cluster.
	ComputeNodeGroup *types.ComputeNodeGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetQueueInput

type GetQueueInput struct {

	// The name or ID of the cluster of the queue.
	//
	// This member is required.
	ClusterIdentifier *string

	// The name or ID of the queue.
	//
	// This member is required.
	QueueIdentifier *string
	// contains filtered or unexported fields
}

type GetQueueOutput

type GetQueueOutput struct {

	// A queue resource.
	Queue *types.Queue

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListClustersAPIClient

type ListClustersAPIClient interface {
	ListClusters(context.Context, *ListClustersInput, ...func(*Options)) (*ListClustersOutput, error)
}

ListClustersAPIClient is a client that implements the ListClusters operation.

type ListClustersInput

type ListClustersInput struct {

	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results. The default is 10 results, and the maximum
	// allowed page size is 100 results. A value of 0 uses the default.
	MaxResults *int32

	// The value of nextToken is a unique pagination token for each page of results
	// returned. If nextToken is returned, there are more results available. Make the
	// call again using the returned token to retrieve the next page. Keep all other
	// arguments unchanged. Each pagination token expires after 24 hours. Using an
	// expired pagination token returns an HTTP 400 InvalidToken error.
	NextToken *string
	// contains filtered or unexported fields
}

type ListClustersOutput

type ListClustersOutput struct {

	// The list of clusters.
	//
	// This member is required.
	Clusters []types.ClusterSummary

	// The value of nextToken is a unique pagination token for each page of results
	// returned. If nextToken is returned, there are more results available. Make the
	// call again using the returned token to retrieve the next page. Keep all other
	// arguments unchanged. Each pagination token expires after 24 hours. Using an
	// expired pagination token returns an HTTP 400 InvalidToken error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListClustersPaginator

type ListClustersPaginator struct {
	// contains filtered or unexported fields
}

ListClustersPaginator is a paginator for ListClusters

func NewListClustersPaginator

func NewListClustersPaginator(client ListClustersAPIClient, params *ListClustersInput, optFns ...func(*ListClustersPaginatorOptions)) *ListClustersPaginator

NewListClustersPaginator returns a new ListClustersPaginator

func (*ListClustersPaginator) HasMorePages

func (p *ListClustersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListClustersPaginator) NextPage

func (p *ListClustersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListClustersOutput, error)

NextPage retrieves the next ListClusters page.

type ListClustersPaginatorOptions

type ListClustersPaginatorOptions struct {
	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results. The default is 10 results, and the maximum
	// allowed page size is 100 results. A value of 0 uses the default.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListClustersPaginatorOptions is the paginator options for ListClusters

type ListComputeNodeGroupsAPIClient

type ListComputeNodeGroupsAPIClient interface {
	ListComputeNodeGroups(context.Context, *ListComputeNodeGroupsInput, ...func(*Options)) (*ListComputeNodeGroupsOutput, error)
}

ListComputeNodeGroupsAPIClient is a client that implements the ListComputeNodeGroups operation.

type ListComputeNodeGroupsInput

type ListComputeNodeGroupsInput struct {

	// The name or ID of the cluster to list compute node groups for.
	//
	// This member is required.
	ClusterIdentifier *string

	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results. The default is 10 results, and the maximum
	// allowed page size is 100 results. A value of 0 uses the default.
	MaxResults *int32

	// The value of nextToken is a unique pagination token for each page of results
	// returned. If nextToken is returned, there are more results available. Make the
	// call again using the returned token to retrieve the next page. Keep all other
	// arguments unchanged. Each pagination token expires after 24 hours. Using an
	// expired pagination token returns an HTTP 400 InvalidToken error.
	NextToken *string
	// contains filtered or unexported fields
}

type ListComputeNodeGroupsOutput

type ListComputeNodeGroupsOutput struct {

	// The list of compute node groups for the cluster.
	//
	// This member is required.
	ComputeNodeGroups []types.ComputeNodeGroupSummary

	// The value of nextToken is a unique pagination token for each page of results
	// returned. If nextToken is returned, there are more results available. Make the
	// call again using the returned token to retrieve the next page. Keep all other
	// arguments unchanged. Each pagination token expires after 24 hours. Using an
	// expired pagination token returns an HTTP 400 InvalidToken error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListComputeNodeGroupsPaginator

type ListComputeNodeGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListComputeNodeGroupsPaginator is a paginator for ListComputeNodeGroups

func NewListComputeNodeGroupsPaginator

NewListComputeNodeGroupsPaginator returns a new ListComputeNodeGroupsPaginator

func (*ListComputeNodeGroupsPaginator) HasMorePages

func (p *ListComputeNodeGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListComputeNodeGroupsPaginator) NextPage

NextPage retrieves the next ListComputeNodeGroups page.

type ListComputeNodeGroupsPaginatorOptions

type ListComputeNodeGroupsPaginatorOptions struct {
	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results. The default is 10 results, and the maximum
	// allowed page size is 100 results. A value of 0 uses the default.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListComputeNodeGroupsPaginatorOptions is the paginator options for ListComputeNodeGroups

type ListQueuesAPIClient

type ListQueuesAPIClient interface {
	ListQueues(context.Context, *ListQueuesInput, ...func(*Options)) (*ListQueuesOutput, error)
}

ListQueuesAPIClient is a client that implements the ListQueues operation.

type ListQueuesInput

type ListQueuesInput struct {

	// The name or ID of the cluster to list queues for.
	//
	// This member is required.
	ClusterIdentifier *string

	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results. The default is 10 results, and the maximum
	// allowed page size is 100 results. A value of 0 uses the default.
	MaxResults *int32

	// The value of nextToken is a unique pagination token for each page of results
	// returned. If nextToken is returned, there are more results available. Make the
	// call again using the returned token to retrieve the next page. Keep all other
	// arguments unchanged. Each pagination token expires after 24 hours. Using an
	// expired pagination token returns an HTTP 400 InvalidToken error.
	NextToken *string
	// contains filtered or unexported fields
}

type ListQueuesOutput

type ListQueuesOutput struct {

	// The list of queues associated with the cluster.
	//
	// This member is required.
	Queues []types.QueueSummary

	// The value of nextToken is a unique pagination token for each page of results
	// returned. If nextToken is returned, there are more results available. Make the
	// call again using the returned token to retrieve the next page. Keep all other
	// arguments unchanged. Each pagination token expires after 24 hours. Using an
	// expired pagination token returns an HTTP 400 InvalidToken error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListQueuesPaginator

type ListQueuesPaginator struct {
	// contains filtered or unexported fields
}

ListQueuesPaginator is a paginator for ListQueues

func NewListQueuesPaginator

func NewListQueuesPaginator(client ListQueuesAPIClient, params *ListQueuesInput, optFns ...func(*ListQueuesPaginatorOptions)) *ListQueuesPaginator

NewListQueuesPaginator returns a new ListQueuesPaginator

func (*ListQueuesPaginator) HasMorePages

func (p *ListQueuesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListQueuesPaginator) NextPage

func (p *ListQueuesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListQueuesOutput, error)

NextPage retrieves the next ListQueues page.

type ListQueuesPaginatorOptions

type ListQueuesPaginatorOptions struct {
	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results. The default is 10 results, and the maximum
	// allowed page size is 100 results. A value of 0 uses the default.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListQueuesPaginatorOptions is the paginator options for ListQueues

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource for which to list tags.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// 1 or more tags added to the resource. Each tag consists of a tag key and tag
	// value. The tag value is optional and can be an empty string.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// Client registry of operation interceptors.
	Interceptors smithyhttp.InterceptorRegistry

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme

	// Priority list of preferred auth scheme names (e.g. sigv4a).
	AuthSchemePreference []string
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type RegisterComputeNodeGroupInstanceInput

type RegisterComputeNodeGroupInstanceInput struct {

	// The client-generated token to allow for retries.
	//
	// This member is required.
	BootstrapId *string

	// The name or ID of the cluster to register the compute node group instance in.
	//
	// This member is required.
	ClusterIdentifier *string
	// contains filtered or unexported fields
}

type RegisterComputeNodeGroupInstanceOutput

type RegisterComputeNodeGroupInstanceOutput struct {

	// The list of endpoints available for interaction with the scheduler.
	//
	// This member is required.
	Endpoints []types.Endpoint

	// The scheduler node ID for this instance.
	//
	// This member is required.
	NodeID *string

	// For the Slurm scheduler, this is the shared Munge key the scheduler uses to
	// authenticate compute node group instances.
	//
	// This member is required.
	SharedSecret *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type TagResourceInput

type TagResourceInput struct {

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

	// 1 or more tags added to the resource. Each tag consists of a tag key and tag
	// value. The tag value is optional and can be an empty string.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput

type UntagResourceInput struct {

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

	// 1 or more tag keys to remove from the resource. Specify only tag keys and not
	// tag values.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateClusterInput added in v1.14.0

type UpdateClusterInput struct {

	// The name or ID of the cluster to update.
	//
	// This member is required.
	ClusterIdentifier *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully, the
	// subsequent retries with the same client token return the result from the
	// original successful request and they have no additional effect. If you don't
	// specify a client token, the CLI and SDK automatically generate 1 for you.
	ClientToken *string

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

type UpdateClusterOutput added in v1.14.0

type UpdateClusterOutput struct {

	// The cluster resource and configuration.
	Cluster *types.Cluster

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateComputeNodeGroupInput

type UpdateComputeNodeGroupInput struct {

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

	// The name or ID of the compute node group.
	//
	// This member is required.
	ComputeNodeGroupIdentifier *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

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully, the
	// subsequent retries with the same client token return the result from the
	// original successful request and they have no additional effect. If you don't
	// specify a client token, the CLI and SDK automatically generate 1 for you.
	ClientToken *string

	// An Amazon EC2 launch template PCS uses to launch compute nodes.
	CustomLaunchTemplate *types.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
	IamInstanceProfileArn *string

	// 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 types.PurchaseOption

	// Specifies the boundaries of the compute node group auto scaling.
	ScalingConfiguration *types.ScalingConfigurationRequest

	// Additional options related to the Slurm scheduler.
	SlurmConfiguration *types.UpdateComputeNodeGroupSlurmConfigurationRequest

	// Additional configuration when you specify SPOT as the purchaseOption for the
	// CreateComputeNodeGroup API action.
	SpotOptions *types.SpotOptions

	// The list of subnet IDs where the compute node group provisions instances. The
	// subnets must be in the same VPC as the cluster.
	SubnetIds []string
	// contains filtered or unexported fields
}

type UpdateComputeNodeGroupOutput

type UpdateComputeNodeGroupOutput struct {

	// A compute node group associated with a cluster.
	ComputeNodeGroup *types.ComputeNodeGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateQueueInput

type UpdateQueueInput struct {

	// The name or ID of the cluster of the queue.
	//
	// This member is required.
	ClusterIdentifier *string

	// The name or ID of the queue.
	//
	// This member is required.
	QueueIdentifier *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully, the
	// subsequent retries with the same client token return the result from the
	// original successful request and they have no additional effect. If you don't
	// specify a client token, the CLI and SDK automatically generate 1 for you.
	ClientToken *string

	// The list of compute node group configurations to associate with the queue.
	// Queues assign jobs to associated compute node groups.
	ComputeNodeGroupConfigurations []types.ComputeNodeGroupConfiguration

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

type UpdateQueueOutput

type UpdateQueueOutput struct {

	// A queue resource.
	Queue *types.Queue

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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