Skip to content

Type definitions#

Index > SnowDeviceManagement > Type definitions

Auto-generated documentation for SnowDeviceManagement type annotations stubs module mypy-boto3-snow-device-management.

CancelTaskInputRequestTypeDef#

# CancelTaskInputRequestTypeDef definition

class CancelTaskInputRequestTypeDef(TypedDict):
    taskId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CapacityTypeDef#

# CapacityTypeDef definition

class CapacityTypeDef(TypedDict):
    available: NotRequired[int],
    name: NotRequired[str],
    total: NotRequired[int],
    unit: NotRequired[str],
    used: NotRequired[int],

CommandTypeDef#

# CommandTypeDef definition

class CommandTypeDef(TypedDict):
    reboot: NotRequired[Mapping[str, Any]],
    unlock: NotRequired[Mapping[str, Any]],

CpuOptionsTypeDef#

# CpuOptionsTypeDef definition

class CpuOptionsTypeDef(TypedDict):
    coreCount: NotRequired[int],
    threadsPerCore: NotRequired[int],

DescribeDeviceEc2InputRequestTypeDef#

# DescribeDeviceEc2InputRequestTypeDef definition

class DescribeDeviceEc2InputRequestTypeDef(TypedDict):
    instanceIds: Sequence[str],
    managedDeviceId: str,

DescribeDeviceInputRequestTypeDef#

# DescribeDeviceInputRequestTypeDef definition

class DescribeDeviceInputRequestTypeDef(TypedDict):
    managedDeviceId: str,

PhysicalNetworkInterfaceTypeDef#

# PhysicalNetworkInterfaceTypeDef definition

class PhysicalNetworkInterfaceTypeDef(TypedDict):
    defaultGateway: NotRequired[str],
    ipAddress: NotRequired[str],
    ipAddressAssignment: NotRequired[IpAddressAssignmentType],  # (1)
    macAddress: NotRequired[str],
    netmask: NotRequired[str],
    physicalConnectorType: NotRequired[PhysicalConnectorTypeType],  # (2)
    physicalNetworkInterfaceId: NotRequired[str],
  1. See IpAddressAssignmentType
  2. See PhysicalConnectorTypeType

SoftwareInformationTypeDef#

# SoftwareInformationTypeDef definition

class SoftwareInformationTypeDef(TypedDict):
    installState: NotRequired[str],
    installedVersion: NotRequired[str],
    installingVersion: NotRequired[str],

DescribeExecutionInputRequestTypeDef#

# DescribeExecutionInputRequestTypeDef definition

class DescribeExecutionInputRequestTypeDef(TypedDict):
    managedDeviceId: str,
    taskId: str,

DescribeTaskInputRequestTypeDef#

# DescribeTaskInputRequestTypeDef definition

class DescribeTaskInputRequestTypeDef(TypedDict):
    taskId: str,

DeviceSummaryTypeDef#

# DeviceSummaryTypeDef definition

class DeviceSummaryTypeDef(TypedDict):
    associatedWithJob: NotRequired[str],
    managedDeviceArn: NotRequired[str],
    managedDeviceId: NotRequired[str],
    tags: NotRequired[Dict[str, str]],

EbsInstanceBlockDeviceTypeDef#

# EbsInstanceBlockDeviceTypeDef definition

class EbsInstanceBlockDeviceTypeDef(TypedDict):
    attachTime: NotRequired[datetime],
    deleteOnTermination: NotRequired[bool],
    status: NotRequired[AttachmentStatusType],  # (1)
    volumeId: NotRequired[str],
  1. See AttachmentStatusType

ExecutionSummaryTypeDef#

# ExecutionSummaryTypeDef definition

class ExecutionSummaryTypeDef(TypedDict):
    executionId: NotRequired[str],
    managedDeviceId: NotRequired[str],
    state: NotRequired[ExecutionStateType],  # (1)
    taskId: NotRequired[str],
  1. See ExecutionStateType

InstanceStateTypeDef#

# InstanceStateTypeDef definition

class InstanceStateTypeDef(TypedDict):
    code: NotRequired[int],
    name: NotRequired[InstanceStateNameType],  # (1)
  1. See InstanceStateNameType

SecurityGroupIdentifierTypeDef#

# SecurityGroupIdentifierTypeDef definition

class SecurityGroupIdentifierTypeDef(TypedDict):
    groupId: NotRequired[str],
    groupName: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListDeviceResourcesInputRequestTypeDef#

# ListDeviceResourcesInputRequestTypeDef definition

class ListDeviceResourcesInputRequestTypeDef(TypedDict):
    managedDeviceId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    type: NotRequired[str],

ResourceSummaryTypeDef#

# ResourceSummaryTypeDef definition

class ResourceSummaryTypeDef(TypedDict):
    resourceType: str,
    arn: NotRequired[str],
    id: NotRequired[str],

ListDevicesInputRequestTypeDef#

# ListDevicesInputRequestTypeDef definition

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

ListExecutionsInputRequestTypeDef#

# ListExecutionsInputRequestTypeDef definition

class ListExecutionsInputRequestTypeDef(TypedDict):
    taskId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    state: NotRequired[ExecutionStateType],  # (1)
  1. See ExecutionStateType

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,

ListTasksInputRequestTypeDef#

# ListTasksInputRequestTypeDef definition

class ListTasksInputRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    state: NotRequired[TaskStateType],  # (1)
  1. See TaskStateType

TaskSummaryTypeDef#

# TaskSummaryTypeDef definition

class TaskSummaryTypeDef(TypedDict):
    taskId: str,
    state: NotRequired[TaskStateType],  # (1)
    tags: NotRequired[Dict[str, str]],
    taskArn: NotRequired[str],
  1. See TaskStateType

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

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

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

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

CancelTaskOutputTypeDef#

# CancelTaskOutputTypeDef definition

class CancelTaskOutputTypeDef(TypedDict):
    taskId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTaskOutputTypeDef#

# CreateTaskOutputTypeDef definition

class CreateTaskOutputTypeDef(TypedDict):
    taskArn: str,
    taskId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeExecutionOutputTypeDef#

# DescribeExecutionOutputTypeDef definition

class DescribeExecutionOutputTypeDef(TypedDict):
    executionId: str,
    lastUpdatedAt: datetime,
    managedDeviceId: str,
    startedAt: datetime,
    state: ExecutionStateType,  # (1)
    taskId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExecutionStateType
  2. See ResponseMetadataTypeDef

DescribeTaskOutputTypeDef#

# DescribeTaskOutputTypeDef definition

class DescribeTaskOutputTypeDef(TypedDict):
    completedAt: datetime,
    createdAt: datetime,
    description: str,
    lastUpdatedAt: datetime,
    state: TaskStateType,  # (1)
    tags: Dict[str, str],
    targets: List[str],
    taskArn: str,
    taskId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TaskStateType
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

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

CreateTaskInputRequestTypeDef#

# CreateTaskInputRequestTypeDef definition

class CreateTaskInputRequestTypeDef(TypedDict):
    command: CommandTypeDef,  # (1)
    targets: Sequence[str],
    clientToken: NotRequired[str],
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See CommandTypeDef

DescribeDeviceOutputTypeDef#

# DescribeDeviceOutputTypeDef definition

class DescribeDeviceOutputTypeDef(TypedDict):
    associatedWithJob: str,
    deviceCapacities: List[CapacityTypeDef],  # (1)
    deviceState: UnlockStateType,  # (2)
    deviceType: str,
    lastReachedOutAt: datetime,
    lastUpdatedAt: datetime,
    managedDeviceArn: str,
    managedDeviceId: str,
    physicalNetworkInterfaces: List[PhysicalNetworkInterfaceTypeDef],  # (3)
    software: SoftwareInformationTypeDef,  # (4)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See CapacityTypeDef
  2. See UnlockStateType
  3. See PhysicalNetworkInterfaceTypeDef
  4. See SoftwareInformationTypeDef
  5. See ResponseMetadataTypeDef

ListDevicesOutputTypeDef#

# ListDevicesOutputTypeDef definition

class ListDevicesOutputTypeDef(TypedDict):
    devices: List[DeviceSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceSummaryTypeDef
  2. See ResponseMetadataTypeDef

InstanceBlockDeviceMappingTypeDef#

# InstanceBlockDeviceMappingTypeDef definition

class InstanceBlockDeviceMappingTypeDef(TypedDict):
    deviceName: NotRequired[str],
    ebs: NotRequired[EbsInstanceBlockDeviceTypeDef],  # (1)
  1. See EbsInstanceBlockDeviceTypeDef

ListExecutionsOutputTypeDef#

# ListExecutionsOutputTypeDef definition

class ListExecutionsOutputTypeDef(TypedDict):
    executions: List[ExecutionSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExecutionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListDeviceResourcesInputListDeviceResourcesPaginateTypeDef#

# ListDeviceResourcesInputListDeviceResourcesPaginateTypeDef definition

class ListDeviceResourcesInputListDeviceResourcesPaginateTypeDef(TypedDict):
    managedDeviceId: str,
    type: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDevicesInputListDevicesPaginateTypeDef#

# ListDevicesInputListDevicesPaginateTypeDef definition

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

ListExecutionsInputListExecutionsPaginateTypeDef#

# ListExecutionsInputListExecutionsPaginateTypeDef definition

class ListExecutionsInputListExecutionsPaginateTypeDef(TypedDict):
    taskId: str,
    state: NotRequired[ExecutionStateType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ExecutionStateType
  2. See PaginatorConfigTypeDef

ListTasksInputListTasksPaginateTypeDef#

# ListTasksInputListTasksPaginateTypeDef definition

class ListTasksInputListTasksPaginateTypeDef(TypedDict):
    state: NotRequired[TaskStateType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See TaskStateType
  2. See PaginatorConfigTypeDef

ListDeviceResourcesOutputTypeDef#

# ListDeviceResourcesOutputTypeDef definition

class ListDeviceResourcesOutputTypeDef(TypedDict):
    nextToken: str,
    resources: List[ResourceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourceSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTasksOutputTypeDef#

# ListTasksOutputTypeDef definition

class ListTasksOutputTypeDef(TypedDict):
    nextToken: str,
    tasks: List[TaskSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TaskSummaryTypeDef
  2. See ResponseMetadataTypeDef

InstanceTypeDef#

# InstanceTypeDef definition

class InstanceTypeDef(TypedDict):
    amiLaunchIndex: NotRequired[int],
    blockDeviceMappings: NotRequired[List[InstanceBlockDeviceMappingTypeDef]],  # (1)
    cpuOptions: NotRequired[CpuOptionsTypeDef],  # (2)
    createdAt: NotRequired[datetime],
    imageId: NotRequired[str],
    instanceId: NotRequired[str],
    instanceType: NotRequired[str],
    privateIpAddress: NotRequired[str],
    publicIpAddress: NotRequired[str],
    rootDeviceName: NotRequired[str],
    securityGroups: NotRequired[List[SecurityGroupIdentifierTypeDef]],  # (3)
    state: NotRequired[InstanceStateTypeDef],  # (4)
    updatedAt: NotRequired[datetime],
  1. See InstanceBlockDeviceMappingTypeDef
  2. See CpuOptionsTypeDef
  3. See SecurityGroupIdentifierTypeDef
  4. See InstanceStateTypeDef

InstanceSummaryTypeDef#

# InstanceSummaryTypeDef definition

class InstanceSummaryTypeDef(TypedDict):
    instance: NotRequired[InstanceTypeDef],  # (1)
    lastUpdatedAt: NotRequired[datetime],
  1. See InstanceTypeDef

DescribeDeviceEc2OutputTypeDef#

# DescribeDeviceEc2OutputTypeDef definition

class DescribeDeviceEc2OutputTypeDef(TypedDict):
    instances: List[InstanceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InstanceSummaryTypeDef
  2. See ResponseMetadataTypeDef