Skip to content

CodeStarconnectionsClient

Index > CodeStarconnections > CodeStarconnectionsClient

Auto-generated documentation for CodeStarconnections type annotations stubs module types-aiobotocore-codestar-connections.

CodeStarconnectionsClient

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

Usage example
from aioboto3.session import Session
from types_aiobotocore_codestar_connections.client import CodeStarconnectionsClient

session = Session()
async with session.client("codestar-connections") as client:
    client: CodeStarconnectionsClient

Exceptions

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

Usage example
async with session.client("codestar-connections") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.ConflictException,
        client.LimitExceededException,
        client.ResourceNotFoundException,
        client.ResourceUnavailableException,
        client.UnsupportedOperationException,
    ) as e:
        print(e)
Type checking example
from types_aiobotocore_codestar_connections.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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

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

close

Closes underlying endpoint connections.

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

Method definition
await def close(
    self,
) -> None:
    ...

create_connection

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

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

Method definition
await 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
Usage example with kwargs
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 session.client("codestar-connections").create_host method. boto3 documentation

Method definition
await 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
Usage example with kwargs
kwargs: CreateHostInputRequestTypeDef = {  # (1)
    "Name": ...,
    "ProviderType": ...,
    "ProviderEndpoint": ...,
}

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

delete_connection

The connection to be deleted.

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

Method definition
await def delete_connection(
    self,
    *,
    ConnectionArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteConnectionInputRequestTypeDef = {  # (1)
    "ConnectionArn": ...,
}

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

delete_host

The host to be deleted.

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

Method definition
await def delete_host(
    self,
    *,
    HostArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteHostInputRequestTypeDef = {  # (1)
    "HostArn": ...,
}

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

generate_presigned_url

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

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

Method definition
await 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 session.client("codestar-connections").get_connection method. boto3 documentation

Method definition
await def get_connection(
    self,
    *,
    ConnectionArn: str,
) -> GetConnectionOutputTypeDef:  # (1)
    ...
  1. See GetConnectionOutputTypeDef
Usage example with kwargs
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 session.client("codestar-connections").get_host method. boto3 documentation

Method definition
await def get_host(
    self,
    *,
    HostArn: str,
) -> GetHostOutputTypeDef:  # (1)
    ...
  1. See GetHostOutputTypeDef
Usage example with kwargs
kwargs: GetHostInputRequestTypeDef = {  # (1)
    "HostArn": ...,
}

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

list_connections

Lists the connections associated with your account.

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

Method definition
await def list_connections(
    self,
    *,
    ProviderTypeFilter: ProviderTypeType = ...,  # (1)
    HostArnFilter: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListConnectionsOutputTypeDef:  # (2)
    ...
  1. See ProviderTypeType
  2. See ListConnectionsOutputTypeDef
Usage example with kwargs
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 session.client("codestar-connections").list_hosts method. boto3 documentation

Method definition
await def list_hosts(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListHostsOutputTypeDef:  # (1)
    ...
  1. See ListHostsOutputTypeDef
Usage example with kwargs
kwargs: ListHostsInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

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

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 session.client("codestar-connections").list_tags_for_resource method. boto3 documentation

Method definition
await def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef
Usage example with kwargs
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 session.client("codestar-connections").tag_resource method. boto3 documentation

Method definition
await def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

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

untag_resource

Removes tags from an AWS resource.

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

Method definition
await def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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 session.client("codestar-connections").update_host method. boto3 documentation

Method definition
await def update_host(
    self,
    *,
    HostArn: str,
    ProviderEndpoint: str = ...,
    VpcConfiguration: VpcConfigurationTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See VpcConfigurationTypeDef
Usage example with kwargs
kwargs: UpdateHostInputRequestTypeDef = {  # (1)
    "HostArn": ...,
}

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

__aenter__

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

Method definition
await def __aenter__(
    self,
) -> CodeStarconnectionsClient:
    ...

__aexit__

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

Method definition
await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...