Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . codestar-connections ]

get-connection

Description

Returns the connection ARN and details such as status, owner, and provider type.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-connection
--connection-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--connection-arn (string)

The Amazon Resource Name (ARN) of a connection.

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

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

See 'aws help' for descriptions of global parameters.

Output

Connection -> (structure)

The connection details, such as status, owner, and provider type.

ConnectionName -> (string)

The name of the connection. Connection names must be unique in an AWS user account.

ConnectionArn -> (string)

The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.

Note

The ARN is never reused if the connection is deleted.

ProviderType -> (string)

The name of the external provider where your third-party code repository is configured. Currently, the valid provider type is Bitbucket.

OwnerAccountId -> (string)

The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.

ConnectionStatus -> (string)

The current status of the connection.