Skip to content

IoTJobsDataPlaneClient#

Index > IoTJobsDataPlane > IoTJobsDataPlaneClient

Auto-generated documentation for IoTJobsDataPlane type annotations stubs module types-aiobotocore-iot-jobs-data.

IoTJobsDataPlaneClient#

Type annotations and code completion for session.create_client("iot-jobs-data") boto3 documentation

IoTJobsDataPlaneClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_iot_jobs_data.client import IoTJobsDataPlaneClient

session = get_session()
async with session.create_client("iot-jobs-data") as client:
    client: IoTJobsDataPlaneClient

Exceptions#

aiobotocore client exceptions are generated in runtime. This class provides code completion for session.create_client("iot-jobs-data").exceptions structure.

IoTJobsDataPlaneClient.exceptions usage example

async with session.create_client("iot-jobs-data") as client:
    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)
IoTJobsDataPlaneClient usage type checking example

from types_aiobotocore_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 session.create_client("iot-jobs-data").can_paginate method. boto3 documentation

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

Type annotations and code completion for session.create_client("iot-jobs-data").close method. boto3 documentation

# close method definition

await def close(
    self,
) -> None:
    ...

describe_job_execution#

Gets details of a job execution.

Type annotations and code completion for session.create_client("iot-jobs-data").describe_job_execution method. boto3 documentation

# describe_job_execution method definition

await 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

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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

# generate_presigned_url method definition

await 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 session.create_client("iot-jobs-data").get_pending_job_executions method. boto3 documentation

# get_pending_job_executions method definition

await 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_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 session.create_client("iot-jobs-data").start_next_pending_job_execution method. boto3 documentation

# start_next_pending_job_execution method definition

await 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 session.create_client("iot-jobs-data").update_job_execution method. boto3 documentation

# update_job_execution method definition

await 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

__aenter__#

Type annotations and code completion for session.create_client("iot-jobs-data").__aenter__ method. boto3 documentation

# __aenter__ method definition

await def __aenter__(
    self,
) -> IoTJobsDataPlaneClient:
    ...

__aexit__#

Type annotations and code completion for session.create_client("iot-jobs-data").__aexit__ method. boto3 documentation

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...