IoTJobsDataPlaneClient
Index > IoTJobsDataPlane > IoTJobsDataPlaneClient
Auto-generated documentation for IoTJobsDataPlane type annotations stubs module mypy-boto3-iot-jobs-data.
IoTJobsDataPlaneClient
Type annotations and code completion for boto3.client("iot-jobs-data")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_iot_jobs_data.client import IoTJobsDataPlaneClient
def get_iot-jobs-data_client() -> IoTJobsDataPlaneClient:
return Session().client("iot-jobs-data")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("iot-jobs-data").exceptions
structure.
client = boto3.client("iot-jobs-data")
try:
do_something(client)
except (
client.CertificateValidationException,
client.ClientError,
client.InvalidRequestException,
client.InvalidStateTransitionException,
client.ResourceNotFoundException,
client.ServiceUnavailableException,
client.TerminalStateException,
client.ThrottlingException,
) as e:
print(e)
from mypy_boto3_iot_jobs_data.client import Exceptions
def handle_error(exc: Exceptions.CertificateValidationException) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("iot-jobs-data").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("iot-jobs-data").close
method.
boto3 documentation
describe_job_execution
Gets details of a job execution.
Type annotations and code completion for boto3.client("iot-jobs-data").describe_job_execution
method.
boto3 documentation
def describe_job_execution(
self,
*,
jobId: str,
thingName: str,
includeJobDocument: bool = ...,
executionNumber: int = ...,
) -> DescribeJobExecutionResponseTypeDef: # (1)
...
kwargs: DescribeJobExecutionRequestRequestTypeDef = { # (1)
"jobId": ...,
"thingName": ...,
}
parent.describe_job_execution(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("iot-jobs-data").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_pending_job_executions
Gets the list of all jobs for a thing that are not in a terminal status.
Type annotations and code completion for boto3.client("iot-jobs-data").get_pending_job_executions
method.
boto3 documentation
def get_pending_job_executions(
self,
*,
thingName: str,
) -> GetPendingJobExecutionsResponseTypeDef: # (1)
...
kwargs: GetPendingJobExecutionsRequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.get_pending_job_executions(**kwargs)
start_next_pending_job_execution
Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.
Type annotations and code completion for boto3.client("iot-jobs-data").start_next_pending_job_execution
method.
boto3 documentation
def start_next_pending_job_execution(
self,
*,
thingName: str,
statusDetails: Mapping[str, str] = ...,
stepTimeoutInMinutes: int = ...,
) -> StartNextPendingJobExecutionResponseTypeDef: # (1)
...
kwargs: StartNextPendingJobExecutionRequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.start_next_pending_job_execution(**kwargs)
update_job_execution
Updates the status of a job execution.
Type annotations and code completion for boto3.client("iot-jobs-data").update_job_execution
method.
boto3 documentation
def update_job_execution(
self,
*,
jobId: str,
thingName: str,
status: JobExecutionStatusType, # (1)
statusDetails: Mapping[str, str] = ...,
stepTimeoutInMinutes: int = ...,
expectedVersion: int = ...,
includeJobExecutionState: bool = ...,
includeJobDocument: bool = ...,
executionNumber: int = ...,
) -> UpdateJobExecutionResponseTypeDef: # (2)
...