Skip to content

Type definitions#

Index > ParallelComputingService > Type definitions

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

SlurmCustomSettingTypeDef#

# SlurmCustomSettingTypeDef definition

class SlurmCustomSettingTypeDef(TypedDict):
    parameterName: str,
    parameterValue: str,

SlurmAuthKeyTypeDef#

# SlurmAuthKeyTypeDef definition

class SlurmAuthKeyTypeDef(TypedDict):
    secretArn: str,
    secretVersion: str,

ClusterSummaryTypeDef#

# ClusterSummaryTypeDef definition

class ClusterSummaryTypeDef(TypedDict):
    name: str,
    id: str,
    arn: str,
    createdAt: datetime,
    modifiedAt: datetime,
    status: ClusterStatusType,  # (1)
  1. See ClusterStatusType

EndpointTypeDef#

# EndpointTypeDef definition

class EndpointTypeDef(TypedDict):
    type: EndpointTypeType,  # (1)
    privateIpAddress: str,
    port: str,
    publicIpAddress: NotRequired[str],
  1. See EndpointTypeType

ErrorInfoTypeDef#

# ErrorInfoTypeDef definition

class ErrorInfoTypeDef(TypedDict):
    code: NotRequired[str],
    message: NotRequired[str],

NetworkingTypeDef#

# NetworkingTypeDef definition

class NetworkingTypeDef(TypedDict):
    subnetIds: NotRequired[list[str]],
    securityGroupIds: NotRequired[list[str]],

SchedulerTypeDef#

# SchedulerTypeDef definition

class SchedulerTypeDef(TypedDict):
    type: SchedulerTypeType,  # (1)
    version: str,
  1. See SchedulerTypeType

ComputeNodeGroupConfigurationTypeDef#

# ComputeNodeGroupConfigurationTypeDef definition

class ComputeNodeGroupConfigurationTypeDef(TypedDict):
    computeNodeGroupId: NotRequired[str],

ComputeNodeGroupSummaryTypeDef#

# ComputeNodeGroupSummaryTypeDef definition

class ComputeNodeGroupSummaryTypeDef(TypedDict):
    name: str,
    id: str,
    arn: str,
    clusterId: str,
    createdAt: datetime,
    modifiedAt: datetime,
    status: ComputeNodeGroupStatusType,  # (1)
  1. See ComputeNodeGroupStatusType

CustomLaunchTemplateTypeDef#

# CustomLaunchTemplateTypeDef definition

class CustomLaunchTemplateTypeDef(TypedDict):
    id: str,
    version: str,

InstanceConfigTypeDef#

# InstanceConfigTypeDef definition

class InstanceConfigTypeDef(TypedDict):
    instanceType: NotRequired[str],

ScalingConfigurationTypeDef#

# ScalingConfigurationTypeDef definition

class ScalingConfigurationTypeDef(TypedDict):
    minInstanceCount: int,
    maxInstanceCount: int,

SpotOptionsTypeDef#

# SpotOptionsTypeDef definition

class SpotOptionsTypeDef(TypedDict):
    allocationStrategy: NotRequired[SpotAllocationStrategyType],  # (1)
  1. See SpotAllocationStrategyType

NetworkingRequestTypeDef#

# NetworkingRequestTypeDef definition

class NetworkingRequestTypeDef(TypedDict):
    subnetIds: NotRequired[Sequence[str]],
    securityGroupIds: NotRequired[Sequence[str]],

SchedulerRequestTypeDef#

# SchedulerRequestTypeDef definition

class SchedulerRequestTypeDef(TypedDict):
    type: SchedulerTypeType,  # (1)
    version: str,
  1. See SchedulerTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

ScalingConfigurationRequestTypeDef#

# ScalingConfigurationRequestTypeDef definition

class ScalingConfigurationRequestTypeDef(TypedDict):
    minInstanceCount: int,
    maxInstanceCount: int,

DeleteClusterRequestRequestTypeDef#

# DeleteClusterRequestRequestTypeDef definition

class DeleteClusterRequestRequestTypeDef(TypedDict):
    clusterIdentifier: str,
    clientToken: NotRequired[str],

DeleteComputeNodeGroupRequestRequestTypeDef#

# DeleteComputeNodeGroupRequestRequestTypeDef definition

class DeleteComputeNodeGroupRequestRequestTypeDef(TypedDict):
    clusterIdentifier: str,
    computeNodeGroupIdentifier: str,
    clientToken: NotRequired[str],

DeleteQueueRequestRequestTypeDef#

# DeleteQueueRequestRequestTypeDef definition

class DeleteQueueRequestRequestTypeDef(TypedDict):
    clusterIdentifier: str,
    queueIdentifier: str,
    clientToken: NotRequired[str],

GetClusterRequestRequestTypeDef#

# GetClusterRequestRequestTypeDef definition

class GetClusterRequestRequestTypeDef(TypedDict):
    clusterIdentifier: str,

GetComputeNodeGroupRequestRequestTypeDef#

# GetComputeNodeGroupRequestRequestTypeDef definition

class GetComputeNodeGroupRequestRequestTypeDef(TypedDict):
    clusterIdentifier: str,
    computeNodeGroupIdentifier: str,

GetQueueRequestRequestTypeDef#

# GetQueueRequestRequestTypeDef definition

class GetQueueRequestRequestTypeDef(TypedDict):
    clusterIdentifier: str,
    queueIdentifier: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListClustersRequestRequestTypeDef#

# ListClustersRequestRequestTypeDef definition

class ListClustersRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListComputeNodeGroupsRequestRequestTypeDef#

# ListComputeNodeGroupsRequestRequestTypeDef definition

class ListComputeNodeGroupsRequestRequestTypeDef(TypedDict):
    clusterIdentifier: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListQueuesRequestRequestTypeDef#

# ListQueuesRequestRequestTypeDef definition

class ListQueuesRequestRequestTypeDef(TypedDict):
    clusterIdentifier: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

QueueSummaryTypeDef#

# QueueSummaryTypeDef definition

class QueueSummaryTypeDef(TypedDict):
    name: str,
    id: str,
    arn: str,
    clusterId: str,
    createdAt: datetime,
    modifiedAt: datetime,
    status: QueueStatusType,  # (1)
  1. See QueueStatusType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

RegisterComputeNodeGroupInstanceRequestRequestTypeDef#

# RegisterComputeNodeGroupInstanceRequestRequestTypeDef definition

class RegisterComputeNodeGroupInstanceRequestRequestTypeDef(TypedDict):
    clusterIdentifier: str,
    bootstrapId: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

ClusterSlurmConfigurationRequestTypeDef#

# ClusterSlurmConfigurationRequestTypeDef definition

class ClusterSlurmConfigurationRequestTypeDef(TypedDict):
    scaleDownIdleTimeInSeconds: NotRequired[int],
    slurmCustomSettings: NotRequired[Sequence[SlurmCustomSettingTypeDef]],  # (1)
  1. See SlurmCustomSettingTypeDef

ComputeNodeGroupSlurmConfigurationRequestTypeDef#

# ComputeNodeGroupSlurmConfigurationRequestTypeDef definition

class ComputeNodeGroupSlurmConfigurationRequestTypeDef(TypedDict):
    slurmCustomSettings: NotRequired[Sequence[SlurmCustomSettingTypeDef]],  # (1)
  1. See SlurmCustomSettingTypeDef

ComputeNodeGroupSlurmConfigurationTypeDef#

# ComputeNodeGroupSlurmConfigurationTypeDef definition

class ComputeNodeGroupSlurmConfigurationTypeDef(TypedDict):
    slurmCustomSettings: NotRequired[list[SlurmCustomSettingTypeDef]],  # (1)
  1. See SlurmCustomSettingTypeDef

UpdateComputeNodeGroupSlurmConfigurationRequestTypeDef#

# UpdateComputeNodeGroupSlurmConfigurationRequestTypeDef definition

class UpdateComputeNodeGroupSlurmConfigurationRequestTypeDef(TypedDict):
    slurmCustomSettings: NotRequired[Sequence[SlurmCustomSettingTypeDef]],  # (1)
  1. See SlurmCustomSettingTypeDef

ClusterSlurmConfigurationTypeDef#

# ClusterSlurmConfigurationTypeDef definition

class ClusterSlurmConfigurationTypeDef(TypedDict):
    scaleDownIdleTimeInSeconds: NotRequired[int],
    slurmCustomSettings: NotRequired[list[SlurmCustomSettingTypeDef]],  # (1)
    authKey: NotRequired[SlurmAuthKeyTypeDef],  # (2)
  1. See SlurmCustomSettingTypeDef
  2. See SlurmAuthKeyTypeDef

CreateQueueRequestRequestTypeDef#

# CreateQueueRequestRequestTypeDef definition

class CreateQueueRequestRequestTypeDef(TypedDict):
    clusterIdentifier: str,
    queueName: str,
    computeNodeGroupConfigurations: NotRequired[Sequence[ComputeNodeGroupConfigurationTypeDef]],  # (1)
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See ComputeNodeGroupConfigurationTypeDef

QueueTypeDef#

# QueueTypeDef definition

class QueueTypeDef(TypedDict):
    name: str,
    id: str,
    arn: str,
    clusterId: str,
    createdAt: datetime,
    modifiedAt: datetime,
    status: QueueStatusType,  # (1)
    computeNodeGroupConfigurations: list[ComputeNodeGroupConfigurationTypeDef],  # (2)
    errorInfo: NotRequired[list[ErrorInfoTypeDef]],  # (3)
  1. See QueueStatusType
  2. See ComputeNodeGroupConfigurationTypeDef
  3. See ErrorInfoTypeDef

UpdateQueueRequestRequestTypeDef#

# UpdateQueueRequestRequestTypeDef definition

class UpdateQueueRequestRequestTypeDef(TypedDict):
    clusterIdentifier: str,
    queueIdentifier: str,
    computeNodeGroupConfigurations: NotRequired[Sequence[ComputeNodeGroupConfigurationTypeDef]],  # (1)
    clientToken: NotRequired[str],
  1. See ComputeNodeGroupConfigurationTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListClustersResponseTypeDef#

# ListClustersResponseTypeDef definition

class ListClustersResponseTypeDef(TypedDict):
    clusters: list[ClusterSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ClusterSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListComputeNodeGroupsResponseTypeDef#

# ListComputeNodeGroupsResponseTypeDef definition

class ListComputeNodeGroupsResponseTypeDef(TypedDict):
    computeNodeGroups: list[ComputeNodeGroupSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ComputeNodeGroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RegisterComputeNodeGroupInstanceResponseTypeDef#

# RegisterComputeNodeGroupInstanceResponseTypeDef definition

class RegisterComputeNodeGroupInstanceResponseTypeDef(TypedDict):
    nodeID: str,
    sharedSecret: str,
    endpoints: list[EndpointTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EndpointTypeDef
  2. See ResponseMetadataTypeDef

ListClustersRequestPaginateTypeDef#

# ListClustersRequestPaginateTypeDef definition

class ListClustersRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListComputeNodeGroupsRequestPaginateTypeDef#

# ListComputeNodeGroupsRequestPaginateTypeDef definition

class ListComputeNodeGroupsRequestPaginateTypeDef(TypedDict):
    clusterIdentifier: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQueuesRequestPaginateTypeDef#

# ListQueuesRequestPaginateTypeDef definition

class ListQueuesRequestPaginateTypeDef(TypedDict):
    clusterIdentifier: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQueuesResponseTypeDef#

# ListQueuesResponseTypeDef definition

class ListQueuesResponseTypeDef(TypedDict):
    queues: list[QueueSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See QueueSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateClusterRequestRequestTypeDef#

# CreateClusterRequestRequestTypeDef definition

class CreateClusterRequestRequestTypeDef(TypedDict):
    clusterName: str,
    scheduler: SchedulerRequestTypeDef,  # (1)
    size: SizeType,  # (2)
    networking: NetworkingRequestTypeDef,  # (3)
    slurmConfiguration: NotRequired[ClusterSlurmConfigurationRequestTypeDef],  # (4)
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See SchedulerRequestTypeDef
  2. See SizeType
  3. See NetworkingRequestTypeDef
  4. See ClusterSlurmConfigurationRequestTypeDef

CreateComputeNodeGroupRequestRequestTypeDef#

# CreateComputeNodeGroupRequestRequestTypeDef definition

class CreateComputeNodeGroupRequestRequestTypeDef(TypedDict):
    clusterIdentifier: str,
    computeNodeGroupName: str,
    subnetIds: Sequence[str],
    customLaunchTemplate: CustomLaunchTemplateTypeDef,  # (1)
    iamInstanceProfileArn: str,
    scalingConfiguration: ScalingConfigurationRequestTypeDef,  # (2)
    instanceConfigs: Sequence[InstanceConfigTypeDef],  # (3)
    amiId: NotRequired[str],
    purchaseOption: NotRequired[PurchaseOptionType],  # (4)
    spotOptions: NotRequired[SpotOptionsTypeDef],  # (5)
    slurmConfiguration: NotRequired[ComputeNodeGroupSlurmConfigurationRequestTypeDef],  # (6)
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See CustomLaunchTemplateTypeDef
  2. See ScalingConfigurationRequestTypeDef
  3. See InstanceConfigTypeDef
  4. See PurchaseOptionType
  5. See SpotOptionsTypeDef
  6. See ComputeNodeGroupSlurmConfigurationRequestTypeDef

ComputeNodeGroupTypeDef#

# ComputeNodeGroupTypeDef definition

class ComputeNodeGroupTypeDef(TypedDict):
    name: str,
    id: str,
    arn: str,
    clusterId: str,
    createdAt: datetime,
    modifiedAt: datetime,
    status: ComputeNodeGroupStatusType,  # (1)
    subnetIds: list[str],
    customLaunchTemplate: CustomLaunchTemplateTypeDef,  # (3)
    iamInstanceProfileArn: str,
    scalingConfiguration: ScalingConfigurationTypeDef,  # (4)
    instanceConfigs: list[InstanceConfigTypeDef],  # (5)
    amiId: NotRequired[str],
    purchaseOption: NotRequired[PurchaseOptionType],  # (2)
    spotOptions: NotRequired[SpotOptionsTypeDef],  # (6)
    slurmConfiguration: NotRequired[ComputeNodeGroupSlurmConfigurationTypeDef],  # (7)
    errorInfo: NotRequired[list[ErrorInfoTypeDef]],  # (8)
  1. See ComputeNodeGroupStatusType
  2. See PurchaseOptionType
  3. See CustomLaunchTemplateTypeDef
  4. See ScalingConfigurationTypeDef
  5. See InstanceConfigTypeDef
  6. See SpotOptionsTypeDef
  7. See ComputeNodeGroupSlurmConfigurationTypeDef
  8. See ErrorInfoTypeDef

UpdateComputeNodeGroupRequestRequestTypeDef#

# UpdateComputeNodeGroupRequestRequestTypeDef definition

class UpdateComputeNodeGroupRequestRequestTypeDef(TypedDict):
    clusterIdentifier: str,
    computeNodeGroupIdentifier: str,
    amiId: NotRequired[str],
    subnetIds: NotRequired[Sequence[str]],
    customLaunchTemplate: NotRequired[CustomLaunchTemplateTypeDef],  # (1)
    purchaseOption: NotRequired[PurchaseOptionType],  # (2)
    spotOptions: NotRequired[SpotOptionsTypeDef],  # (3)
    scalingConfiguration: NotRequired[ScalingConfigurationRequestTypeDef],  # (4)
    iamInstanceProfileArn: NotRequired[str],
    slurmConfiguration: NotRequired[UpdateComputeNodeGroupSlurmConfigurationRequestTypeDef],  # (5)
    clientToken: NotRequired[str],
  1. See CustomLaunchTemplateTypeDef
  2. See PurchaseOptionType
  3. See SpotOptionsTypeDef
  4. See ScalingConfigurationRequestTypeDef
  5. See UpdateComputeNodeGroupSlurmConfigurationRequestTypeDef

ClusterTypeDef#

# ClusterTypeDef definition

class ClusterTypeDef(TypedDict):
    name: str,
    id: str,
    arn: str,
    status: ClusterStatusType,  # (1)
    createdAt: datetime,
    modifiedAt: datetime,
    scheduler: SchedulerTypeDef,  # (2)
    size: SizeType,  # (3)
    networking: NetworkingTypeDef,  # (5)
    slurmConfiguration: NotRequired[ClusterSlurmConfigurationTypeDef],  # (4)
    endpoints: NotRequired[list[EndpointTypeDef]],  # (6)
    errorInfo: NotRequired[list[ErrorInfoTypeDef]],  # (7)
  1. See ClusterStatusType
  2. See SchedulerTypeDef
  3. See SizeType
  4. See ClusterSlurmConfigurationTypeDef
  5. See NetworkingTypeDef
  6. See EndpointTypeDef
  7. See ErrorInfoTypeDef

CreateQueueResponseTypeDef#

# CreateQueueResponseTypeDef definition

class CreateQueueResponseTypeDef(TypedDict):
    queue: QueueTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueueTypeDef
  2. See ResponseMetadataTypeDef

GetQueueResponseTypeDef#

# GetQueueResponseTypeDef definition

class GetQueueResponseTypeDef(TypedDict):
    queue: QueueTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueueTypeDef
  2. See ResponseMetadataTypeDef

UpdateQueueResponseTypeDef#

# UpdateQueueResponseTypeDef definition

class UpdateQueueResponseTypeDef(TypedDict):
    queue: QueueTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueueTypeDef
  2. See ResponseMetadataTypeDef

CreateComputeNodeGroupResponseTypeDef#

# CreateComputeNodeGroupResponseTypeDef definition

class CreateComputeNodeGroupResponseTypeDef(TypedDict):
    computeNodeGroup: ComputeNodeGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ComputeNodeGroupTypeDef
  2. See ResponseMetadataTypeDef

GetComputeNodeGroupResponseTypeDef#

# GetComputeNodeGroupResponseTypeDef definition

class GetComputeNodeGroupResponseTypeDef(TypedDict):
    computeNodeGroup: ComputeNodeGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ComputeNodeGroupTypeDef
  2. See ResponseMetadataTypeDef

UpdateComputeNodeGroupResponseTypeDef#

# UpdateComputeNodeGroupResponseTypeDef definition

class UpdateComputeNodeGroupResponseTypeDef(TypedDict):
    computeNodeGroup: ComputeNodeGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ComputeNodeGroupTypeDef
  2. See ResponseMetadataTypeDef

CreateClusterResponseTypeDef#

# CreateClusterResponseTypeDef definition

class CreateClusterResponseTypeDef(TypedDict):
    cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

GetClusterResponseTypeDef#

# GetClusterResponseTypeDef definition

class GetClusterResponseTypeDef(TypedDict):
    cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef