CodeStarClient#
Auto-generated documentation for CodeStar type annotations stubs module mypy-boto3-codestar.
CodeStarClient#
Type annotations and code completion for boto3.client("codestar").
boto3 documentation
# CodeStarClient usage example
from boto3.session import Session
from mypy_boto3_codestar.client import CodeStarClient
def get_codestar_client() -> CodeStarClient:
return Session().client("codestar")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("codestar").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("codestar")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.ConcurrentModificationException,
client.exceptions.InvalidNextTokenException,
client.exceptions.InvalidServiceRoleException,
client.exceptions.LimitExceededException,
client.exceptions.ProjectAlreadyExistsException,
client.exceptions.ProjectConfigurationException,
client.exceptions.ProjectCreationFailedException,
client.exceptions.ProjectNotFoundException,
client.exceptions.TeamMemberAlreadyAssociatedException,
client.exceptions.TeamMemberNotFoundException,
client.exceptions.UserProfileAlreadyExistsException,
client.exceptions.UserProfileNotFoundException,
client.exceptions.ValidationException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_codestar.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...Methods#
associate_team_member#
Adds an IAM user to the team for an AWS CodeStar project.
Type annotations and code completion for boto3.client("codestar").associate_team_member method.
boto3 documentation
# associate_team_member method definition
def associate_team_member(
self,
*,
projectId: str,
userArn: str,
projectRole: str,
clientRequestToken: str = ...,
remoteAccessAllowed: bool = ...,
) -> AssociateTeamMemberResultTypeDef: # (1)
...# associate_team_member method usage example with argument unpacking
kwargs: AssociateTeamMemberRequestRequestTypeDef = { # (1)
"projectId": ...,
"userArn": ...,
"projectRole": ...,
}
parent.associate_team_member(**kwargs)can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("codestar").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").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...create_project#
Creates a project, including project resources.
Type annotations and code completion for boto3.client("codestar").create_project method.
boto3 documentation
# create_project method definition
def create_project(
self,
*,
name: str,
id: str,
description: str = ...,
clientRequestToken: str = ...,
sourceCode: Sequence[CodeTypeDef] = ..., # (1)
toolchain: ToolchainTypeDef = ..., # (2)
tags: Mapping[str, str] = ...,
) -> CreateProjectResultTypeDef: # (3)
...- See CodeTypeDef
- See ToolchainTypeDef
- See CreateProjectResultTypeDef
# create_project method usage example with argument unpacking
kwargs: CreateProjectRequestRequestTypeDef = { # (1)
"name": ...,
"id": ...,
}
parent.create_project(**kwargs)create_user_profile#
Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar.
Type annotations and code completion for boto3.client("codestar").create_user_profile method.
boto3 documentation
# create_user_profile method definition
def create_user_profile(
self,
*,
userArn: str,
displayName: str,
emailAddress: str,
sshPublicKey: str = ...,
) -> CreateUserProfileResultTypeDef: # (1)
...# create_user_profile method usage example with argument unpacking
kwargs: CreateUserProfileRequestRequestTypeDef = { # (1)
"userArn": ...,
"displayName": ...,
"emailAddress": ...,
}
parent.create_user_profile(**kwargs)delete_project#
Deletes a project, including project resources.
Type annotations and code completion for boto3.client("codestar").delete_project method.
boto3 documentation
# delete_project method definition
def delete_project(
self,
*,
id: str,
clientRequestToken: str = ...,
deleteStack: bool = ...,
) -> DeleteProjectResultTypeDef: # (1)
...# delete_project method usage example with argument unpacking
kwargs: DeleteProjectRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_project(**kwargs)delete_user_profile#
Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address.
Type annotations and code completion for boto3.client("codestar").delete_user_profile method.
boto3 documentation
# delete_user_profile method definition
def delete_user_profile(
self,
*,
userArn: str,
) -> DeleteUserProfileResultTypeDef: # (1)
...# delete_user_profile method usage example with argument unpacking
kwargs: DeleteUserProfileRequestRequestTypeDef = { # (1)
"userArn": ...,
}
parent.delete_user_profile(**kwargs)describe_project#
Describes a project and its resources.
Type annotations and code completion for boto3.client("codestar").describe_project method.
boto3 documentation
# describe_project method definition
def describe_project(
self,
*,
id: str,
) -> DescribeProjectResultTypeDef: # (1)
...# describe_project method usage example with argument unpacking
kwargs: DescribeProjectRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.describe_project(**kwargs)describe_user_profile#
Describes a user in AWS CodeStar and the user attributes across all projects.
Type annotations and code completion for boto3.client("codestar").describe_user_profile method.
boto3 documentation
# describe_user_profile method definition
def describe_user_profile(
self,
*,
userArn: str,
) -> DescribeUserProfileResultTypeDef: # (1)
...# describe_user_profile method usage example with argument unpacking
kwargs: DescribeUserProfileRequestRequestTypeDef = { # (1)
"userArn": ...,
}
parent.describe_user_profile(**kwargs)disassociate_team_member#
Removes a user from a project.
Type annotations and code completion for boto3.client("codestar").disassociate_team_member method.
boto3 documentation
# disassociate_team_member method definition
def disassociate_team_member(
self,
*,
projectId: str,
userArn: str,
) -> Dict[str, Any]:
...# disassociate_team_member method usage example with argument unpacking
kwargs: DisassociateTeamMemberRequestRequestTypeDef = { # (1)
"projectId": ...,
"userArn": ...,
}
parent.disassociate_team_member(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("codestar").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:
...list_projects#
Lists all projects in AWS CodeStar associated with your AWS account.
Type annotations and code completion for boto3.client("codestar").list_projects method.
boto3 documentation
# list_projects method definition
def list_projects(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListProjectsResultTypeDef: # (1)
...# list_projects method usage example with argument unpacking
kwargs: ListProjectsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_projects(**kwargs)list_resources#
Lists resources associated with a project in AWS CodeStar.
Type annotations and code completion for boto3.client("codestar").list_resources method.
boto3 documentation
# list_resources method definition
def list_resources(
self,
*,
projectId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListResourcesResultTypeDef: # (1)
...# list_resources method usage example with argument unpacking
kwargs: ListResourcesRequestRequestTypeDef = { # (1)
"projectId": ...,
}
parent.list_resources(**kwargs)list_tags_for_project#
Gets the tags for a project.
Type annotations and code completion for boto3.client("codestar").list_tags_for_project method.
boto3 documentation
# list_tags_for_project method definition
def list_tags_for_project(
self,
*,
id: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListTagsForProjectResultTypeDef: # (1)
...# list_tags_for_project method usage example with argument unpacking
kwargs: ListTagsForProjectRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.list_tags_for_project(**kwargs)list_team_members#
Lists all team members associated with a project.
Type annotations and code completion for boto3.client("codestar").list_team_members method.
boto3 documentation
# list_team_members method definition
def list_team_members(
self,
*,
projectId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListTeamMembersResultTypeDef: # (1)
...# list_team_members method usage example with argument unpacking
kwargs: ListTeamMembersRequestRequestTypeDef = { # (1)
"projectId": ...,
}
parent.list_team_members(**kwargs)list_user_profiles#
Lists all the user profiles configured for your AWS account in AWS CodeStar.
Type annotations and code completion for boto3.client("codestar").list_user_profiles method.
boto3 documentation
# list_user_profiles method definition
def list_user_profiles(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListUserProfilesResultTypeDef: # (1)
...# list_user_profiles method usage example with argument unpacking
kwargs: ListUserProfilesRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_user_profiles(**kwargs)tag_project#
Adds tags to a project.
Type annotations and code completion for boto3.client("codestar").tag_project method.
boto3 documentation
# tag_project method definition
def tag_project(
self,
*,
id: str,
tags: Mapping[str, str],
) -> TagProjectResultTypeDef: # (1)
...# tag_project method usage example with argument unpacking
kwargs: TagProjectRequestRequestTypeDef = { # (1)
"id": ...,
"tags": ...,
}
parent.tag_project(**kwargs)untag_project#
Removes tags from a project.
Type annotations and code completion for boto3.client("codestar").untag_project method.
boto3 documentation
# untag_project method definition
def untag_project(
self,
*,
id: str,
tags: Sequence[str],
) -> Dict[str, Any]:
...# untag_project method usage example with argument unpacking
kwargs: UntagProjectRequestRequestTypeDef = { # (1)
"id": ...,
"tags": ...,
}
parent.untag_project(**kwargs)update_project#
Updates a project in AWS CodeStar.
Type annotations and code completion for boto3.client("codestar").update_project method.