AWS CLI Command Reference

[ aws . devops-agent ]

get-backlog-task

Description

Gets a backlog task for the specified agent space and task id

See also: AWS API Documentation

get-backlog-task uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  get-backlog-task
--agent-space-id <value>
--task-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--agent-space-id (string) [required]

The unique identifier for the agent space containing the task

Constraints:

  • pattern: [a-zA-Z0-9-]{1,64}

--task-id (string) [required]

The unique identifier of the task to retrieve

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_.-]+

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

task -> (structure)

The requested task object

agentSpaceId -> (string) [required]

The unique identifier for the agent space containing this task

taskId -> (string) [required]

The unique identifier for this task

executionId -> (string)

The execution ID associated with this task, if any

title -> (string) [required]

The title of the task

description -> (string)

Optional detailed description of the task

reference -> (structure)

Optional reference information linking this task to external systems

system -> (string) [required]

The name of the external system

title -> (string)

Optional title for the reference

referenceId -> (string) [required]

The unique identifier in the external system

referenceUrl -> (string) [required]

URL to access the reference in the external system

associationId -> (string) [required]

Association identifier of the external system

taskType -> (string) [required]

The type of this task

Possible values:

  • INVESTIGATION
  • EVALUATION

priority -> (string) [required]

The priority level of this task

Possible values:

  • CRITICAL
  • HIGH
  • MEDIUM
  • LOW
  • MINIMAL

status -> (string) [required]

The current status of this task

Possible values:

  • PENDING_TRIAGE
  • LINKED
  • PENDING_START
  • IN_PROGRESS
  • PENDING_CUSTOMER_APPROVAL
  • COMPLETED
  • FAILED
  • TIMED_OUT
  • CANCELED

createdAt -> (timestamp) [required]

Timestamp when this task was created

updatedAt -> (timestamp) [required]

Timestamp when this task was last updated

version -> (integer) [required]

Version number for optimistic locking

supportMetadata -> (document)

Optional support metadata for the task

metadata -> (document)

Optional metadata for the task

primaryTaskId -> (string)

The task ID of the primary investigation this task is linked to

statusReason -> (string)

Explanation for why the task status was changed (e.g., linked reason)

hasLinkedTasks -> (boolean)

Indicates if this task has other tasks linked to it
© Copyright 2026, Amazon Web Services. Created using Sphinx.