[ aws . proton ]

list-environment-account-connections

Description

View a list of environment account connections.

For more information, see Environment account connections in the Proton Administrator guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-environment-account-connections 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: environmentAccountConnections

Synopsis

  list-environment-account-connections
[--environment-name <value>]
--requested-by <value>
[--statuses <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 environment name that’s associated with each listed environment account connection.

--requested-by (string)

The type of account making the ListEnvironmentAccountConnections request.

Possible values:

• MANAGEMENT_ACCOUNT

• ENVIRONMENT_ACCOUNT

--statuses (list)

The status details for each listed environment account connection.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  PENDING
  CONNECTED
  REJECTED

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

environmentAccountConnections -> (list)

An array of environment account connections with details that’s returned by Proton.

(structure)

Summary data of an Proton environment account connection resource.

arn -> (string)

The Amazon Resource Name (ARN) of the environment account connection.

componentRoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.

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

environmentAccountId -> (string)

The ID of the environment account that’s connected to the environment account connection.

environmentName -> (string)

The name of the environment that’s associated with the environment account connection.

id -> (string)

The ID of the environment account connection.

lastModifiedAt -> (timestamp)

The time when the environment account connection was last modified.

managementAccountId -> (string)

The ID of the management account that’s connected to the environment account connection.

requestedAt -> (timestamp)

The time when the environment account connection request was made.

roleArn -> (string)

The IAM service role that’s associated with the environment account connection.

status -> (string)

The status of the environment account connection.

nextToken -> (string)

A token that indicates the location of the next environment account connection in the array of environment account connections, after the current requested list of environment account connections.