Typed dictionaries

Index > IoTJobsDataPlane > Typed dictionaries

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

DescribeJobExecutionRequestRequestTypeDef

Usage Example

from mypy_boto3_iot_jobs_data.type_defs import DescribeJobExecutionRequestRequestTypeDef

def get_value() -> DescribeJobExecutionRequestRequestTypeDef:
    return {
        "jobId": ...,
        "thingName": ...,
    }

Definition

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

JobExecutionTypeDef

Usage Example

from mypy_boto3_iot_jobs_data.type_defs import JobExecutionTypeDef

def get_value() -> JobExecutionTypeDef:
    return {
        "jobId": ...,
    }

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

Usage Example

from mypy_boto3_iot_jobs_data.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

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

GetPendingJobExecutionsRequestRequestTypeDef

Usage Example

from mypy_boto3_iot_jobs_data.type_defs import GetPendingJobExecutionsRequestRequestTypeDef

def get_value() -> GetPendingJobExecutionsRequestRequestTypeDef:
    return {
        "thingName": ...,
    }

Definition

class GetPendingJobExecutionsRequestRequestTypeDef(TypedDict):
    thingName: str,

JobExecutionSummaryTypeDef

Usage Example

from mypy_boto3_iot_jobs_data.type_defs import JobExecutionSummaryTypeDef

def get_value() -> JobExecutionSummaryTypeDef:
    return {
        "jobId": ...,
    }

Definition

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

JobExecutionStateTypeDef

Usage Example

from mypy_boto3_iot_jobs_data.type_defs import JobExecutionStateTypeDef

def get_value() -> JobExecutionStateTypeDef:
    return {
        "status": ...,
    }

Definition

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

1. See JobExecutionStatusType

StartNextPendingJobExecutionRequestRequestTypeDef

Usage Example

from mypy_boto3_iot_jobs_data.type_defs import StartNextPendingJobExecutionRequestRequestTypeDef

def get_value() -> StartNextPendingJobExecutionRequestRequestTypeDef:
    return {
        "thingName": ...,
    }

Definition

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

UpdateJobExecutionRequestRequestTypeDef

Usage Example

from mypy_boto3_iot_jobs_data.type_defs import UpdateJobExecutionRequestRequestTypeDef

def get_value() -> UpdateJobExecutionRequestRequestTypeDef:
    return {
        "jobId": ...,
        "thingName": ...,
        "status": ...,
    }

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

Usage Example

from mypy_boto3_iot_jobs_data.type_defs import DescribeJobExecutionResponseTypeDef

def get_value() -> DescribeJobExecutionResponseTypeDef:
    return {
        "execution": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See JobExecutionTypeDef
2. See ResponseMetadataTypeDef

StartNextPendingJobExecutionResponseTypeDef

Usage Example

from mypy_boto3_iot_jobs_data.type_defs import StartNextPendingJobExecutionResponseTypeDef

def get_value() -> StartNextPendingJobExecutionResponseTypeDef:
    return {
        "execution": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See JobExecutionTypeDef
2. See ResponseMetadataTypeDef

GetPendingJobExecutionsResponseTypeDef

Usage Example

from mypy_boto3_iot_jobs_data.type_defs import GetPendingJobExecutionsResponseTypeDef

def get_value() -> GetPendingJobExecutionsResponseTypeDef:
    return {
        "inProgressJobs": ...,
        "queuedJobs": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iot_jobs_data.type_defs import UpdateJobExecutionResponseTypeDef

def get_value() -> UpdateJobExecutionResponseTypeDef:
    return {
        "executionState": ...,
        "jobDocument": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See JobExecutionStateTypeDef
2. See ResponseMetadataTypeDef