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

Check if an operation can be paginated.

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

close

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

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: CreateClusterRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "scheduler": ...,
    "size": ...,
    "networking": ...,
}

parent.create_cluster(**kwargs)

1. See CreateClusterRequestRequestTypeDef

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 InstanceConfigTypeDef
4. See PurchaseOptionType
5. See SpotOptionsTypeDef
6. See ComputeNodeGroupSlurmConfigurationRequestTypeDef
7. See CreateComputeNodeGroupResponseTypeDef

# create_compute_node_group method usage example with argument unpacking

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

parent.create_compute_node_group(**kwargs)

1. See CreateComputeNodeGroupRequestRequestTypeDef

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)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateQueueResponseTypeDef:  # (2)
    ...

1. See ComputeNodeGroupConfigurationTypeDef
2. See CreateQueueResponseTypeDef

# create_queue method usage example with argument unpacking

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

parent.create_queue(**kwargs)

1. See CreateQueueRequestRequestTypeDef

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: DeleteClusterRequestRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
}

parent.delete_cluster(**kwargs)

1. See DeleteClusterRequestRequestTypeDef

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: DeleteComputeNodeGroupRequestRequestTypeDef = {  # (1)
    "clusterIdentifier": ...,
    "computeNodeGroupIdentifier": ...,
}

parent.delete_compute_node_group(**kwargs)