Skip to content

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

# IoTJobsDataPlaneClient usage example

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.

# Exceptions.exceptions usage example

client = boto3.client("iot-jobs-data")

try:
    do_something(client)
except (
    client.exceptions.CertificateValidationException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidRequestException,
    client.exceptions.InvalidStateTransitionException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.TerminalStateException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_iot_jobs_data.client import Exceptions

def handle_error(exc: Exceptions.CertificateValidationException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("iot-jobs-data").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("iot-jobs-data").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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

# describe_job_execution method definition

def describe_job_execution(
    self,
    *,
    jobId: str,
    thingName: str,
    includeJobDocument: bool = ...,
    executionNumber: int = ...,
) -> DescribeJobExecutionResponseTypeDef:  # (1)
    ...
  1. See DescribeJobExecutionResponseTypeDef 
# describe_job_execution method usage example with argument unpacking

kwargs: DescribeJobExecutionRequestRequestTypeDef = {  # (1)
    "jobId": ...,
    "thingName": ...,
}

parent.describe_job_execution(**kwargs)
  1. See DescribeJobExecutionRequestRequestTypeDef

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

# get_pending_job_executions method definition

def get_pending_job_executions(
    self,
    *,
    thingName: str,
) -> GetPendingJobExecutionsResponseTypeDef:  # (1)
    ...
  1. See GetPendingJobExecutionsResponseTypeDef 
# get_pending_job_executions method usage example with argument unpacking

kwargs: GetPendingJobExecutionsRequestRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.get_pending_job_executions(**kwargs)
  1. See GetPendingJobExecutionsRequestRequestTypeDef

start_command_execution#

Using the command created with the CreateCommand API, start a command execution on a specific device.

Type annotations and code completion for boto3.client("iot-jobs-data").start_command_execution method. boto3 documentation

# start_command_execution method definition

def start_command_execution(
    self,
    *,
    targetArn: str,
    commandArn: str,
    parameters: Mapping[str, CommandParameterValueTypeDef] = ...,  # (1)
    executionTimeoutSeconds: int = ...,
    clientToken: str = ...,
) -> StartCommandExecutionResponseTypeDef:  # (2)
    ...
  1. See CommandParameterValueTypeDef
  2. See StartCommandExecutionResponseTypeDef 
# start_command_execution method usage example with argument unpacking

kwargs: StartCommandExecutionRequestRequestTypeDef = {  # (1)
    "targetArn": ...,
    "commandArn": ...,
}

parent.start_command_execution(**kwargs)
  1. See StartCommandExecutionRequestRequestTypeDef

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

# start_next_pending_job_execution method definition

def start_next_pending_job_execution(
    self,
    *,
    thingName: str,
    statusDetails: Mapping[str, str] = ...,
    stepTimeoutInMinutes: int = ...,
) -> StartNextPendingJobExecutionResponseTypeDef:  # (1)
    ...
  1. See StartNextPendingJobExecutionResponseTypeDef 
# start_next_pending_job_execution method usage example with argument unpacking

kwargs: StartNextPendingJobExecutionRequestRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.start_next_pending_job_execution(**kwargs)
  1. See StartNextPendingJobExecutionRequestRequestTypeDef

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

# update_job_execution method definition

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)
    ...
  1. See JobExecutionStatusType
  2. See UpdateJobExecutionResponseTypeDef 
# update_job_execution method usage example with argument unpacking

kwargs: UpdateJobExecutionRequestRequestTypeDef = {  # (1)
    "jobId": ...,
    "thingName": ...,
    "status": ...,
}

parent.update_job_execution(**kwargs)
  1. See UpdateJobExecutionRequestRequestTypeDef