AWS.Tools.PCS.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.PCS</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.PCS.AddPCSResourceTagCmdlet"> <summary> Adds or edits tags on an Amazon Web Services 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.AddPCSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.AddPCSResourceTagCmdlet.Tag"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.AddPCSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.AddPCSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.GetPCSClusterCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSClusterCmdlet.ClusterIdentifier"> <summary> <para> <para>The name or ID of the cluster of the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.GetClusterResponse). Specifying the name of a property of type Amazon.PCS.Model.GetClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.GetPCSClusterListCmdlet"> <summary> Returns a list of running clusters in your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSClusterListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <c>nextToken</c> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSClusterListCmdlet.NextToken"> <summary> <para> <para>The value of <c>nextToken</c> is a unique pagination token for each page of results returned. If <c>nextToken</c> 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 <c>HTTP 400 InvalidToken</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSClusterListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Clusters'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.ListClustersResponse). Specifying the name of a property of type Amazon.PCS.Model.ListClustersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.GetPCSComputeNodeGroupCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSComputeNodeGroupCmdlet.ClusterIdentifier"> <summary> <para> <para>The name or ID of the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSComputeNodeGroupCmdlet.ComputeNodeGroupIdentifier"> <summary> <para> <para>The name or ID of the compute node group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSComputeNodeGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComputeNodeGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.GetComputeNodeGroupResponse). Specifying the name of a property of type Amazon.PCS.Model.GetComputeNodeGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.GetPCSComputeNodeGroupListCmdlet"> <summary> Returns a list of all compute node groups associated with a cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSComputeNodeGroupListCmdlet.ClusterIdentifier"> <summary> <para> <para>The name or ID of the cluster to list compute node groups for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSComputeNodeGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <c>nextToken</c> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSComputeNodeGroupListCmdlet.NextToken"> <summary> <para> <para>The value of <c>nextToken</c> is a unique pagination token for each page of results returned. If <c>nextToken</c> 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 <c>HTTP 400 InvalidToken</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSComputeNodeGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComputeNodeGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.ListComputeNodeGroupsResponse). Specifying the name of a property of type Amazon.PCS.Model.ListComputeNodeGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.GetPCSQueueCmdlet"> <summary> Returns detailed information about a queue. The information includes the compute node groups that the queue uses to schedule jobs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSQueueCmdlet.ClusterIdentifier"> <summary> <para> <para>The name or ID of the cluster of the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSQueueCmdlet.QueueIdentifier"> <summary> <para> <para>The name or ID of the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSQueueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Queue'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.GetQueueResponse). Specifying the name of a property of type Amazon.PCS.Model.GetQueueResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.GetPCSQueueListCmdlet"> <summary> Returns a list of all queues associated with a cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSQueueListCmdlet.ClusterIdentifier"> <summary> <para> <para>The name or ID of the cluster to list queues for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSQueueListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <c>nextToken</c> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSQueueListCmdlet.NextToken"> <summary> <para> <para>The value of <c>nextToken</c> is a unique pagination token for each page of results returned. If <c>nextToken</c> 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 <c>HTTP 400 InvalidToken</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSQueueListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Queues'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.ListQueuesResponse). Specifying the name of a property of type Amazon.PCS.Model.ListQueuesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.GetPCSResourceTagCmdlet"> <summary> Returns a list of all tags on an Amazon Web Services PCS resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource for which to list tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.GetPCSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.PCS.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.NewPCSClusterCmdlet"> <summary> Creates a cluster in your account. Amazon Web Services 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. <note><para> It takes time for Amazon Web Services PCS to create the cluster. The cluster is in a <c>Creating</c> state until it is ready to use. There can only be 1 cluster in a <c>Creating</c> state per Amazon Web Services Region per Amazon Web Services account. <c>CreateCluster</c> fails with a <c>ServiceQuotaExceededException</c> if there is already a cluster in a <c>Creating</c> state. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSClusterCmdlet.ClusterName"> <summary> <para> <para>A name to identify the cluster. Example: <c>MyCluster</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSClusterCmdlet.SlurmConfiguration_ScaleDownIdleTimeInSecond"> <summary> <para> <para>The time (in seconds) before an idle node is scaled down.</para><para>Default: <c>600</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSClusterCmdlet.Networking_SecurityGroupId"> <summary> <para> <para>A list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSClusterCmdlet.Size"> <summary> <para> <para>A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).</para><ul><li><para><c>SMALL</c>: 32 compute nodes and 256 jobs</para></li><li><para><c>MEDIUM</c>: 512 compute nodes and 8192 jobs</para></li><li><para><c>LARGE</c>: 2048 compute nodes and 16,384 jobs</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSClusterCmdlet.SlurmConfiguration_SlurmCustomSetting"> <summary> <para> <para>Additional Slurm-specific configuration that directly maps to Slurm settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSClusterCmdlet.Networking_SubnetId"> <summary> <para> <para>The list of subnet IDs where Amazon Web Services PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and Amazon Web Services PCS resources. Subnet IDs have the form <c>subnet-0123456789abcdef0</c>.</para><para>Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.</para><note><para>Amazon Web Services PCS currently supports only 1 subnet in this list.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSClusterCmdlet.Tag"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSClusterCmdlet.Scheduler_Type"> <summary> <para> <para>The software Amazon Web Services PCS uses to manage cluster scaling and job scheduling.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSClusterCmdlet.Scheduler_Version"> <summary> <para> <para>The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see <a href="https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions.html">Slurm versions in Amazon Web Services PCS</a> in the <i>Amazon Web Services PCS User Guide</i>.</para><para>Valid Values: <c>23.11 | 24.05</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSClusterCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.CreateClusterResponse). Specifying the name of a property of type Amazon.PCS.Model.CreateClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSClusterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet"> <summary> Creates a managed set of compute nodes. You associate a compute node group with a cluster through 1 or more Amazon Web Services PCS queues or as part of the login fleet. A compute node group includes the definition of the compute properties and lifecycle management. Amazon Web Services 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 Amazon Web Services PCS launches in your account. You must already have a launch template before you call this API. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html">Launch an instance from a launch template</a> in the <i>Amazon Elastic Compute Cloud User Guide for Linux Instances</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.SpotOptions_AllocationStrategy"> <summary> <para> <para>The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. Amazon Web Services PCS supports <b>lowest price</b>, <b>capacity optimized</b>, and <b>price capacity optimized</b>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html">Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. If you don't provide this option, it defaults to <b>price capacity optimized</b>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.AmiId"> <summary> <para> <para> The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.ClusterIdentifier"> <summary> <para> <para>The name or ID of the cluster to create a compute node group in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.ComputeNodeGroupName"> <summary> <para> <para>A name to identify the cluster. Example: <c>MyCluster</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.IamInstanceProfileArn"> <summary> <para> <para>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 <c>pcs:RegisterComputeNodeGroupInstance</c> permission. The resource identifier of the ARN must start with <c>AWSPCS</c> or it must have <c>/aws-pcs/</c> in its path.</para><para><b>Examples</b></para><ul><li><para><c>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</c></para></li><li><para><c>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.CustomLaunchTemplate_Id"> <summary> <para> <para>The ID of the EC2 launch template to use to provision instances.</para><para> Example: <c>lt-xxxx</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.InstanceConfig"> <summary> <para> <para>A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.ScalingConfiguration_MaxInstanceCount"> <summary> <para> <para>The upper bound of the number of instances allowed in the compute fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.ScalingConfiguration_MinInstanceCount"> <summary> <para> <para>The lower bound of the number of instances allowed in the compute fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.PurchaseOption"> <summary> <para> <para>Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html">Instance purchasing options</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. If you don't provide this option, it defaults to On-Demand.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.SlurmConfiguration_SlurmCustomSetting"> <summary> <para> <para>Additional Slurm-specific configuration that directly maps to Slurm settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.SubnetId"> <summary> <para> <para>The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.Tag"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.CustomLaunchTemplate_Version"> <summary> <para> <para>The version of the EC2 launch template to use to provision instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComputeNodeGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.CreateComputeNodeGroupResponse). Specifying the name of a property of type Amazon.PCS.Model.CreateComputeNodeGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSComputeNodeGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.NewPCSQueueCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSQueueCmdlet.ClusterIdentifier"> <summary> <para> <para>The name or ID of the cluster for which to create a queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSQueueCmdlet.ComputeNodeGroupConfiguration"> <summary> <para> <para>The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSQueueCmdlet.QueueName"> <summary> <para> <para>A name to identify the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSQueueCmdlet.Tag"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSQueueCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSQueueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Queue'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.CreateQueueResponse). Specifying the name of a property of type Amazon.PCS.Model.CreateQueueResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.NewPCSQueueCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.RegisterPCSComputeNodeGroupInstanceCmdlet"> <summary> <important><para> This API action isn't intended for you to use. </para></important><para> Amazon Web Services PCS uses this API action to register the compute nodes it launches in your account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RegisterPCSComputeNodeGroupInstanceCmdlet.BootstrapId"> <summary> <para> <para>The client-generated token to allow for retries.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RegisterPCSComputeNodeGroupInstanceCmdlet.ClusterIdentifier"> <summary> <para> <para>The name or ID of the cluster to register the compute node group instance in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RegisterPCSComputeNodeGroupInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.RegisterComputeNodeGroupInstanceResponse). Specifying the name of a property of type Amazon.PCS.Model.RegisterComputeNodeGroupInstanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RegisterPCSComputeNodeGroupInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.RemovePCSClusterCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSClusterCmdlet.ClusterIdentifier"> <summary> <para> <para>The name or ID of the cluster to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSClusterCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.DeleteClusterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSClusterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.RemovePCSComputeNodeGroupCmdlet"> <summary> Deletes a compute node group. You must delete all queues associated with the compute node group first. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSComputeNodeGroupCmdlet.ClusterIdentifier"> <summary> <para> <para>The name or ID of the cluster of the compute node group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSComputeNodeGroupCmdlet.ComputeNodeGroupIdentifier"> <summary> <para> <para>The name or ID of the compute node group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSComputeNodeGroupCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSComputeNodeGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.DeleteComputeNodeGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSComputeNodeGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.RemovePCSQueueCmdlet"> <summary> Deletes a job queue. If the compute node group associated with this queue isn't associated with any other queues, Amazon Web Services PCS terminates all the compute nodes for this queue. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSQueueCmdlet.ClusterIdentifier"> <summary> <para> <para>The name or ID of the cluster of the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSQueueCmdlet.QueueIdentifier"> <summary> <para> <para>The name or ID of the queue to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSQueueCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSQueueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.DeleteQueueResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSQueueCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.RemovePCSResourceTagCmdlet"> <summary> Deletes tags from an Amazon Web Services PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the Amazon Web Services PCS resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSResourceTagCmdlet.TagKey"> <summary> <para> <para>1 or more tag keys to remove from the resource. Specify only tag keys and not tag values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.RemovePCSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet"> <summary> 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). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.SpotOptions_AllocationStrategy"> <summary> <para> <para>The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. Amazon Web Services PCS supports <b>lowest price</b>, <b>capacity optimized</b>, and <b>price capacity optimized</b>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html">Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. If you don't provide this option, it defaults to <b>price capacity optimized</b>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.AmiId"> <summary> <para> <para>The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.ClusterIdentifier"> <summary> <para> <para>The name or ID of the cluster of the compute node group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.ComputeNodeGroupIdentifier"> <summary> <para> <para>The name or ID of the compute node group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.IamInstanceProfileArn"> <summary> <para> <para>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 <c>pcs:RegisterComputeNodeGroupInstance</c> permission. The resource identifier of the ARN must start with <c>AWSPCS</c> or it must have <c>/aws-pcs/</c> in its path.</para><para><b>Examples</b></para><ul><li><para><c>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</c></para></li><li><para><c>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.CustomLaunchTemplate_Id"> <summary> <para> <para>The ID of the EC2 launch template to use to provision instances.</para><para> Example: <c>lt-xxxx</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.ScalingConfiguration_MaxInstanceCount"> <summary> <para> <para>The upper bound of the number of instances allowed in the compute fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.ScalingConfiguration_MinInstanceCount"> <summary> <para> <para>The lower bound of the number of instances allowed in the compute fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.PurchaseOption"> <summary> <para> <para>Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html">Instance purchasing options</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. If you don't provide this option, it defaults to On-Demand.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.SlurmConfiguration_SlurmCustomSetting"> <summary> <para> <para>Additional Slurm-specific configuration that directly maps to Slurm settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.SubnetId"> <summary> <para> <para>The list of subnet IDs where the compute node group provisions instances. The subnets must be in the same VPC as the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.CustomLaunchTemplate_Version"> <summary> <para> <para>The version of the EC2 launch template to use to provision instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComputeNodeGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.UpdateComputeNodeGroupResponse). Specifying the name of a property of type Amazon.PCS.Model.UpdateComputeNodeGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSComputeNodeGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSQueueCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSQueueCmdlet.ClusterIdentifier"> <summary> <para> <para>The name or ID of the cluster of the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSQueueCmdlet.ComputeNodeGroupConfiguration"> <summary> <para> <para>The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSQueueCmdlet.QueueIdentifier"> <summary> <para> <para>The name or ID of the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSQueueCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSQueueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Queue'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PCS.Model.UpdateQueueResponse). Specifying the name of a property of type Amazon.PCS.Model.UpdateQueueResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PCS.UpdatePCSQueueCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |