AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . devops-agent ]

list-backlog-tasks

Description

Lists backlog tasks in the specified agent space with optional filtering and sorting

See also: AWS API Documentation

list-backlog-tasks 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.

list-backlog-tasks is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: tasks

Synopsis

  list-backlog-tasks
--agent-space-id <value>
[--filter <value>]
[--sort-field <value>]
[--order <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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>]
[--v2-debug]

Options

--agent-space-id (string)

The unique identifier for the agent space containing the tasks

--filter (structure)

Filter criteria to apply when listing tasks

Filtering restrictions:

  • Each filter field list is limited to a single value
  • Filtering by Priority and Status at the same time when not filtering by Type is not permitted
  • Timestamp filters (createdAfter, createdBefore) can be combined with other filters when not sorting by priority

createdAfter -> (timestamp)

Filter for tasks created after this timestamp inclusive

createdBefore -> (timestamp)

Filter for tasks created before this timestamp exclusive

priority -> (list)

Filter by priority (single value only)

(string)

Priority levels for tasks, from highest to lowest urgency

status -> (list)

Filter by status (single value only)

(string)

Possible states of a task throughout its lifecycle

taskType -> (list)

Filter by task type (single value only)

(string)

Types of tasks that can be created in the backlog

primaryTaskId -> (string)

Filter by primary task ID to get linked tasks

Shorthand Syntax:

createdAfter=timestamp,createdBefore=timestamp,priority=string,string,status=string,string,taskType=string,string,primaryTaskId=string

JSON Syntax:

{
  "createdAfter": timestamp,
  "createdBefore": timestamp,
  "priority": ["CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"MINIMAL", ...],
  "status": ["PENDING_TRIAGE"|"LINKED"|"PENDING_START"|"IN_PROGRESS"|"PENDING_CUSTOMER_APPROVAL"|"COMPLETED"|"FAILED"|"TIMED_OUT"|"CANCELED", ...],
  "taskType": ["INVESTIGATION"|"EVALUATION", ...],
  "primaryTaskId": "string"
}

--sort-field (string)

Field to sort by

Sorting restrictions:
  • Only sorting on createdAt is supported when using priority or status filters alone.
  • Sorting by priority is not supported when using Timestamp filters (createdAfter, createdBefore)

Possible values:

  • CREATED_AT
  • PRIORITY

--order (string)

Sort order for the tasks based on sortField (default: DESC)

Possible values:

  • ASC
  • DESC

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

tasks -> (list)

List of backlog tasks

(structure)

Represents a backlog task with all its properties and metadata

agentSpaceId -> (string)

The unique identifier for the agent space containing this task

taskId -> (string)

The unique identifier for this task

executionId -> (string)

The execution ID associated with this task, if any

title -> (string)

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)

The name of the external system

title -> (string)

Optional title for the reference

referenceId -> (string)

The unique identifier in the external system

referenceUrl -> (string)

URL to access the reference in the external system

associationId -> (string)

Association identifier of the external system

taskType -> (string)

The type of this task

priority -> (string)

The priority level of this task

status -> (string)

The current status of this task

createdAt -> (timestamp)

Timestamp when this task was created

updatedAt -> (timestamp)

Timestamp when this task was last updated

version -> (integer)

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

nextToken -> (string)

Token for retrieving the next page of results, if more results are available