Type definitions#
Index > IoTJobsDataPlane > Type definitions
Auto-generated documentation for IoTJobsDataPlane type annotations stubs module mypy-boto3-iot-jobs-data.
BlobTypeDef#
# BlobTypeDef Union usage example
from mypy_boto3_iot_jobs_data.type_defs import BlobTypeDef
def get_value() -> BlobTypeDef:
return ...
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
botocore.response.StreamingBody,
]
DescribeJobExecutionRequestTypeDef#
# DescribeJobExecutionRequestTypeDef TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import DescribeJobExecutionRequestTypeDef
def get_value() -> DescribeJobExecutionRequestTypeDef:
return {
"jobId": ...,
}
# DescribeJobExecutionRequestTypeDef definition
class DescribeJobExecutionRequestTypeDef(TypedDict):
jobId: str,
thingName: str,
includeJobDocument: NotRequired[bool],
executionNumber: NotRequired[int],
JobExecutionTypeDef#
# JobExecutionTypeDef TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import JobExecutionTypeDef
def get_value() -> JobExecutionTypeDef:
return {
"jobId": ...,
}
# 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],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
GetPendingJobExecutionsRequestTypeDef#
# GetPendingJobExecutionsRequestTypeDef TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import GetPendingJobExecutionsRequestTypeDef
def get_value() -> GetPendingJobExecutionsRequestTypeDef:
return {
"thingName": ...,
}
# GetPendingJobExecutionsRequestTypeDef definition
class GetPendingJobExecutionsRequestTypeDef(TypedDict):
thingName: str,
JobExecutionSummaryTypeDef#
# JobExecutionSummaryTypeDef TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import JobExecutionSummaryTypeDef
def get_value() -> JobExecutionSummaryTypeDef:
return {
"jobId": ...,
}
# 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 TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import JobExecutionStateTypeDef
def get_value() -> JobExecutionStateTypeDef:
return {
"status": ...,
}
# JobExecutionStateTypeDef definition
class JobExecutionStateTypeDef(TypedDict):
status: NotRequired[JobExecutionStatusType], # (1)
statusDetails: NotRequired[Dict[str, str]],
versionNumber: NotRequired[int],
StartNextPendingJobExecutionRequestTypeDef#
# StartNextPendingJobExecutionRequestTypeDef TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import StartNextPendingJobExecutionRequestTypeDef
def get_value() -> StartNextPendingJobExecutionRequestTypeDef:
return {
"thingName": ...,
}
# StartNextPendingJobExecutionRequestTypeDef definition
class StartNextPendingJobExecutionRequestTypeDef(TypedDict):
thingName: str,
statusDetails: NotRequired[Mapping[str, str]],
stepTimeoutInMinutes: NotRequired[int],
UpdateJobExecutionRequestTypeDef#
# UpdateJobExecutionRequestTypeDef TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import UpdateJobExecutionRequestTypeDef
def get_value() -> UpdateJobExecutionRequestTypeDef:
return {
"jobId": ...,
}
# UpdateJobExecutionRequestTypeDef definition
class UpdateJobExecutionRequestTypeDef(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],
CommandParameterValueTypeDef#
# CommandParameterValueTypeDef TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import CommandParameterValueTypeDef
def get_value() -> CommandParameterValueTypeDef:
return {
"S": ...,
}
# CommandParameterValueTypeDef definition
class CommandParameterValueTypeDef(TypedDict):
S: NotRequired[str],
B: NotRequired[bool],
I: NotRequired[int],
L: NotRequired[int],
D: NotRequired[float],
BIN: NotRequired[BlobTypeDef],
UL: NotRequired[str],
DescribeJobExecutionResponseTypeDef#
# DescribeJobExecutionResponseTypeDef TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import DescribeJobExecutionResponseTypeDef
def get_value() -> DescribeJobExecutionResponseTypeDef:
return {
"execution": ...,
}
# DescribeJobExecutionResponseTypeDef definition
class DescribeJobExecutionResponseTypeDef(TypedDict):
execution: JobExecutionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartCommandExecutionResponseTypeDef#
# StartCommandExecutionResponseTypeDef TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import StartCommandExecutionResponseTypeDef
def get_value() -> StartCommandExecutionResponseTypeDef:
return {
"executionId": ...,
}
# StartCommandExecutionResponseTypeDef definition
class StartCommandExecutionResponseTypeDef(TypedDict):
executionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartNextPendingJobExecutionResponseTypeDef#
# StartNextPendingJobExecutionResponseTypeDef TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import StartNextPendingJobExecutionResponseTypeDef
def get_value() -> StartNextPendingJobExecutionResponseTypeDef:
return {
"execution": ...,
}
# StartNextPendingJobExecutionResponseTypeDef definition
class StartNextPendingJobExecutionResponseTypeDef(TypedDict):
execution: JobExecutionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetPendingJobExecutionsResponseTypeDef#
# GetPendingJobExecutionsResponseTypeDef TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import GetPendingJobExecutionsResponseTypeDef
def get_value() -> GetPendingJobExecutionsResponseTypeDef:
return {
"inProgressJobs": ...,
}
# GetPendingJobExecutionsResponseTypeDef definition
class GetPendingJobExecutionsResponseTypeDef(TypedDict):
inProgressJobs: List[JobExecutionSummaryTypeDef], # (1)
queuedJobs: List[JobExecutionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See
List[JobExecutionSummaryTypeDef]
- See
List[JobExecutionSummaryTypeDef]
- See ResponseMetadataTypeDef
UpdateJobExecutionResponseTypeDef#
# UpdateJobExecutionResponseTypeDef TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import UpdateJobExecutionResponseTypeDef
def get_value() -> UpdateJobExecutionResponseTypeDef:
return {
"executionState": ...,
}
# UpdateJobExecutionResponseTypeDef definition
class UpdateJobExecutionResponseTypeDef(TypedDict):
executionState: JobExecutionStateTypeDef, # (1)
jobDocument: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartCommandExecutionRequestTypeDef#
# StartCommandExecutionRequestTypeDef TypedDict usage example
from mypy_boto3_iot_jobs_data.type_defs import StartCommandExecutionRequestTypeDef
def get_value() -> StartCommandExecutionRequestTypeDef:
return {
"targetArn": ...,
}
# StartCommandExecutionRequestTypeDef definition
class StartCommandExecutionRequestTypeDef(TypedDict):
targetArn: str,
commandArn: str,
parameters: NotRequired[Mapping[str, CommandParameterValueTypeDef]], # (1)
executionTimeoutSeconds: NotRequired[int],
clientToken: NotRequired[str],
- See
Mapping[str, CommandParameterValueTypeDef]