Table of Contents
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:
You can work with hosts by calling:
You can work with tags in AWS CodeStar Connections by calling the following:
For information about how to use AWS CodeStar Connections, see the Developer Tools User Guide .
import boto3
client = boto3.client('codestar-connections')
These are the available methods:
can_paginate()close()create_connection()create_host()delete_connection()delete_host()get_connection()get_host()get_paginator()get_waiter()list_connections()list_hosts()list_tags_for_resource()tag_resource()untag_resource()update_host()can_paginate(operation_name)¶Check if an operation can be paginated.
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").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
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'
)
[REQUIRED]
The name of the connection to be created. The name must be unique in the calling AWS account.
The key-value pair to use when tagging the resource.
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.
The tag's key.
The tag's value.
dict
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
CodeStarconnections.Client.exceptions.LimitExceededExceptionCodeStarconnections.Client.exceptions.ResourceNotFoundExceptionCodeStarconnections.Client.exceptions.ResourceUnavailableExceptioncreate_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'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the host to be created. The name must be unique in the calling AWS account.
[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.
[REQUIRED]
The endpoint of the infrastructure to be represented by the host after it is created.
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.
The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.
The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.
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.
The tag's key.
The tag's value.
dict
Response Syntax
{
'HostArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
HostArn (string) --
The Amazon Resource Name (ARN) of the host to be created.
Tags (list) --
(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
CodeStarconnections.Client.exceptions.LimitExceededExceptiondelete_connection(**kwargs)¶The connection to be deleted.
See also: AWS API Documentation
Request Syntax
response = client.delete_connection(
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.
{}
Response Structure
Exceptions
CodeStarconnections.Client.exceptions.ResourceNotFoundExceptiondelete_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the host to be deleted.
{}
Response Structure
Exceptions
CodeStarconnections.Client.exceptions.ResourceNotFoundExceptionCodeStarconnections.Client.exceptions.ResourceUnavailableExceptionget_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) of a connection.
{
'Connection': {
'ConnectionName': 'string',
'ConnectionArn': 'string',
'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer',
'OwnerAccountId': 'string',
'ConnectionStatus': 'PENDING'|'AVAILABLE'|'ERROR',
'HostArn': 'string'
}
}
Response Structure
The connection details, such as status, owner, and provider type.
The name of the connection. Connection names must be unique in an AWS user account.
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.
The name of the external provider where your third-party code repository is configured.
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.
The current status of the connection.
The Amazon Resource Name (ARN) of the host associated with the connection.
Exceptions
CodeStarconnections.Client.exceptions.ResourceNotFoundExceptionCodeStarconnections.Client.exceptions.ResourceUnavailableExceptionget_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the requested host.
{
'Name': 'string',
'Status': 'string',
'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer',
'ProviderEndpoint': 'string',
'VpcConfiguration': {
'VpcId': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'TlsCertificate': 'string'
}
}
Response Structure
The name of the requested host.
The status of the requested host.
The provider type of the requested host, such as GitHub Enterprise Server.
The endpoint of the infrastructure represented by the requested host.
The VPC configuration of the requested host.
The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.
The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.
Exceptions
CodeStarconnections.Client.exceptions.ResourceNotFoundExceptionCodeStarconnections.Client.exceptions.ResourceUnavailableExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
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'
)
nextToken value.ListConnections call, which can be used to return the next set of connections in the list.dict
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'
)
nextToken value.ListHosts call, which can be used to return the next set of hosts in the list.dict
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.
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.
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.
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'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
A list of tag key and value pairs associated with the specified resource.
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.
The tag's key.
The tag's value.
Exceptions
CodeStarconnections.Client.exceptions.ResourceNotFoundExceptiontag_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'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to which you want to add or update tags.
[REQUIRED]
The tags you want to modify or add to the resource.
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.
The tag's key.
The tag's value.
dict
Response Syntax
{}
Response Structure
Exceptions
CodeStarconnections.Client.exceptions.ResourceNotFoundExceptionCodeStarconnections.Client.exceptions.LimitExceededExceptionuntag_resource(**kwargs)¶Removes tags from an AWS resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to remove tags from.
[REQUIRED]
The list of keys for the tags to be removed from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
CodeStarconnections.Client.exceptions.ResourceNotFoundExceptionupdate_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'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the host to be updated.
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.
The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.
The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.
dict
Response Syntax
{}
Response Structure
Exceptions
CodeStarconnections.Client.exceptions.ConflictExceptionCodeStarconnections.Client.exceptions.ResourceNotFoundExceptionCodeStarconnections.Client.exceptions.ResourceUnavailableExceptionCodeStarconnections.Client.exceptions.UnsupportedOperationExceptionThe available paginators are: