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
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.
client = boto3.client("codestar-connections")
try:
do_something(client)
except (
client.ClientError,
client.ConflictException,
client.LimitExceededException,
client.ResourceNotFoundException,
client.ResourceUnavailableException,
client.UnsupportedOperationException,
) as e:
print(e)
from mypy_boto3_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 boto3.client("codestar-connections").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("codestar-connections").close
method.
boto3 documentation
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 boto3.client("codestar-connections").create_connection
method.
boto3 documentation
def create_connection(
self,
*,
ConnectionName: str,
ProviderType: ProviderTypeType = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
HostArn: str = ...,
) -> CreateConnectionOutputTypeDef: # (3)
...
- See ProviderTypeType
- See TagTypeDef
- See CreateConnectionOutputTypeDef
kwargs: CreateConnectionInputRequestTypeDef = { # (1)
"ConnectionName": ...,
}
parent.create_connection(**kwargs)
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
def create_host(
self,
*,
Name: str,
ProviderType: ProviderTypeType, # (1)
ProviderEndpoint: str,
VpcConfiguration: VpcConfigurationTypeDef = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateHostOutputTypeDef: # (4)
...
- See ProviderTypeType
- See VpcConfigurationTypeDef
- See TagTypeDef
- See CreateHostOutputTypeDef
kwargs: CreateHostInputRequestTypeDef = { # (1)
"Name": ...,
"ProviderType": ...,
"ProviderEndpoint": ...,
}
parent.create_host(**kwargs)
delete_connection
The connection to be deleted.
Type annotations and code completion for boto3.client("codestar-connections").delete_connection
method.
boto3 documentation
kwargs: DeleteConnectionInputRequestTypeDef = { # (1)
"ConnectionArn": ...,
}
parent.delete_connection(**kwargs)
delete_host
The host to be deleted.
Type annotations and code completion for boto3.client("codestar-connections").delete_host
method.
boto3 documentation
kwargs: DeleteHostInputRequestTypeDef = { # (1)
"HostArn": ...,
}
parent.delete_host(**kwargs)
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
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
def get_connection(
self,
*,
ConnectionArn: str,
) -> GetConnectionOutputTypeDef: # (1)
...
kwargs: GetConnectionInputRequestTypeDef = { # (1)
"ConnectionArn": ...,
}
parent.get_connection(**kwargs)
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
kwargs: GetHostInputRequestTypeDef = { # (1)
"HostArn": ...,
}
parent.get_host(**kwargs)
list_connections
Lists the connections associated with your account.
Type annotations and code completion for boto3.client("codestar-connections").list_connections
method.
boto3 documentation
def list_connections(
self,
*,
ProviderTypeFilter: ProviderTypeType = ..., # (1)
HostArnFilter: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListConnectionsOutputTypeDef: # (2)
...
kwargs: ListConnectionsInputRequestTypeDef = { # (1)
"ProviderTypeFilter": ...,
}
parent.list_connections(**kwargs)
list_hosts
Lists the hosts associated with your account.
Type annotations and code completion for boto3.client("codestar-connections").list_hosts
method.
boto3 documentation
def list_hosts(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListHostsOutputTypeDef: # (1)
...
kwargs: ListHostsInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_hosts(**kwargs)
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
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes tags from an AWS resource.
Type annotations and code completion for boto3.client("codestar-connections").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
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
def update_host(
self,
*,
HostArn: str,
ProviderEndpoint: str = ...,
VpcConfiguration: VpcConfigurationTypeDef = ..., # (1)
) -> Dict[str, Any]:
...