Typed dictionaries
Index > IoTJobsDataPlane > Typed dictionaries
Auto-generated documentation for IoTJobsDataPlane type annotations stubs module types-aiobotocore-iot-jobs-data.
DescribeJobExecutionRequestRequestTypeDef
Usage Example
from types_aiobotocore_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 types_aiobotocore_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],
ResponseMetadataTypeDef
Usage Example
from types_aiobotocore_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 types_aiobotocore_iot_jobs_data.type_defs import GetPendingJobExecutionsRequestRequestTypeDef
def get_value() -> GetPendingJobExecutionsRequestRequestTypeDef:
return {
"thingName": ...,
}
JobExecutionSummaryTypeDef
Usage Example
from types_aiobotocore_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 types_aiobotocore_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],
StartNextPendingJobExecutionRequestRequestTypeDef
Usage Example
from types_aiobotocore_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 types_aiobotocore_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],
DescribeJobExecutionResponseTypeDef
Usage Example
from types_aiobotocore_iot_jobs_data.type_defs import DescribeJobExecutionResponseTypeDef
def get_value() -> DescribeJobExecutionResponseTypeDef:
return {
"execution": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeJobExecutionResponseTypeDef(TypedDict):
execution: JobExecutionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartNextPendingJobExecutionResponseTypeDef
Usage Example
from types_aiobotocore_iot_jobs_data.type_defs import StartNextPendingJobExecutionResponseTypeDef
def get_value() -> StartNextPendingJobExecutionResponseTypeDef:
return {
"execution": ...,
"ResponseMetadata": ...,
}
Definition
class StartNextPendingJobExecutionResponseTypeDef(TypedDict):
execution: JobExecutionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetPendingJobExecutionsResponseTypeDef
Usage Example
from types_aiobotocore_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)
UpdateJobExecutionResponseTypeDef
Usage Example
from types_aiobotocore_iot_jobs_data.type_defs import UpdateJobExecutionResponseTypeDef
def get_value() -> UpdateJobExecutionResponseTypeDef:
return {
"executionState": ...,
"jobDocument": ...,
"ResponseMetadata": ...,
}