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 . partnercentral-selling ]

list-opportunity-from-engagement-tasks

Description

Lists all in-progress, completed, or failed opportunity creation tasks from engagements that were initiated by the caller’s account.

See also: AWS API Documentation

list-opportunity-from-engagement-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: TaskSummaries

Synopsis

  list-opportunity-from-engagement-tasks
[--sort <value>]
--catalog <value>
[--task-status <value>]
[--task-identifier <value>]
[--opportunity-identifier <value>]
[--engagement-identifier <value>]
[--context-identifier <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

--sort (structure)

Defines the sorting parameters for listing tasks. This structure allows for specifying the field to sort by and the order of sorting.

SortOrder -> (string)

Determines the order in which the sorted results are presented.

SortBy -> (string)

Specifies the field by which the task list should be sorted.

Shorthand Syntax:

SortOrder=string,SortBy=string

JSON Syntax:

{
  "SortOrder": "ASCENDING"|"DESCENDING",
  "SortBy": "StartTime"
}

--catalog (string)

Specifies the catalog related to the request. Valid values are AWS for production environments and Sandbox for testing or development purposes. The catalog determines which environment the task data is retrieved from.

--task-status (list)

Filters the tasks based on their current status. This allows you to focus on tasks in specific states. Valid values are COMPLETE for tasks that have finished successfully, INPROGRESS for tasks that are currently running, and FAILED for tasks that have encountered an error and failed to complete.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  IN_PROGRESS
  COMPLETE
  FAILED

--task-identifier (list)

Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks. Provide the task ID to get details about a particular opportunity creation task.

(string)

Syntax:

"string" "string" ...

--opportunity-identifier (list)

Filters tasks by the identifiers of the opportunities they created or are associated with. Use this to find tasks related to specific opportunity creation processes.

(string)

Syntax:

"string" "string" ...

--engagement-identifier (list)

Filters tasks by the identifiers of the engagements from which opportunities are being created. Use this to find all opportunity creation tasks associated with a specific engagement.

(string)

Syntax:

"string" "string" ...

--context-identifier (list)

Filters tasks by the identifiers of the engagement contexts associated with the opportunity creation. Use this to find tasks related to specific contextual information within engagements that are being converted to opportunities.

(string)

Syntax:

"string" "string" ...

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

TaskSummaries -> (list)

An array of ListOpportunityFromEngagementTaskSummary objects, each representing a task that matches the specified filters. The array may be empty if no tasks match the criteria.

(structure)

Provides a summary of a task related to creating an opportunity from an engagement. This structure contains key information about the task’s status, associated identifiers, and any failure details for opportunity creation processes.

TaskId -> (string)

The unique identifier of the task for creating an opportunity from an engagement.

TaskArn -> (string)

The Amazon Resource Name (ARN) that uniquely identifies the task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.

StartTime -> (timestamp)

The timestamp indicating when the task was initiated, in RFC 3339 format.

TaskStatus -> (string)

The current status of the task. Valid values are COMPLETE, INPROGRESS, or FAILED.

Message -> (string)

A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task’s execution.

ReasonCode -> (string)

A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.

OpportunityId -> (string)

The unique identifier of the opportunity created as a result of the task. This field is populated when the task is completed successfully.

ResourceSnapshotJobId -> (string)

The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the opportunity creation process.

EngagementId -> (string)

The unique identifier of the engagement from which the opportunity is being created. This field helps track the source of the opportunity creation task.

ContextId -> (string)

The unique identifier of the engagement context associated with the opportunity creation task. This links the task to specific contextual information within the engagement.

NextToken -> (string)

A token used for pagination to retrieve the next page of results. If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.