CodeStarClient

Index > CodeStar > CodeStarClient

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

CodeStarClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_codestar.client import CodeStarClient

session = Session()
async with session.client("codestar") as client:
    client: CodeStarClient

Exceptions

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

Usage example

async with session.client("codestar") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.ConcurrentModificationException,
        client.InvalidNextTokenException,
        client.InvalidServiceRoleException,
        client.LimitExceededException,
        client.ProjectAlreadyExistsException,
        client.ProjectConfigurationException,
        client.ProjectCreationFailedException,
        client.ProjectNotFoundException,
        client.TeamMemberAlreadyAssociatedException,
        client.TeamMemberNotFoundException,
        client.UserProfileAlreadyExistsException,
        client.UserProfileNotFoundException,
        client.ValidationException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_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 session.client("codestar").associate_team_member method. boto3 documentation

Method definition

await def associate_team_member(
    self,
    *,
    projectId: str,
    userArn: str,
    projectRole: str,
    clientRequestToken: str = ...,
    remoteAccessAllowed: bool = ...,
) -> AssociateTeamMemberResultTypeDef:  # (1)
    ...

1. See AssociateTeamMemberResultTypeDef

Usage example with kwargs

kwargs: AssociateTeamMemberRequestRequestTypeDef = {  # (1)
    "projectId": ...,
    "userArn": ...,
    "projectRole": ...,
}

parent.associate_team_member(**kwargs)

1. See AssociateTeamMemberRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for session.client("codestar").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").close method. boto3 documentation

Method definition

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

create_project

Creates a project, including project resources.

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

Method definition

await 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)
    ...

1. See CodeTypeDef
2. See ToolchainTypeDef
3. See CreateProjectResultTypeDef

Usage example with kwargs

kwargs: CreateProjectRequestRequestTypeDef = {  # (1)
    "name": ...,
    "id": ...,
}

parent.create_project(**kwargs)

1. See CreateProjectRequestRequestTypeDef

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

Method definition

await def create_user_profile(
    self,
    *,
    userArn: str,
    displayName: str,
    emailAddress: str,
    sshPublicKey: str = ...,
) -> CreateUserProfileResultTypeDef:  # (1)
    ...

1. See CreateUserProfileResultTypeDef

Usage example with kwargs

kwargs: CreateUserProfileRequestRequestTypeDef = {  # (1)
    "userArn": ...,
    "displayName": ...,
    "emailAddress": ...,
}

parent.create_user_profile(**kwargs)

1. See CreateUserProfileRequestRequestTypeDef

delete_project

Deletes a project, including project resources.

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

Method definition

await def delete_project(
    self,
    *,
    id: str,
    clientRequestToken: str = ...,
    deleteStack: bool = ...,
) -> DeleteProjectResultTypeDef:  # (1)
    ...

1. See DeleteProjectResultTypeDef

Usage example with kwargs

kwargs: DeleteProjectRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_project(**kwargs)

1. See DeleteProjectRequestRequestTypeDef

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

Method definition

await def delete_user_profile(
    self,
    *,
    userArn: str,
) -> DeleteUserProfileResultTypeDef:  # (1)
    ...

1. See DeleteUserProfileResultTypeDef

Usage example with kwargs

kwargs: DeleteUserProfileRequestRequestTypeDef = {  # (1)
    "userArn": ...,
}

parent.delete_user_profile(**kwargs)

1. See DeleteUserProfileRequestRequestTypeDef

describe_project

Describes a project and its resources.

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

Method definition

await def describe_project(
    self,
    *,
    id: str,
) -> DescribeProjectResultTypeDef:  # (1)
    ...

1. See DescribeProjectResultTypeDef

Usage example with kwargs

kwargs: DescribeProjectRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.describe_project(**kwargs)

1. See DescribeProjectRequestRequestTypeDef

describe_user_profile

Describes a user in AWS CodeStar and the user attributes across all projects.

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

Method definition

await def describe_user_profile(
    self,
    *,
    userArn: str,
) -> DescribeUserProfileResultTypeDef:  # (1)
    ...

1. See DescribeUserProfileResultTypeDef

Usage example with kwargs

kwargs: DescribeUserProfileRequestRequestTypeDef = {  # (1)
    "userArn": ...,
}

parent.describe_user_profile(**kwargs)

1. See DescribeUserProfileRequestRequestTypeDef

disassociate_team_member

Removes a user from a project.

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

Method definition

await def disassociate_team_member(
    self,
    *,
    projectId: str,
    userArn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DisassociateTeamMemberRequestRequestTypeDef = {  # (1)
    "projectId": ...,
    "userArn": ...,
}

parent.disassociate_team_member(**kwargs)

1. See DisassociateTeamMemberRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for session.client("codestar").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:
    ...

list_projects

Lists all projects in AWS CodeStar associated with your AWS account.

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

Method definition

await def list_projects(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListProjectsResultTypeDef:  # (1)
    ...

1. See ListProjectsResultTypeDef

Usage example with kwargs

kwargs: ListProjectsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_projects(**kwargs)

1. See ListProjectsRequestRequestTypeDef

list_resources

Lists resources associated with a project in AWS CodeStar.

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

Method definition

await def list_resources(
    self,
    *,
    projectId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListResourcesResultTypeDef:  # (1)
    ...

1. See ListResourcesResultTypeDef

Usage example with kwargs

kwargs: ListResourcesRequestRequestTypeDef = {  # (1)
    "projectId": ...,
}

parent.list_resources(**kwargs)

1. See ListResourcesRequestRequestTypeDef

list_tags_for_project

Gets the tags for a project.

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

Method definition

await def list_tags_for_project(
    self,
    *,
    id: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTagsForProjectResultTypeDef:  # (1)
    ...

1. See ListTagsForProjectResultTypeDef

Usage example with kwargs

kwargs: ListTagsForProjectRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.list_tags_for_project(**kwargs)

1. See ListTagsForProjectRequestRequestTypeDef

list_team_members

Lists all team members associated with a project.

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

Method definition

await def list_team_members(
    self,
    *,
    projectId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTeamMembersResultTypeDef:  # (1)
    ...

1. See ListTeamMembersResultTypeDef

Usage example with kwargs

kwargs: ListTeamMembersRequestRequestTypeDef = {  # (1)
    "projectId": ...,
}

parent.list_team_members(**kwargs)

1. See ListTeamMembersRequestRequestTypeDef

list_user_profiles

Lists all the user profiles configured for your AWS account in AWS CodeStar.

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

Method definition

await def list_user_profiles(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListUserProfilesResultTypeDef:  # (1)
    ...

1. See ListUserProfilesResultTypeDef

Usage example with kwargs

kwargs: ListUserProfilesRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_user_profiles(**kwargs)

1. See ListUserProfilesRequestRequestTypeDef

tag_project

Adds tags to a project.

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

Method definition

await def tag_project(
    self,
    *,
    id: str,
    tags: Mapping[str, str],
) -> TagProjectResultTypeDef:  # (1)
    ...

1. See TagProjectResultTypeDef

Usage example with kwargs

kwargs: TagProjectRequestRequestTypeDef = {  # (1)
    "id": ...,
    "tags": ...,
}

parent.tag_project(**kwargs)

1. See TagProjectRequestRequestTypeDef

untag_project

Removes tags from a project.

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

Method definition

await def untag_project(
    self,
    *,
    id: str,
    tags: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagProjectRequestRequestTypeDef = {  # (1)
    "id": ...,
    "tags": ...,
}

parent.untag_project(**kwargs)

1. See UntagProjectRequestRequestTypeDef

update_project

Updates a project in AWS CodeStar.

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

Method definition

await def update_project(
    self,
    *,
    id: str,
    name: str = ...,
    description: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateProjectRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.update_project(**kwargs)

1. See UpdateProjectRequestRequestTypeDef

update_team_member

Updates a team member's attributes in an AWS CodeStar project.

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

Method definition

await def update_team_member(
    self,
    *,
    projectId: str,
    userArn: str,
    projectRole: str = ...,
    remoteAccessAllowed: bool = ...,
) -> UpdateTeamMemberResultTypeDef:  # (1)
    ...

1. See UpdateTeamMemberResultTypeDef

Usage example with kwargs

kwargs: UpdateTeamMemberRequestRequestTypeDef = {  # (1)
    "projectId": ...,
    "userArn": ...,
}

parent.update_team_member(**kwargs)

1. See UpdateTeamMemberRequestRequestTypeDef

update_user_profile

Updates a user's profile in AWS CodeStar.

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

Method definition

await def update_user_profile(
    self,
    *,
    userArn: str,
    displayName: str = ...,
    emailAddress: str = ...,
    sshPublicKey: str = ...,
) -> UpdateUserProfileResultTypeDef:  # (1)
    ...

1. See UpdateUserProfileResultTypeDef

Usage example with kwargs

kwargs: UpdateUserProfileRequestRequestTypeDef = {  # (1)
    "userArn": ...,
}

parent.update_user_profile(**kwargs)

1. See UpdateUserProfileRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> CodeStarClient:
    ...

__aexit__

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

Method definition

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

get_paginator

Type annotations and code completion for session.client("codestar").get_paginator method with overloads.

• client.get_paginator("list_projects") -> ListProjectsPaginator
• client.get_paginator("list_resources") -> ListResourcesPaginator
• client.get_paginator("list_team_members") -> ListTeamMembersPaginator
• client.get_paginator("list_user_profiles") -> ListUserProfilesPaginator