Skip to content

CodeStarconnectionsClient#

Index > CodeStarconnections > CodeStarconnectionsClient

Auto-generated documentation for CodeStarconnections type annotations stubs module mypy-boto3-codestar-connections.

CodeStarconnectionsClient#

Type annotations and code completion for boto3.client("codestar-connections"). boto3 documentation

# CodeStarconnectionsClient usage example

from boto3.session import Session
from mypy_boto3_codestar_connections.client import CodeStarconnectionsClient

def get_codestar-connections_client() -> CodeStarconnectionsClient:
    return Session().client("codestar-connections")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("codestar-connections").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("codestar-connections")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConcurrentModificationException,
    client.exceptions.ConditionalCheckFailedException,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidInputException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourceUnavailableException,
    client.exceptions.RetryLatestCommitFailedException,
    client.exceptions.SyncBlockerDoesNotExistException,
    client.exceptions.SyncConfigurationStillExistsException,
    client.exceptions.ThrottlingException,
    client.exceptions.UnsupportedOperationException,
    client.exceptions.UnsupportedProviderTypeException,
    client.exceptions.UpdateOutOfSyncException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_codestar_connections.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("codestar-connections").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("codestar-connections").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_connection#

Creates a connection that can then be given to other Amazon Web Services services like CodePipeline so that it can access third-party code repositories.

Type annotations and code completion for boto3.client("codestar-connections").create_connection method. boto3 documentation

# create_connection method definition

def create_connection(
    self,
    *,
    ConnectionName: str,
    ProviderType: ProviderTypeType = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    HostArn: str = ...,
) -> CreateConnectionOutputTypeDef:  # (3)
    ...
  1. See ProviderTypeType
  2. See TagTypeDef
  3. See CreateConnectionOutputTypeDef 
# create_connection method usage example with argument unpacking

kwargs: CreateConnectionInputRequestTypeDef = {  # (1)
    "ConnectionName": ...,
}

parent.create_connection(**kwargs)
  1. See CreateConnectionInputRequestTypeDef

create_host#

Creates a resource that represents the infrastructure where a third-party provider is installed.

Type annotations and code completion for boto3.client("codestar-connections").create_host method. boto3 documentation

# create_host method definition

def create_host(
    self,
    *,
    Name: str,
    ProviderType: ProviderTypeType,  # (1)
    ProviderEndpoint: str,
    VpcConfiguration: VpcConfigurationTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateHostOutputTypeDef:  # (4)
    ...
  1. See ProviderTypeType
  2. See VpcConfigurationTypeDef
  3. See TagTypeDef
  4. See CreateHostOutputTypeDef 
# create_host method usage example with argument unpacking

kwargs: CreateHostInputRequestTypeDef = {  # (1)
    "Name": ...,
    "ProviderType": ...,
    "ProviderEndpoint": ...,
}

parent.create_host(**kwargs)
  1. See CreateHostInputRequestTypeDef

Creates a link to a specified external Git repository.

Type annotations and code completion for boto3.client("codestar-connections").create_repository_link method. boto3 documentation

# create_repository_link method definition

def create_repository_link(
    self,
    *,
    ConnectionArn: str,
    OwnerId: str,
    RepositoryName: str,
    EncryptionKeyArn: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateRepositoryLinkOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateRepositoryLinkOutputTypeDef 
# create_repository_link method usage example with argument unpacking

kwargs: CreateRepositoryLinkInputRequestTypeDef = {  # (1)
    "ConnectionArn": ...,
    "OwnerId": ...,
    "RepositoryName": ...,
}

parent.create_repository_link(**kwargs)
  1. See CreateRepositoryLinkInputRequestTypeDef

create_sync_configuration#

Creates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource.

Type annotations and code completion for boto3.client("codestar-connections").create_sync_configuration method. boto3 documentation

# create_sync_configuration method definition

def create_sync_configuration(
    self,
    *,
    Branch: str,
    ConfigFile: str,
    RepositoryLinkId: str,
    ResourceName: str,
    RoleArn: str,
    SyncType: SyncConfigurationTypeType,  # (1)
    PublishDeploymentStatus: PublishDeploymentStatusType = ...,  # (2)
    TriggerResourceUpdateOn: TriggerResourceUpdateOnType = ...,  # (3)
) -> CreateSyncConfigurationOutputTypeDef:  # (4)
    ...
  1. See SyncConfigurationTypeType
  2. See PublishDeploymentStatusType
  3. See TriggerResourceUpdateOnType
  4. See CreateSyncConfigurationOutputTypeDef 
# create_sync_configuration method usage example with argument unpacking

kwargs: CreateSyncConfigurationInputRequestTypeDef = {  # (1)
    "Branch": ...,
    "ConfigFile": ...,
    "RepositoryLinkId": ...,
    "ResourceName": ...,
    "RoleArn": ...,
    "SyncType": ...,
}

parent.create_sync_configuration(**kwargs)
  1. See CreateSyncConfigurationInputRequestTypeDef

delete_connection#

The connection to be deleted.

Type annotations and code completion for boto3.client("codestar-connections").delete_connection method. boto3 documentation

# delete_connection method definition

def delete_connection(
    self,
    *,
    ConnectionArn: str,
) -> Dict[str, Any]:
    ...
# delete_connection method usage example with argument unpacking

kwargs: DeleteConnectionInputRequestTypeDef = {  # (1)
    "ConnectionArn": ...,
}

parent.delete_connection(**kwargs)
  1. See DeleteConnectionInputRequestTypeDef

delete_host#

The host to be deleted.

Type annotations and code completion for boto3.client("codestar-connections").delete_host method. boto3 documentation

# delete_host method definition

def delete_host(
    self,
    *,
    HostArn: str,
) -> Dict[str, Any]:
    ...
# delete_host method usage example with argument unpacking

kwargs: DeleteHostInputRequestTypeDef = {  # (1)
    "HostArn": ...,
}

parent.delete_host(**kwargs)
  1. See DeleteHostInputRequestTypeDef

Deletes the association between your connection and a specified external Git repository.

Type annotations and code completion for boto3.client("codestar-connections").delete_repository_link method. boto3 documentation

# delete_repository_link method definition

def delete_repository_link(
    self,
    *,
    RepositoryLinkId: str,
) -> Dict[str, Any]:
    ...
# delete_repository_link method usage example with argument unpacking

kwargs: DeleteRepositoryLinkInputRequestTypeDef = {  # (1)
    "RepositoryLinkId": ...,
}

parent.delete_repository_link(**kwargs)
  1. See DeleteRepositoryLinkInputRequestTypeDef

delete_sync_configuration#

Deletes the sync configuration for a specified repository and connection.

Type annotations and code completion for boto3.client("codestar-connections").delete_sync_configuration method. boto3 documentation

# delete_sync_configuration method definition

def delete_sync_configuration(
    self,
    *,
    SyncType: SyncConfigurationTypeType,  # (1)
    ResourceName: str,
) -> Dict[str, Any]:
    ...
  1. See SyncConfigurationTypeType 
# delete_sync_configuration method usage example with argument unpacking

kwargs: DeleteSyncConfigurationInputRequestTypeDef = {  # (1)
    "SyncType": ...,
    "ResourceName": ...,
}

parent.delete_sync_configuration(**kwargs)
  1. See DeleteSyncConfigurationInputRequestTypeDef

generate_presigned_url#

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

Type annotations and code completion for boto3.client("codestar-connections").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_connection#

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

Type annotations and code completion for boto3.client("codestar-connections").get_connection method. boto3 documentation

# get_connection method definition

def get_connection(
    self,
    *,
    ConnectionArn: str,
) -> GetConnectionOutputTypeDef:  # (1)
    ...
  1. See GetConnectionOutputTypeDef 
# get_connection method usage example with argument unpacking

kwargs: GetConnectionInputRequestTypeDef = {  # (1)
    "ConnectionArn": ...,
}

parent.get_connection(**kwargs)
  1. See GetConnectionInputRequestTypeDef

get_host#

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

Type annotations and code completion for boto3.client("codestar-connections").get_host method. boto3 documentation

# get_host method definition

def get_host(
    self,
    *,
    HostArn: str,
) -> GetHostOutputTypeDef:  # (1)
    ...
  1. See GetHostOutputTypeDef 
# get_host method usage example with argument unpacking

kwargs: GetHostInputRequestTypeDef = {  # (1)
    "HostArn": ...,
}

parent.get_host(**kwargs)
  1. See GetHostInputRequestTypeDef

Returns details about a repository link.

Type annotations and code completion for boto3.client("codestar-connections").get_repository_link method. boto3 documentation

# get_repository_link method definition

def get_repository_link(
    self,
    *,
    RepositoryLinkId: str,
) -> GetRepositoryLinkOutputTypeDef:  # (1)
    ...
  1. See GetRepositoryLinkOutputTypeDef 
# get_repository_link method usage example with argument unpacking

kwargs: GetRepositoryLinkInputRequestTypeDef = {  # (1)
    "RepositoryLinkId": ...,
}

parent.get_repository_link(**kwargs)
  1. See GetRepositoryLinkInputRequestTypeDef

get_repository_sync_status#

Returns details about the sync status for a repository.

Type annotations and code completion for boto3.client("codestar-connections").get_repository_sync_status method. boto3 documentation

# get_repository_sync_status method definition

def get_repository_sync_status(
    self,
    *,
    Branch: str,
    RepositoryLinkId: str,
    SyncType: SyncConfigurationTypeType,  # (1)
) -> GetRepositorySyncStatusOutputTypeDef:  # (2)
    ...
  1. See SyncConfigurationTypeType
  2. See GetRepositorySyncStatusOutputTypeDef 
# get_repository_sync_status method usage example with argument unpacking

kwargs: GetRepositorySyncStatusInputRequestTypeDef = {  # (1)
    "Branch": ...,
    "RepositoryLinkId": ...,
    "SyncType": ...,
}

parent.get_repository_sync_status(**kwargs)
  1. See GetRepositorySyncStatusInputRequestTypeDef

get_resource_sync_status#

Returns the status of the sync with the Git repository for a specific Amazon Web Services resource.

Type annotations and code completion for boto3.client("codestar-connections").get_resource_sync_status method. boto3 documentation

# get_resource_sync_status method definition

def get_resource_sync_status(
    self,
    *,
    ResourceName: str,
    SyncType: SyncConfigurationTypeType,  # (1)
) -> GetResourceSyncStatusOutputTypeDef:  # (2)
    ...
  1. See SyncConfigurationTypeType
  2. See GetResourceSyncStatusOutputTypeDef 
# get_resource_sync_status method usage example with argument unpacking

kwargs: GetResourceSyncStatusInputRequestTypeDef = {  # (1)
    "ResourceName": ...,
    "SyncType": ...,
}

parent.get_resource_sync_status(**kwargs)
  1. See GetResourceSyncStatusInputRequestTypeDef

get_sync_blocker_summary#

Returns a list of the most recent sync blockers.

Type annotations and code completion for boto3.client("codestar-connections").get_sync_blocker_summary method. boto3 documentation

# get_sync_blocker_summary method definition

def get_sync_blocker_summary(
    self,
    *,
    SyncType: SyncConfigurationTypeType,  # (1)
    ResourceName: str,
) -> GetSyncBlockerSummaryOutputTypeDef:  # (2)
    ...
  1. See SyncConfigurationTypeType
  2. See GetSyncBlockerSummaryOutputTypeDef 
# get_sync_blocker_summary method usage example with argument unpacking

kwargs: GetSyncBlockerSummaryInputRequestTypeDef = {  # (1)
    "SyncType": ...,
    "ResourceName": ...,
}

parent.get_sync_blocker_summary(**kwargs)
  1. See GetSyncBlockerSummaryInputRequestTypeDef

get_sync_configuration#

Returns details about a sync configuration, including the sync type and resource name.

Type annotations and code completion for boto3.client("codestar-connections").get_sync_configuration method. boto3 documentation

# get_sync_configuration method definition

def get_sync_configuration(
    self,
    *,
    SyncType: SyncConfigurationTypeType,  # (1)
    ResourceName: str,
) -> GetSyncConfigurationOutputTypeDef:  # (2)
    ...
  1. See SyncConfigurationTypeType
  2. See GetSyncConfigurationOutputTypeDef 
# get_sync_configuration method usage example with argument unpacking

kwargs: GetSyncConfigurationInputRequestTypeDef = {  # (1)
    "SyncType": ...,
    "ResourceName": ...,
}

parent.get_sync_configuration(**kwargs)
  1. See GetSyncConfigurationInputRequestTypeDef

list_connections#

Lists the connections associated with your account.

Type annotations and code completion for boto3.client("codestar-connections").list_connections method. boto3 documentation

# list_connections method definition

def list_connections(
    self,
    *,
    ProviderTypeFilter: ProviderTypeType = ...,  # (1)
    HostArnFilter: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListConnectionsOutputTypeDef:  # (2)
    ...
  1. See ProviderTypeType
  2. See ListConnectionsOutputTypeDef 
# list_connections method usage example with argument unpacking

kwargs: ListConnectionsInputRequestTypeDef = {  # (1)
    "ProviderTypeFilter": ...,
}

parent.list_connections(**kwargs)
  1. See ListConnectionsInputRequestTypeDef

list_hosts#

Lists the hosts associated with your account.

Type annotations and code completion for boto3.client("codestar-connections").list_hosts method. boto3 documentation

# list_hosts method definition

def list_hosts(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListHostsOutputTypeDef:  # (1)
    ...
  1. See ListHostsOutputTypeDef 
# list_hosts method usage example with argument unpacking

kwargs: ListHostsInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_hosts(**kwargs)
  1. See ListHostsInputRequestTypeDef

Lists the repository links created for connections in your account.

Type annotations and code completion for boto3.client("codestar-connections").list_repository_links method. boto3 documentation

# list_repository_links method definition

def list_repository_links(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRepositoryLinksOutputTypeDef:  # (1)
    ...
  1. See ListRepositoryLinksOutputTypeDef 
# list_repository_links method usage example with argument unpacking

kwargs: ListRepositoryLinksInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_repository_links(**kwargs)
  1. See ListRepositoryLinksInputRequestTypeDef

list_repository_sync_definitions#

Lists the repository sync definitions for repository links in your account.

Type annotations and code completion for boto3.client("codestar-connections").list_repository_sync_definitions method. boto3 documentation

# list_repository_sync_definitions method definition

def list_repository_sync_definitions(
    self,
    *,
    RepositoryLinkId: str,
    SyncType: SyncConfigurationTypeType,  # (1)
) -> ListRepositorySyncDefinitionsOutputTypeDef:  # (2)
    ...
  1. See SyncConfigurationTypeType
  2. See ListRepositorySyncDefinitionsOutputTypeDef 
# list_repository_sync_definitions method usage example with argument unpacking

kwargs: ListRepositorySyncDefinitionsInputRequestTypeDef = {  # (1)
    "RepositoryLinkId": ...,
    "SyncType": ...,
}

parent.list_repository_sync_definitions(**kwargs)
  1. See ListRepositorySyncDefinitionsInputRequestTypeDef

list_sync_configurations#

Returns a list of sync configurations for a specified repository.

Type annotations and code completion for boto3.client("codestar-connections").list_sync_configurations method. boto3 documentation

# list_sync_configurations method definition

def list_sync_configurations(
    self,
    *,
    RepositoryLinkId: str,
    SyncType: SyncConfigurationTypeType,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSyncConfigurationsOutputTypeDef:  # (2)
    ...
  1. See SyncConfigurationTypeType
  2. See ListSyncConfigurationsOutputTypeDef 
# list_sync_configurations method usage example with argument unpacking

kwargs: ListSyncConfigurationsInputRequestTypeDef = {  # (1)
    "RepositoryLinkId": ...,
    "SyncType": ...,
}

parent.list_sync_configurations(**kwargs)
  1. See ListSyncConfigurationsInputRequestTypeDef

list_tags_for_resource#

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

Type annotations and code completion for boto3.client("codestar-connections").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputRequestTypeDef

tag_resource#

Adds to or modifies the tags of the given resource.

Type annotations and code completion for boto3.client("codestar-connections").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceInputRequestTypeDef

untag_resource#

Removes tags from an Amazon Web Services resource.

Type annotations and code completion for boto3.client("codestar-connections").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceInputRequestTypeDef

update_host#

Updates a specified host with the provided configurations.

Type annotations and code completion for boto3.client("codestar-connections").update_host method. boto3 documentation

# update_host method definition

def update_host(
    self,
    *,
    HostArn: str,
    ProviderEndpoint: str = ...,
    VpcConfiguration: VpcConfigurationTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See VpcConfigurationTypeDef 
# update_host method usage example with argument unpacking

kwargs: UpdateHostInputRequestTypeDef = {  # (1)
    "HostArn": ...,
}

parent.update_host(**kwargs)
  1. See UpdateHostInputRequestTypeDef

Updates the association between your connection and a specified external Git repository.

Type annotations and code completion for boto3.client("codestar-connections").update_repository_link method. boto3 documentation

# update_repository_link method definition

def update_repository_link(
    self,
    *,
    RepositoryLinkId: str,
    ConnectionArn: str = ...,
    EncryptionKeyArn: str = ...,
) -> UpdateRepositoryLinkOutputTypeDef:  # (1)
    ...
  1. See UpdateRepositoryLinkOutputTypeDef 
# update_repository_link method usage example with argument unpacking

kwargs: UpdateRepositoryLinkInputRequestTypeDef = {  # (1)
    "RepositoryLinkId": ...,
}

parent.update_repository_link(**kwargs)
  1. See UpdateRepositoryLinkInputRequestTypeDef

update_sync_blocker#

Allows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue.

Type annotations and code completion for boto3.client("codestar-connections").update_sync_blocker method. boto3 documentation

# update_sync_blocker method definition

def update_sync_blocker(
    self,
    *,
    Id: str,
    SyncType: SyncConfigurationTypeType,  # (1)
    ResourceName: str,
    ResolvedReason: str,
) -> UpdateSyncBlockerOutputTypeDef:  # (2)
    ...
  1. See SyncConfigurationTypeType
  2. See UpdateSyncBlockerOutputTypeDef 
# update_sync_blocker method usage example with argument unpacking

kwargs: UpdateSyncBlockerInputRequestTypeDef = {  # (1)
    "Id": ...,
    "SyncType": ...,
    "ResourceName": ...,
    "ResolvedReason": ...,
}

parent.update_sync_blocker(**kwargs)
  1. See UpdateSyncBlockerInputRequestTypeDef

update_sync_configuration#

Updates the sync configuration for your connection and a specified external Git repository.

Type annotations and code completion for boto3.client("codestar-connections").update_sync_configuration method. boto3 documentation

# update_sync_configuration method definition

def update_sync_configuration(
    self,
    *,
    ResourceName: str,
    SyncType: SyncConfigurationTypeType,  # (1)
    Branch: str = ...,
    ConfigFile: str = ...,
    RepositoryLinkId: str = ...,
    RoleArn: str = ...,
    PublishDeploymentStatus: PublishDeploymentStatusType = ...,  # (2)
    TriggerResourceUpdateOn: TriggerResourceUpdateOnType = ...,  # (3)
) -> UpdateSyncConfigurationOutputTypeDef:  # (4)
    ...
  1. See SyncConfigurationTypeType
  2. See PublishDeploymentStatusType
  3. See TriggerResourceUpdateOnType
  4. See UpdateSyncConfigurationOutputTypeDef 
# update_sync_configuration method usage example with argument unpacking

kwargs: UpdateSyncConfigurationInputRequestTypeDef = {  # (1)
    "ResourceName": ...,
    "SyncType": ...,
}

parent.update_sync_configuration(**kwargs)
  1. See UpdateSyncConfigurationInputRequestTypeDef