AWS CodeStar connections

Lists the connections associated with your account.

See also: AWS API Documentation

Request Syntax

client.list_connections(
    ProviderTypeFilter='Bitbucket',
    MaxResults=123,
    NextToken='string'
)

type ProviderTypeFilter

string

param ProviderTypeFilter

Filters the list of connections to those associated with a specified provider, such as Bitbucket.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken

string

param NextToken

The token that was returned from the previous ListConnections call, which can be used to return the next set of connections in the list.

rtype

dict

returns

Response Syntax

{
    'Connections': [
        {
            'ConnectionName': 'string',
            'ConnectionArn': 'string',
            'ProviderType': 'Bitbucket',
            'OwnerAccountId': 'string',
            'ConnectionStatus': 'PENDING'|'AVAILABLE'|'ERROR'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Connections (list) --

    A list of connections and the details for each connection, such as status, owner, and provider type.

    • (dict) --

      The configuration that allows a service such as CodePipeline to connect to a third-party code repository.

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

  • NextToken (string) --

    A token that can be used in the next ListConnections call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.

Creates a connection that can then be given to other AWS services like CodePipeline so that it can access third-party code repositories. The connection is in pending status until the third-party connection handshake is completed from the console.

See also: AWS API Documentation

Request Syntax

client.create_connection(
    ProviderType='Bitbucket',
    ConnectionName='string'
)

type ProviderType

string

param ProviderType

[REQUIRED]

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

type ConnectionName

string

param ConnectionName

[REQUIRED]

The name of the connection to be created. The name must be unique in the calling AWS account.

rtype

dict

returns

Response Syntax

{
    'ConnectionArn': 'string'
}

Response Structure

• (dict) --

  • ConnectionArn (string) --

    The Amazon Resource Name (ARN) of the connection to be created. 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.

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

See also: AWS API Documentation

Request Syntax

client.get_connection(
    ConnectionArn='string'
)

type ConnectionArn

string

param ConnectionArn

[REQUIRED]

The Amazon Resource Name (ARN) of a connection.

rtype

dict

returns

Response Syntax

{
    'Connection': {
        'ConnectionName': 'string',
        'ConnectionArn': 'string',
        'ProviderType': 'Bitbucket',
        'OwnerAccountId': 'string',
        'ConnectionStatus': 'PENDING'|'AVAILABLE'|'ERROR'
    }
}

Response Structure

• (dict) --

  • Connection (dict) --

    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.

The connection to be deleted.

See also: AWS API Documentation

Request Syntax

client.delete_connection(
    ConnectionArn='string'
)

type ConnectionArn

string

param ConnectionArn

[REQUIRED]

The Amazon Resource Name (ARN) of the connection to be deleted.

Note

The ARN is never reused if the connection is deleted.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --