Skip to content

Type definitions#

Index > IoTJobsDataPlane > Type definitions

Auto-generated documentation for IoTJobsDataPlane type annotations stubs module mypy-boto3-iot-jobs-data.

DescribeJobExecutionRequestRequestTypeDef#

# DescribeJobExecutionRequestRequestTypeDef definition

class DescribeJobExecutionRequestRequestTypeDef(TypedDict):
    jobId: str,
    thingName: str,
    includeJobDocument: NotRequired[bool],
    executionNumber: NotRequired[int],

JobExecutionTypeDef#

# JobExecutionTypeDef definition

class JobExecutionTypeDef(TypedDict):
    jobId: NotRequired[str],
    thingName: NotRequired[str],
    status: NotRequired[JobExecutionStatusType],  # (1)
    statusDetails: NotRequired[Dict[str, str]],
    queuedAt: NotRequired[int],
    startedAt: NotRequired[int],
    lastUpdatedAt: NotRequired[int],
    approximateSecondsBeforeTimedOut: NotRequired[int],
    versionNumber: NotRequired[int],
    executionNumber: NotRequired[int],
    jobDocument: NotRequired[str],
  1. See JobExecutionStatusType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

GetPendingJobExecutionsRequestRequestTypeDef#

# GetPendingJobExecutionsRequestRequestTypeDef definition

class GetPendingJobExecutionsRequestRequestTypeDef(TypedDict):
    thingName: str,

JobExecutionSummaryTypeDef#

# JobExecutionSummaryTypeDef definition

class JobExecutionSummaryTypeDef(TypedDict):
    jobId: NotRequired[str],
    queuedAt: NotRequired[int],
    startedAt: NotRequired[int],
    lastUpdatedAt: NotRequired[int],
    versionNumber: NotRequired[int],
    executionNumber: NotRequired[int],

JobExecutionStateTypeDef#

# JobExecutionStateTypeDef definition

class JobExecutionStateTypeDef(TypedDict):
    status: NotRequired[JobExecutionStatusType],  # (1)
    statusDetails: NotRequired[Dict[str, str]],
    versionNumber: NotRequired[int],
  1. See JobExecutionStatusType

StartNextPendingJobExecutionRequestRequestTypeDef#

# StartNextPendingJobExecutionRequestRequestTypeDef definition

class StartNextPendingJobExecutionRequestRequestTypeDef(TypedDict):
    thingName: str,
    statusDetails: NotRequired[Mapping[str, str]],
    stepTimeoutInMinutes: NotRequired[int],

UpdateJobExecutionRequestRequestTypeDef#

# UpdateJobExecutionRequestRequestTypeDef definition

class UpdateJobExecutionRequestRequestTypeDef(TypedDict):
    jobId: str,
    thingName: str,
    status: JobExecutionStatusType,  # (1)
    statusDetails: NotRequired[Mapping[str, str]],
    stepTimeoutInMinutes: NotRequired[int],
    expectedVersion: NotRequired[int],
    includeJobExecutionState: NotRequired[bool],
    includeJobDocument: NotRequired[bool],
    executionNumber: NotRequired[int],
  1. See JobExecutionStatusType

DescribeJobExecutionResponseTypeDef#

# DescribeJobExecutionResponseTypeDef definition

class DescribeJobExecutionResponseTypeDef(TypedDict):
    execution: JobExecutionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobExecutionTypeDef
  2. See ResponseMetadataTypeDef

StartNextPendingJobExecutionResponseTypeDef#

# StartNextPendingJobExecutionResponseTypeDef definition

class StartNextPendingJobExecutionResponseTypeDef(TypedDict):
    execution: JobExecutionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobExecutionTypeDef
  2. See ResponseMetadataTypeDef

GetPendingJobExecutionsResponseTypeDef#

# GetPendingJobExecutionsResponseTypeDef definition

class GetPendingJobExecutionsResponseTypeDef(TypedDict):
    inProgressJobs: List[JobExecutionSummaryTypeDef],  # (1)
    queuedJobs: List[JobExecutionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See JobExecutionSummaryTypeDef
  2. See JobExecutionSummaryTypeDef
  3. See ResponseMetadataTypeDef

UpdateJobExecutionResponseTypeDef#

# UpdateJobExecutionResponseTypeDef definition

class UpdateJobExecutionResponseTypeDef(TypedDict):
    executionState: JobExecutionStateTypeDef,  # (1)
    jobDocument: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobExecutionStateTypeDef
  2. See ResponseMetadataTypeDef