[ aws . iot ]

get-job-document

Description

Gets a job document.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-job-document
--job-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--job-id (string)

The unique identifier you assigned to this job when it was created.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve the document for a job

The following get-job-document example displays details about the document for the job whose ID is example-job-01.

aws iot get-job-document \
    --job-id "example-job-01"

Output:

{
    "document": "\n{\n    \"operation\":\"customJob\",\n    \"otherInfo\":\"someValue\"\n}\n"
}

For more information, see Creating and Managing Jobs (CLI) in the AWS IoT Developer Guide.

Output

document -> (string)

The job document content.