DescribeJobExecution

$result = $client->describeJobExecution([/* ... */]);
$promise = $client->describeJobExecutionAsync([/* ... */]);

Gets details of a job execution.

Requires permission to access the DescribeJobExecution action.

Parameter Syntax

$result = $client->describeJobExecution([
    'executionNumber' => <integer>,
    'includeJobDocument' => true || false,
    'jobId' => '<string>', // REQUIRED
    'thingName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'execution' => [
        'approximateSecondsBeforeTimedOut' => <integer>,
        'executionNumber' => <integer>,
        'jobDocument' => '<string>',
        'jobId' => '<string>',
        'lastUpdatedAt' => <integer>,
        'queuedAt' => <integer>,
        'startedAt' => <integer>,
        'status' => 'QUEUED|IN_PROGRESS|SUCCEEDED|FAILED|TIMED_OUT|REJECTED|REMOVED|CANCELED',
        'statusDetails' => ['<string>', ...],
        'thingName' => '<string>',
        'versionNumber' => <integer>,
    ],
]

Result Details

Errors

InvalidRequestException:

The contents of the request were invalid.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The rate exceeds the limit.

ServiceUnavailableException:

The service is temporarily unavailable.

CertificateValidationException:

The certificate is invalid.

TerminalStateException:

The job is in a terminal state.

GetPendingJobExecutions

$result = $client->getPendingJobExecutions([/* ... */]);
$promise = $client->getPendingJobExecutionsAsync([/* ... */]);

Gets the list of all jobs for a thing that are not in a terminal status.

Requires permission to access the GetPendingJobExecutions action.

Parameter Syntax

$result = $client->getPendingJobExecutions([
    'thingName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'inProgressJobs' => [
        [
            'executionNumber' => <integer>,
            'jobId' => '<string>',
            'lastUpdatedAt' => <integer>,
            'queuedAt' => <integer>,
            'startedAt' => <integer>,
            'versionNumber' => <integer>,
        ],
        // ...
    ],
    'queuedJobs' => [
        [
            'executionNumber' => <integer>,
            'jobId' => '<string>',
            'lastUpdatedAt' => <integer>,
            'queuedAt' => <integer>,
            'startedAt' => <integer>,
            'versionNumber' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The contents of the request were invalid.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The rate exceeds the limit.

ServiceUnavailableException:

The service is temporarily unavailable.

CertificateValidationException:

The certificate is invalid.

StartCommandExecution

$result = $client->startCommandExecution([/* ... */]);
$promise = $client->startCommandExecutionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->startCommandExecution([
    'clientToken' => '<string>',
    'commandArn' => '<string>', // REQUIRED
    'executionTimeoutSeconds' => <integer>,
    'parameters' => [
        '<CommandParameterName>' => [
            'B' => true || false,
            'BIN' => <string || resource || Psr\Http\Message\StreamInterface>,
            'D' => <float>,
            'I' => <integer>,
            'L' => <integer>,
            'S' => '<string>',
            'UL' => '<string>',
        ],
        // ...
    ],
    'targetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'executionId' => '<string>',
]

Result Details

Errors

ValidationException:

A validation error occurred when performing the API request.

ResourceNotFoundException:

The specified resource does not exist.

ConflictException:

A conflict has occurred when performing the API request.

ThrottlingException:

The rate exceeds the limit.

ServiceQuotaExceededException:

The service quota has been exceeded for this request.

InternalServerException:

An internal server error occurred when performing the API request.

StartNextPendingJobExecution

$result = $client->startNextPendingJobExecution([/* ... */]);
$promise = $client->startNextPendingJobExecutionAsync([/* ... */]);

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

Requires permission to access the StartNextPendingJobExecution action.

Parameter Syntax

$result = $client->startNextPendingJobExecution([
    'statusDetails' => ['<string>', ...],
    'stepTimeoutInMinutes' => <integer>,
    'thingName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'execution' => [
        'approximateSecondsBeforeTimedOut' => <integer>,
        'executionNumber' => <integer>,
        'jobDocument' => '<string>',
        'jobId' => '<string>',
        'lastUpdatedAt' => <integer>,
        'queuedAt' => <integer>,
        'startedAt' => <integer>,
        'status' => 'QUEUED|IN_PROGRESS|SUCCEEDED|FAILED|TIMED_OUT|REJECTED|REMOVED|CANCELED',
        'statusDetails' => ['<string>', ...],
        'thingName' => '<string>',
        'versionNumber' => <integer>,
    ],
]

Result Details

Errors

InvalidRequestException:

The contents of the request were invalid.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The rate exceeds the limit.

ServiceUnavailableException:

The service is temporarily unavailable.

CertificateValidationException:

The certificate is invalid.

UpdateJobExecution

$result = $client->updateJobExecution([/* ... */]);
$promise = $client->updateJobExecutionAsync([/* ... */]);

Updates the status of a job execution.

Requires permission to access the UpdateJobExecution action.

Parameter Syntax

$result = $client->updateJobExecution([
    'executionNumber' => <integer>,
    'expectedVersion' => <integer>,
    'includeJobDocument' => true || false,
    'includeJobExecutionState' => true || false,
    'jobId' => '<string>', // REQUIRED
    'status' => 'QUEUED|IN_PROGRESS|SUCCEEDED|FAILED|TIMED_OUT|REJECTED|REMOVED|CANCELED', // REQUIRED
    'statusDetails' => ['<string>', ...],
    'stepTimeoutInMinutes' => <integer>,
    'thingName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'executionState' => [
        'status' => 'QUEUED|IN_PROGRESS|SUCCEEDED|FAILED|TIMED_OUT|REJECTED|REMOVED|CANCELED',
        'statusDetails' => ['<string>', ...],
        'versionNumber' => <integer>,
    ],
    'jobDocument' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The contents of the request were invalid.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The rate exceeds the limit.

ServiceUnavailableException:

The service is temporarily unavailable.

CertificateValidationException:

The certificate is invalid.

InvalidStateTransitionException:

An update attempted to change the job execution to a state that is invalid because of the job execution's current state (for example, an attempt to change a request in state SUCCESS to state IN_PROGRESS). In this case, the body of the error message also contains the executionState field.