[ aws . proton ]

list-components

Description

List components with summary data. You can filter the result list by environment, service, or a single service instance.

For more information about components, see Proton components in the Proton Administrator Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-components 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: components

Synopsis

  list-components
[--environment-name <value>]
[--service-instance-name <value>]
[--service-name <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--environment-name (string)

The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.

--service-instance-name (string)

The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.

--service-name (string)

The name of a service for result list filtering. Proton returns components attached to service instances of the service.

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

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

See ‘aws help’ for descriptions of global parameters.

Output

components -> (list)

An array of components with summary data.

(structure)

Summary data of an Proton component resource.

For more information about components, see Proton components in the Proton Administrator Guide .

arn -> (string)

The Amazon Resource Name (ARN) of the component.

createdAt -> (timestamp)

The time when the component was created.

deploymentStatus -> (string)

The component deployment status.

deploymentStatusMessage -> (string)

The message associated with the component deployment status.

environmentName -> (string)

The name of the Proton environment that this component is associated with.

lastDeploymentAttemptedAt -> (timestamp)

The time when a deployment of the component was last attempted.

lastDeploymentSucceededAt -> (timestamp)

The time when the component was last deployed successfully.

lastModifiedAt -> (timestamp)

The time when the component was last modified.

name -> (string)

The name of the component.

serviceInstanceName -> (string)

The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

serviceName -> (string)

The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

nextToken -> (string)

A token that indicates the location of the next component in the array of components, after the current requested list of components.