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)
...
- See ProviderTypeType
- See TagTypeDef
- See CreateConnectionOutputTypeDef
# create_connection method usage example with argument unpacking
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
# create_host method definition
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
# create_host method usage example with argument unpacking
kwargs: CreateHostInputRequestTypeDef = { # (1)
"Name": ...,
"ProviderType": ...,
"ProviderEndpoint": ...,
}
parent.create_host(**kwargs)
create_repository_link#
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)
...
# create_repository_link method usage example with argument unpacking
kwargs: CreateRepositoryLinkInputRequestTypeDef = { # (1)
"ConnectionArn": ...,
"OwnerId": ...,
"RepositoryName": ...,
}
parent.create_repository_link(**kwargs)
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)
) -> CreateSyncConfigurationOutputTypeDef: # (2)
...
# create_sync_configuration method usage example with argument unpacking
kwargs: CreateSyncConfigurationInputRequestTypeDef = { # (1)
"Branch": ...,
"ConfigFile": ...,
"RepositoryLinkId": ...,
"ResourceName": ...,
"RoleArn": ...,
"SyncType": ...,
}
parent.create_sync_configuration(**kwargs)
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)
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)
delete_repository_link#
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)
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]:
...
# delete_sync_configuration method usage example with argument unpacking
kwargs: DeleteSyncConfigurationInputRequestTypeDef = { # (1)
"SyncType": ...,
"ResourceName": ...,
}
parent.delete_sync_configuration(**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
# 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)
...
# get_connection method usage example with argument unpacking
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
# get_host method definition
def get_host(
self,
*,
HostArn: str,
) -> GetHostOutputTypeDef: # (1)
...
# get_host method usage example with argument unpacking
kwargs: GetHostInputRequestTypeDef = { # (1)
"HostArn": ...,
}
parent.get_host(**kwargs)
get_repository_link#
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)
...
# get_repository_link method usage example with argument unpacking
kwargs: GetRepositoryLinkInputRequestTypeDef = { # (1)
"RepositoryLinkId": ...,
}
parent.get_repository_link(**kwargs)
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)
...
# get_repository_sync_status method usage example with argument unpacking
kwargs: GetRepositorySyncStatusInputRequestTypeDef = { # (1)
"Branch": ...,
"RepositoryLinkId": ...,
"SyncType": ...,
}
parent.get_repository_sync_status(**kwargs)
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)
...
# get_resource_sync_status method usage example with argument unpacking
kwargs: GetResourceSyncStatusInputRequestTypeDef = { # (1)
"ResourceName": ...,
"SyncType": ...,
}
parent.get_resource_sync_status(**kwargs)
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)
...
# get_sync_blocker_summary method usage example with argument unpacking
kwargs: GetSyncBlockerSummaryInputRequestTypeDef = { # (1)
"SyncType": ...,
"ResourceName": ...,
}
parent.get_sync_blocker_summary(**kwargs)
- S