CodeStarconnections

Client

class CodeStarconnections.Client

A low-level client representing AWS CodeStar connections

This AWS CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Connections API. You can use the connections API to work with connections and installations.

Connections are configurations that you use to connect AWS resources to external code repositories. Each connection is a resource that can be given to services such as CodePipeline to connect to a third-party repository such as Bitbucket. For example, you can add the connection in CodePipeline so that it triggers your pipeline when a code change is made to your third-party code repository. Each connection is named and associated with a unique ARN that is used to reference the connection.

When you create a connection, the console initiates a third-party connection handshake. Installations are the apps that are used to conduct this handshake. For example, the installation for the Bitbucket provider type is the Bitbucket app. When you create a connection, you can choose an existing installation or create one.

When you want to create a connection to an installed provider type such as GitHub Enterprise Server, you create a host for your connections.

You can work with connections by calling:

  • CreateConnection , which creates a uniquely named connection that can be referenced by services such as CodePipeline.
  • DeleteConnection , which deletes the specified connection.
  • GetConnection , which returns information about the connection, including the connection status.
  • ListConnections , which lists the connections associated with your account.

You can work with hosts by calling:

  • CreateHost , which creates a host that represents the infrastructure where your provider is installed.
  • DeleteHost , which deletes the specified host.
  • GetHost , which returns information about the host, including the setup status.
  • ListHosts , which lists the hosts associated with your account.

You can work with tags in AWS CodeStar Connections by calling the following:

  • ListTagsForResource , which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeStar Connections.
  • TagResource , which adds or updates tags for a resource in AWS CodeStar Connections.
  • UntagResource , which removes tags for a resource in AWS CodeStar Connections.

For information about how to use AWS CodeStar Connections, see the Developer Tools User Guide .

client = session.create_client('codestar-connections')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_connection(**kwargs)

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

response = client.create_connection(
    ProviderType='Bitbucket'|'GitHub'|'GitHubEnterpriseServer',
    ConnectionName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    HostArn='string'
)
Parameters
  • ProviderType (string) -- The name of the external provider where your third-party code repository is configured.
  • ConnectionName (string) --

    [REQUIRED]

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

  • Tags (list) --

    The key-value pair to use when tagging the resource.

    • (dict) --

      A tag is a key-value pair that is used to manage the resource.

      This tag is available for use by AWS services that support tags.

      • Key (string) -- [REQUIRED]

        The tag's key.

      • Value (string) -- [REQUIRED]

        The tag's value.

  • HostArn (string) -- The Amazon Resource Name (ARN) of the host associated with the connection to be created.
Return type

dict

Returns

Response Syntax

{
    'ConnectionArn': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': '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.

    • Tags (list) --

      Specifies the tags applied to the resource.

      • (dict) --

        A tag is a key-value pair that is used to manage the resource.

        This tag is available for use by AWS services that support tags.

        • Key (string) --

          The tag's key.

        • Value (string) --

          The tag's value.

Exceptions

create_host(**kwargs)

Creates a resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider.

Note

A host created through the CLI or the SDK is in PENDING status by default. You can make its status AVAILABLE by setting up the host in the console.

See also: AWS API Documentation

Request Syntax

response = client.create_host(
    Name='string',
    ProviderType='Bitbucket'|'GitHub'|'GitHubEnterpriseServer',
    ProviderEndpoint='string',
    VpcConfiguration={
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'TlsCertificate': 'string'
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

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

  • ProviderType (string) --

    [REQUIRED]

    The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.

  • ProviderEndpoint (string) --

    [REQUIRED]

    The endpoint of the infrastructure to be represented by the host after it is created.

  • VpcConfiguration (dict) --

    The VPC configuration to be provisioned for the host. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.

    • VpcId (string) -- [REQUIRED]

      The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

    • SubnetIds (list) -- [REQUIRED]

      The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

      • (string) --
    • SecurityGroupIds (list) -- [REQUIRED]

      The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

      • (string) --
    • TlsCertificate (string) --

      The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

Return type

dict

Returns

Response Syntax

{
    'HostArn': 'string'
}

Response Structure

  • (dict) --

    • HostArn (string) --

      The Amazon Resource Name (ARN) of the host to be created.

Exceptions

delete_connection(**kwargs)

The connection to be deleted.

See also: AWS API Documentation

Request Syntax

response = client.delete_connection(
    ConnectionArn='string'
)
Parameters
ConnectionArn (string) --

[REQUIRED]

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

Note

The ARN is never reused if the connection is deleted.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_host(**kwargs)

The host to be deleted. Before you delete a host, all connections associated to the host must be deleted.

Note

A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.

See also: AWS API Documentation

Request Syntax

response = client.delete_host(
    HostArn='string'
)
Parameters
HostArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_connection(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_connection(
    ConnectionArn='string'
)
Parameters
ConnectionArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of a connection.

Return type
dict
Returns
Response Syntax
{
    'Connection': {
        'ConnectionName': 'string',
        'ConnectionArn': 'string',
        'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer',
        'OwnerAccountId': 'string',
        'ConnectionStatus': 'PENDING'|'AVAILABLE'|'ERROR',
        'HostArn': 'string'
    }
}

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.

      • OwnerAccountId (string) --

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

      • HostArn (string) --

        The Amazon Resource Name (ARN) of the host associated with the connection.

Exceptions

get_host(**kwargs)

Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.

See also: AWS API Documentation

Request Syntax

response = client.get_host(
    HostArn='string'
)
Parameters
HostArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the requested host.

Return type
dict
Returns
Response Syntax
{
    'Name': 'string',
    'Status': 'string',
    'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer',
    'ProviderEndpoint': 'string',
    'VpcConfiguration': {
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'TlsCertificate': 'string'
    }
}

Response Structure

  • (dict) --
    • Name (string) --

      The name of the requested host.

    • Status (string) --

      The status of the requested host.

    • ProviderType (string) --

      The provider type of the requested host, such as GitHub Enterprise Server.

    • ProviderEndpoint (string) --

      The endpoint of the infrastructure represented by the requested host.

    • VpcConfiguration (dict) --

      The VPC configuration of the requested host.

      • VpcId (string) --

        The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

      • SubnetIds (list) --

        The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

        • (string) --
      • SecurityGroupIds (list) --

        The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

        • (string) --
      • TlsCertificate (string) --

        The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_connections(**kwargs)

Lists the connections associated with your account.

See also: AWS API Documentation

Request Syntax

response = client.list_connections(
    ProviderTypeFilter='Bitbucket'|'GitHub'|'GitHubEnterpriseServer',
    HostArnFilter='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ProviderTypeFilter (string) -- Filters the list of connections to those associated with a specified provider, such as Bitbucket.
  • HostArnFilter (string) -- Filters the list of connections to those associated with a specified host.
  • MaxResults (integer) -- The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  • NextToken (string) -- The token that was returned from the previous ListConnections call, which can be used to return the next set of connections in the list.
Return type

dict

Returns

Response Syntax

{
    'Connections': [
        {
            'ConnectionName': 'string',
            'ConnectionArn': 'string',
            'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer',
            'OwnerAccountId': 'string',
            'ConnectionStatus': 'PENDING'|'AVAILABLE'|'ERROR',
            'HostArn': 'string'
        },
    ],
    '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) --

        A resource that is used to connect third-party source providers with services like AWS CodePipeline.

        Note: A connection created through CloudFormation, the CLI, or the SDK is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

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

        • OwnerAccountId (string) --

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

        • HostArn (string) --

          The Amazon Resource Name (ARN) of the host associated with 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.

list_hosts(**kwargs)

Lists the hosts associated with your account.

See also: AWS API Documentation

Request Syntax

response = client.list_hosts(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  • NextToken (string) -- The token that was returned from the previous ListHosts call, which can be used to return the next set of hosts in the list.
Return type

dict

Returns

Response Syntax

{
    'Hosts': [
        {
            'Name': 'string',
            'HostArn': 'string',
            'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer',
            'ProviderEndpoint': 'string',
            'VpcConfiguration': {
                'VpcId': 'string',
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ],
                'TlsCertificate': 'string'
            },
            'Status': 'string',
            'StatusMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Hosts (list) --

      A list of hosts and the details for each host, such as status, endpoint, and provider type.

      • (dict) --

        A resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider.

        Note

        A host created through the CLI or the SDK is in PENDING status by default. You can make its status AVAILABLE by setting up the host in the console.

        • Name (string) --

          The name of the host.

        • HostArn (string) --

          The Amazon Resource Name (ARN) of the host.

        • ProviderType (string) --

          The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.

        • ProviderEndpoint (string) --

          The endpoint of the infrastructure where your provider type is installed.

        • VpcConfiguration (dict) --

          The VPC configuration provisioned for the host.

          • VpcId (string) --

            The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

          • SubnetIds (list) --

            The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

            • (string) --
          • SecurityGroupIds (list) --

            The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

            • (string) --
          • TlsCertificate (string) --

            The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

        • Status (string) --

          The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

        • StatusMessage (string) --

          The status description for the host.

    • NextToken (string) --

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

list_tags_for_resource(**kwargs)

Gets the set of key-value pairs (metadata) that are used to manage the resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any.

Return type
dict
Returns
Response Syntax
{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • Tags (list) --

      A list of tag key and value pairs associated with the specified resource.

      • (dict) --

        A tag is a key-value pair that is used to manage the resource.

        This tag is available for use by AWS services that support tags.

        • Key (string) --

          The tag's key.

        • Value (string) --

          The tag's value.

Exceptions

tag_resource(**kwargs)

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource to which you want to add or update tags.

  • Tags (list) --

    [REQUIRED]

    The tags you want to modify or add to the resource.

    • (dict) --

      A tag is a key-value pair that is used to manage the resource.

      This tag is available for use by AWS services that support tags.

      • Key (string) -- [REQUIRED]

        The tag's key.

      • Value (string) -- [REQUIRED]

        The tag's value.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes tags from an AWS resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource to remove tags from.

  • TagKeys (list) --

    [REQUIRED]

    The list of keys for the tags to be removed from the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_host(**kwargs)

Updates a specified host with the provided configurations.

See also: AWS API Documentation

Request Syntax

response = client.update_host(
    HostArn='string',
    ProviderEndpoint='string',
    VpcConfiguration={
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'TlsCertificate': 'string'
    }
)
Parameters
  • HostArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the host to be updated.

  • ProviderEndpoint (string) -- The URL or endpoint of the host to be updated.
  • VpcConfiguration (dict) --

    The VPC configuration of the host to be updated. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.

    • VpcId (string) -- [REQUIRED]

      The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

    • SubnetIds (list) -- [REQUIRED]

      The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

      • (string) --
    • SecurityGroupIds (list) -- [REQUIRED]

      The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

      • (string) --
    • TlsCertificate (string) --

      The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class CodeStarconnections.Client.exceptions.ConflictException

Two conflicting operations have been made on the same resource.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Two conflicting operations have been made on the same resource.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CodeStarconnections.Client.exceptions.LimitExceededException

Exceeded the maximum limit for connections.

Example

try:
  ...
except client.exceptions.LimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Exceeded the maximum limit for connections.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CodeStarconnections.Client.exceptions.ResourceNotFoundException

Resource not found. Verify the connection resource ARN and try again.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Resource not found. Verify the connection resource ARN and try again.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CodeStarconnections.Client.exceptions.ResourceUnavailableException

Resource not found. Verify the ARN for the host resource and try again.

Example

try:
  ...
except client.exceptions.ResourceUnavailableException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Resource not found. Verify the ARN for the host resource and try again.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CodeStarconnections.Client.exceptions.UnsupportedOperationException

The operation is not supported. Check the connection status and try again.

Example

try:
  ...
except client.exceptions.UnsupportedOperationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation is not supported. Check the connection status and try again.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: