ParallelComputingServiceClient

Index > ParallelComputingService > ParallelComputingServiceClient

Auto-generated documentation for ParallelComputingService type annotations stubs module mypy-boto3-pcs.

ParallelComputingServiceClient

Type annotations and code completion for boto3.client("pcs"). boto3 documentation

# ParallelComputingServiceClient usage example

from boto3.session import Session
from mypy_boto3_pcs.client import ParallelComputingServiceClient

def get_pcs_client() -> ParallelComputingServiceClient:
    return Session().client("pcs")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("pcs").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("pcs")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_pcs.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("pcs").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("pcs").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_cluster

Creates a cluster in your account.

Type annotations and code completion for boto3.client("pcs").create_cluster method. boto3 documentation

# create_cluster method definition

def create_cluster(
    self,
    *,
    clusterName: str,
    scheduler: SchedulerRequestTypeDef,  # (1)
    size: SizeType,  # (2)
    networking: NetworkingRequestTypeDef,  # (3)
    slurmConfiguration: ClusterSlurmConfigurationRequestTypeDef = ...,  # (4)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateClusterResponseTypeDef:  # (5)
    ...

1. See SchedulerRequestTypeDef
2. See SizeType
3. See NetworkingRequestTypeDef
4. See ClusterSlurmConfigurationRequestTypeDef
5. See CreateClusterResponseTypeDef

# create_cluster method usage example with argument unpacking

kwargs: CreateClusterRequestTypeDef = {  # (1)
    "clusterName": ...,
    "scheduler": ...,
    "size": ...,
    "networking": ...,
}

parent.create_cluster(**kwargs)

1. See CreateClusterRequestTypeDef

create_compute_node_group

Creates a managed set of compute nodes.

Type annotations and code completion for boto3.client("pcs").create_compute_node_group method. boto3 documentation

# create_compute_node_group method definition

def create_compute_node_group(
    self,
    *,
    clusterIdentifier: str,
    computeNodeGroupName: str,
    subnetIds: Sequence[str],
    customLaunchTemplate: CustomLaunchTemplateTypeDef,  # (1)
    iamInstanceProfileArn: str,
    scalingConfiguration: ScalingConfigurationRequestTypeDef,  # (2)
    instanceConfigs: Sequence[InstanceConfigTypeDef],  # (3)
    amiId: str = ...,
    purchaseOption: PurchaseOptionType = ...,  # (4)
    spotOptions: SpotOptionsTypeDef = ...,  # (5)
    slurmConfiguration: ComputeNodeGroupSlurmConfigurationRequestTypeDef = ...,  # (6)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateComputeNodeGroupResponseTypeDef:  # (7)
    ...

1. See CustomLaunchTemplateTypeDef
2. See ScalingConfigurationRequestTypeDef
3. See Sequence[InstanceConfigTypeDef]
4. See PurchaseOptionType
5. See SpotOptionsTypeDef
6. See ComputeNodeGroupSlurmConfigurationRequestTypeDef
7. See CreateComputeNodeGroupResponseTypeDef

# create_compute_node_group method usage example with argument unpacking

kwargs: CreateComputeNodeGroupRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
    "computeNodeGroupName": ...,
    "subnetIds": ...,
    "customLaunchTemplate": ...,
    "iamInstanceProfileArn": ...,
    "scalingConfiguration": ...,
    "instanceConfigs": ...,
}

parent.create_compute_node_group(**kwargs)

1. See CreateComputeNodeGroupRequestTypeDef

create_queue

Creates a job queue.

Type annotations and code completion for boto3.client("pcs").create_queue method. boto3 documentation

# create_queue method definition

def create_queue(
    self,
    *,
    clusterIdentifier: str,
    queueName: str,
    computeNodeGroupConfigurations: Sequence[ComputeNodeGroupConfigurationTypeDef] = ...,  # (1)
    slurmConfiguration: QueueSlurmConfigurationRequestTypeDef = ...,  # (2)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateQueueResponseTypeDef:  # (3)
    ...

1. See Sequence[ComputeNodeGroupConfigurationTypeDef]
2. See QueueSlurmConfigurationRequestTypeDef
3. See CreateQueueResponseTypeDef

# create_queue method usage example with argument unpacking

kwargs: CreateQueueRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
    "queueName": ...,
}

parent.create_queue(**kwargs)

1. See CreateQueueRequestTypeDef

delete_cluster

Deletes a cluster and all its linked resources.

Type annotations and code completion for boto3.client("pcs").delete_cluster method. boto3 documentation

# delete_cluster method definition

def delete_cluster(
    self,
    *,
    clusterIdentifier: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

# delete_cluster method usage example with argument unpacking

kwargs: DeleteClusterRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
}

parent.delete_cluster(**kwargs)

1. See DeleteClusterRequestTypeDef

delete_compute_node_group

Deletes a compute node group.

Type annotations and code completion for boto3.client("pcs").delete_compute_node_group method. boto3 documentation

# delete_compute_node_group method definition

def delete_compute_node_group(
    self,
    *,
    clusterIdentifier: str,
    computeNodeGroupIdentifier: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

# delete_compute_node_group method usage example with argument unpacking

kwargs: DeleteComputeNodeGroupRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
    "computeNodeGroupIdentifier": ...,
}

parent.delete_compute_node_group(**kwargs)

1. See DeleteComputeNodeGroupRequestTypeDef

delete_queue

Deletes a job queue.

Type annotations and code completion for boto3.client("pcs").delete_queue method. boto3 documentation

# delete_queue method definition

def delete_queue(
    self,
    *,
    clusterIdentifier: str,
    queueIdentifier: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

# delete_queue method usage example with argument unpacking

kwargs: DeleteQueueRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
    "queueIdentifier": ...,
}

parent.delete_queue(**kwargs)

1. See DeleteQueueRequestTypeDef

get_cluster

Returns detailed information about a running cluster in your account.

Type annotations and code completion for boto3.client("pcs").get_cluster method. boto3 documentation

# get_cluster method definition

def get_cluster(
    self,
    *,
    clusterIdentifier: str,
) -> GetClusterResponseTypeDef:  # (1)
    ...

1. See GetClusterResponseTypeDef

# get_cluster method usage example with argument unpacking

kwargs: GetClusterRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
}

parent.get_cluster(**kwargs)

1. See GetClusterRequestTypeDef

get_compute_node_group

Returns detailed information about a compute node group.

Type annotations and code completion for boto3.client("pcs").get_compute_node_group method. boto3 documentation

# get_compute_node_group method definition

def get_compute_node_group(
    self,
    *,
    clusterIdentifier: str,
    computeNodeGroupIdentifier: str,
) -> GetComputeNodeGroupResponseTypeDef:  # (1)
    ...

1. See GetComputeNodeGroupResponseTypeDef

# get_compute_node_group method usage example with argument unpacking

kwargs: GetComputeNodeGroupRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
    "computeNodeGroupIdentifier": ...,
}

parent.get_compute_node_group(**kwargs)

1. See GetComputeNodeGroupRequestTypeDef

get_queue

Returns detailed information about a queue.

Type annotations and code completion for boto3.client("pcs").get_queue method. boto3 documentation

# get_queue method definition

def get_queue(
    self,
    *,
    clusterIdentifier: str,
    queueIdentifier: str,
) -> GetQueueResponseTypeDef:  # (1)
    ...

1. See GetQueueResponseTypeDef

# get_queue method usage example with argument unpacking

kwargs: GetQueueRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
    "queueIdentifier": ...,
}

parent.get_queue(**kwargs)

1. See GetQueueRequestTypeDef

list_clusters

Returns a list of running clusters in your account.

Type annotations and code completion for boto3.client("pcs").list_clusters method. boto3 documentation

# list_clusters method definition

def list_clusters(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListClustersResponseTypeDef:  # (1)
    ...

1. See ListClustersResponseTypeDef

# list_clusters method usage example with argument unpacking

kwargs: ListClustersRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_clusters(**kwargs)

1. See ListClustersRequestTypeDef

list_compute_node_groups

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

Type annotations and code completion for boto3.client("pcs").list_compute_node_groups method. boto3 documentation

# list_compute_node_groups method definition

def list_compute_node_groups(
    self,
    *,
    clusterIdentifier: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListComputeNodeGroupsResponseTypeDef:  # (1)
    ...

1. See ListComputeNodeGroupsResponseTypeDef

# list_compute_node_groups method usage example with argument unpacking

kwargs: ListComputeNodeGroupsRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
}

parent.list_compute_node_groups(**kwargs)

1. See ListComputeNodeGroupsRequestTypeDef

list_queues

Returns a list of all queues associated with a cluster.

Type annotations and code completion for boto3.client("pcs").list_queues method. boto3 documentation

# list_queues method definition

def list_queues(
    self,
    *,
    clusterIdentifier: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListQueuesResponseTypeDef:  # (1)
    ...

1. See ListQueuesResponseTypeDef

# list_queues method usage example with argument unpacking

kwargs: ListQueuesRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
}

parent.list_queues(**kwargs)

1. See ListQueuesRequestTypeDef

list_tags_for_resource

Returns a list of all tags on an PCS resource.

Type annotations and code completion for boto3.client("pcs").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

register_compute_node_group_instance

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

Type annotations and code completion for boto3.client("pcs").register_compute_node_group_instance method. boto3 documentation

# register_compute_node_group_instance method definition

def register_compute_node_group_instance(
    self,
    *,
    clusterIdentifier: str,
    bootstrapId: str,
) -> RegisterComputeNodeGroupInstanceResponseTypeDef:  # (1)
    ...

1. See RegisterComputeNodeGroupInstanceResponseTypeDef

# register_compute_node_group_instance method usage example with argument unpacking

kwargs: RegisterComputeNodeGroupInstanceRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
    "bootstrapId": ...,
}

parent.register_compute_node_group_instance(**kwargs)

1. See RegisterComputeNodeGroupInstanceRequestTypeDef

tag_resource

Adds or edits tags on an PCS resource.

Type annotations and code completion for boto3.client("pcs").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Deletes tags from an PCS resource.

Type annotations and code completion for boto3.client("pcs").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_cluster

Updates a cluster configuration.

Type annotations and code completion for boto3.client("pcs").update_cluster method. boto3 documentation

# update_cluster method definition

def update_cluster(
    self,
    *,
    clusterIdentifier: str,
    clientToken: str = ...,
    slurmConfiguration: UpdateClusterSlurmConfigurationRequestTypeDef = ...,  # (1)
) -> UpdateClusterResponseTypeDef:  # (2)
    ...

1. See UpdateClusterSlurmConfigurationRequestTypeDef
2. See UpdateClusterResponseTypeDef

# update_cluster method usage example with argument unpacking

kwargs: UpdateClusterRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
}

parent.update_cluster(**kwargs)

1. See UpdateClusterRequestTypeDef

update_compute_node_group

Updates a compute node group.

Type annotations and code completion for boto3.client("pcs").update_compute_node_group method. boto3 documentation

# update_compute_node_group method definition

def update_compute_node_group(
    self,
    *,
    clusterIdentifier: str,
    computeNodeGroupIdentifier: str,
    amiId: str = ...,
    subnetIds: Sequence[str] = ...,
    customLaunchTemplate: CustomLaunchTemplateTypeDef = ...,  # (1)
    purchaseOption: PurchaseOptionType = ...,  # (2)
    spotOptions: SpotOptionsTypeDef = ...,  # (3)
    scalingConfiguration: ScalingConfigurationRequestTypeDef = ...,  # (4)
    iamInstanceProfileArn: str = ...,
    slurmConfiguration: UpdateComputeNodeGroupSlurmConfigurationRequestTypeDef = ...,  # (5)
    clientToken: str = ...,
) -> UpdateComputeNodeGroupResponseTypeDef:  # (6)
    ...

1. See CustomLaunchTemplateTypeDef
2. See PurchaseOptionType
3. See SpotOptionsTypeDef
4. See ScalingConfigurationRequestTypeDef
5. See UpdateComputeNodeGroupSlurmConfigurationRequestTypeDef
6. See UpdateComputeNodeGroupResponseTypeDef

# update_compute_node_group method usage example with argument unpacking

kwargs: UpdateComputeNodeGroupRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
    "computeNodeGroupIdentifier": ...,
}

parent.update_compute_node_group(**kwargs)

1. See UpdateComputeNodeGroupRequestTypeDef

update_queue

Updates the compute node group configuration of a queue.

Type annotations and code completion for boto3.client("pcs").update_queue method. boto3 documentation

# update_queue method definition

def update_queue(
    self,
    *,
    clusterIdentifier: str,
    queueIdentifier: str,
    computeNodeGroupConfigurations: Sequence[ComputeNodeGroupConfigurationTypeDef] = ...,  # (1)
    slurmConfiguration: UpdateQueueSlurmConfigurationRequestTypeDef = ...,  # (2)
    clientToken: str = ...,
) -> UpdateQueueResponseTypeDef:  # (3)
    ...

1. See Sequence[ComputeNodeGroupConfigurationTypeDef]
2. See UpdateQueueSlurmConfigurationRequestTypeDef
3. See UpdateQueueResponseTypeDef

# update_queue method usage example with argument unpacking

kwargs: UpdateQueueRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
    "queueIdentifier": ...,
}

parent.update_queue(**kwargs)

1. See UpdateQueueRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("pcs").get_paginator method with overloads.

• client.get_paginator("list_clusters") -> ListClustersPaginator
• client.get_paginator("list_compute_node_groups") -> ListComputeNodeGroupsPaginator
• client.get_paginator("list_queues") -> ListQueuesPaginator