Package software.amazon.awssdk.services.codestar

Interface CodeStarAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface CodeStarAsyncClient
extends AutoCloseable

Service client for accessing CodeStar asynchronously. This can be created using the static builder() method. AWS CodeStar

This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.

You can use the AWS CodeStar API to work with:

Projects and their resources, by calling the following:

• DeleteProject, which deletes a project in AWS CodeStar.

• DescribeProject, which lists the attributes of a project.

• ListProjects, which lists all AWS CodeStar projects associated with your AWS account.

• ListResources, which lists the resources associated with an AWS CodeStar project.

• UpdateProject, which updates the attributes of an AWS CodeStar project.

Teams and team members, by calling the following:

• AssociateTeamMember, which adds an IAM user to the team for an AWS CodeStar project.

• DisassociateTeamMember, which removes an IAM user from the team for an AWS CodeStar project.

• ListTeamMembers, which lists all the IAM users in the team for an AWS CodeStar project, including their roles and attributes.

Users, by calling the following:

• CreateUserProfile, which creates a user profile that contains data associated with the user across all AWS CodeStar projects.

• DeleteUserProfile, which deletes all user profile information across all AWS CodeStar projects.

• DescribeUserProfile, which describes the profile of a user.

• ListUserProfiles, which lists all AWS CodeStar user profiles.

• UpdateUserProfile, which updates the profile for an AWS CodeStar user.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AssociateTeamMemberResponse>	associateTeamMember(AssociateTeamMemberRequest associateTeamMemberRequest)	Adds an IAM user to the team for an AWS CodeStar project.
static CodeStarAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a CodeStarAsyncClient.
static CodeStarAsyncClient	create()	Create a CodeStarAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateProjectResponse>	createProject(CreateProjectRequest createProjectRequest)	Reserved for future use.
default CompletableFuture<CreateUserProfileResponse>	createUserProfile(CreateUserProfileRequest createUserProfileRequest)	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.
default CompletableFuture<DeleteProjectResponse>	deleteProject(DeleteProjectRequest deleteProjectRequest)	Deletes a project, including project resources.
default CompletableFuture<DeleteUserProfileResponse>	deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)	Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address.
default CompletableFuture<DescribeProjectResponse>	describeProject(DescribeProjectRequest describeProjectRequest)	Describes a project and its resources.
default CompletableFuture<DescribeUserProfileResponse>	describeUserProfile(DescribeUserProfileRequest describeUserProfileRequest)	Describes a user in AWS CodeStar and the user attributes across all projects.
default CompletableFuture<DisassociateTeamMemberResponse>	disassociateTeamMember(DisassociateTeamMemberRequest disassociateTeamMemberRequest)	Removes a user from a project.
default CompletableFuture<ListProjectsResponse>	listProjects(ListProjectsRequest listProjectsRequest)	Lists all projects in AWS CodeStar associated with your AWS account.
default CompletableFuture<ListResourcesResponse>	listResources(ListResourcesRequest listResourcesRequest)	Lists resources associated with a project in AWS CodeStar.
default CompletableFuture<ListTeamMembersResponse>	listTeamMembers(ListTeamMembersRequest listTeamMembersRequest)	Lists all team members associated with a project.
default CompletableFuture<ListUserProfilesResponse>	listUserProfiles(ListUserProfilesRequest listUserProfilesRequest)	Lists all the user profiles configured for your AWS account in AWS CodeStar.
default CompletableFuture<UpdateProjectResponse>	updateProject(UpdateProjectRequest updateProjectRequest)	Updates a project in AWS CodeStar.
default CompletableFuture<UpdateTeamMemberResponse>	updateTeamMember(UpdateTeamMemberRequest updateTeamMemberRequest)	Updates a team member's attributes in an AWS CodeStar project.
default CompletableFuture<UpdateUserProfileResponse>	updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)	Updates a user's profile in AWS CodeStar.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static CodeStarAsyncClient create()

Create a CodeStarAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CodeStarAsyncClientBuilder builder()

Create a builder that can be used to configure and create a CodeStarAsyncClient.

associateTeamMember

default CompletableFuture<AssociateTeamMemberResponse> associateTeamMember(AssociateTeamMemberRequest associateTeamMemberRequest)

Adds an IAM user to the team for an AWS CodeStar project.

Parameters:

associateTeamMemberRequest -

Returns:

A Java Future containing the result of the AssociateTeamMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException A resource limit has been exceeded.
• ProjectNotFoundException The specified AWS CodeStar project was not found.
• TeamMemberAlreadyAssociatedException The team member is already associated with a role in this project.
• ValidationException The specified input is either not valid, or it could not be validated.
• InvalidServiceRoleException The service role is not valid.
• ProjectConfigurationException Project configuration information is required but not specified.
• ConcurrentModificationException Another modification is being made. That modification must complete before you can make your change.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createProject

default CompletableFuture<CreateProjectResponse> createProject(CreateProjectRequest createProjectRequest)

Reserved for future use. To create a project, use the AWS CodeStar console.

Parameters:

createProjectRequest -

Returns:

A Java Future containing the result of the CreateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ProjectAlreadyExistsException An AWS CodeStar project with the same ID already exists in this region for the AWS account. AWS CodeStar project IDs must be unique within a region for the AWS account.
• LimitExceededException A resource limit has been exceeded.
• ValidationException The specified input is either not valid, or it could not be validated.
• ProjectCreationFailedException The project creation request was valid, but a nonspecific exception or error occurred during project creation. The project could not be created in AWS CodeStar.
• InvalidServiceRoleException The service role is not valid.
• ProjectConfigurationException Project configuration information is required but not specified.
• ConcurrentModificationException Another modification is being made. That modification must complete before you can make your change.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createUserProfile

default CompletableFuture<CreateUserProfileResponse> createUserProfile(CreateUserProfileRequest createUserProfileRequest)

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. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.

Parameters:

createUserProfileRequest -

Returns:

A Java Future containing the result of the CreateUserProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• UserProfileAlreadyExistsException A user profile with that name already exists in this region for the AWS account. AWS CodeStar user profile names must be unique within a region for the AWS account.
• ValidationException The specified input is either not valid, or it could not be validated.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteProject

default CompletableFuture<DeleteProjectResponse> deleteProject(DeleteProjectRequest deleteProjectRequest)

Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the project.

Parameters:

deleteProjectRequest -

Returns:

A Java Future containing the result of the DeleteProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ConcurrentModificationException Another modification is being made. That modification must complete before you can make your change.
• ValidationException The specified input is either not valid, or it could not be validated.
• InvalidServiceRoleException The service role is not valid.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteUserProfile

default CompletableFuture<DeleteUserProfileResponse> deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)

Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that user.

Parameters:

deleteUserProfileRequest -

Returns:

A Java Future containing the result of the DeleteUserProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ValidationException The specified input is either not valid, or it could not be validated.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeProject

default CompletableFuture<DescribeProjectResponse> describeProject(DescribeProjectRequest describeProjectRequest)

Describes a project and its resources.

Parameters:

describeProjectRequest -

Returns:

A Java Future containing the result of the DescribeProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ProjectNotFoundException The specified AWS CodeStar project was not found.
• ValidationException The specified input is either not valid, or it could not be validated.
• InvalidServiceRoleException The service role is not valid.
• ProjectConfigurationException Project configuration information is required but not specified.
• ConcurrentModificationException Another modification is being made. That modification must complete before you can make your change.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeUserProfile

default CompletableFuture<DescribeUserProfileResponse> describeUserProfile(DescribeUserProfileRequest describeUserProfileRequest)

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

Parameters:

describeUserProfileRequest -

Returns:

A Java Future containing the result of the DescribeUserProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• UserProfileNotFoundException The user profile was not found.
• ValidationException The specified input is either not valid, or it could not be validated.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

disassociateTeamMember

default CompletableFuture<DisassociateTeamMemberResponse> disassociateTeamMember(DisassociateTeamMemberRequest disassociateTeamMemberRequest)

Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user's profile from AWS CodeStar. It does not remove the user from IAM.

Parameters:

disassociateTeamMemberRequest -

Returns:

A Java Future containing the result of the DisassociateTeamMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ProjectNotFoundException The specified AWS CodeStar project was not found.
• ValidationException The specified input is either not valid, or it could not be validated.
• InvalidServiceRoleException The service role is not valid.
• ConcurrentModificationException Another modification is being made. That modification must complete before you can make your change.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listProjects

default CompletableFuture<ListProjectsResponse> listProjects(ListProjectsRequest listProjectsRequest)

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

Parameters:

listProjectsRequest -

Returns:

A Java Future containing the result of the ListProjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidNextTokenException The next token is not valid.
• ValidationException The specified input is either not valid, or it could not be validated.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listResources

default CompletableFuture<ListResourcesResponse> listResources(ListResourcesRequest listResourcesRequest)

Lists resources associated with a project in AWS CodeStar.

Parameters:

listResourcesRequest -

Returns:

A Java Future containing the result of the ListResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ProjectNotFoundException The specified AWS CodeStar project was not found.
• InvalidNextTokenException The next token is not valid.
• ValidationException The specified input is either not valid, or it could not be validated.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listTeamMembers

default CompletableFuture<ListTeamMembersResponse> listTeamMembers(ListTeamMembersRequest listTeamMembersRequest)

Lists all team members associated with a project.

Parameters:

listTeamMembersRequest -

Returns:

A Java Future containing the result of the ListTeamMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ProjectNotFoundException The specified AWS CodeStar project was not found.
• InvalidNextTokenException The next token is not valid.
• ValidationException The specified input is either not valid, or it could not be validated.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listUserProfiles

default CompletableFuture<ListUserProfilesResponse> listUserProfiles(ListUserProfilesRequest listUserProfilesRequest)

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

Parameters:

listUserProfilesRequest -

Returns:

A Java Future containing the result of the ListUserProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidNextTokenException The next token is not valid.
• ValidationException The specified input is either not valid, or it could not be validated.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateProject

default CompletableFuture<UpdateProjectResponse> updateProject(UpdateProjectRequest updateProjectRequest)

Updates a project in AWS CodeStar.

Parameters:

updateProjectRequest -

Returns:

A Java Future containing the result of the UpdateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ProjectNotFoundException The specified AWS CodeStar project was not found.
• ValidationException The specified input is either not valid, or it could not be validated.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateTeamMember

default CompletableFuture<UpdateTeamMemberResponse> updateTeamMember(UpdateTeamMemberRequest updateTeamMemberRequest)

Updates a team member's attributes in an AWS CodeStar project. For example, you can change a team member's role in the project, or change whether they have remote access to project resources.

Parameters:

updateTeamMemberRequest -

Returns:

A Java Future containing the result of the UpdateTeamMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException A resource limit has been exceeded.
• ProjectNotFoundException The specified AWS CodeStar project was not found.
• ValidationException The specified input is either not valid, or it could not be validated.
• InvalidServiceRoleException The service role is not valid.
• ProjectConfigurationException Project configuration information is required but not specified.
• ConcurrentModificationException Another modification is being made. That modification must complete before you can make your change.
• TeamMemberNotFoundException The specified team member was not found.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateUserProfile

default CompletableFuture<UpdateUserProfileResponse> updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)

Updates a user's profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.

Parameters:

updateUserProfileRequest -

Returns:

A Java Future containing the result of the UpdateUserProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• UserProfileNotFoundException The user profile was not found.
• ValidationException The specified input is either not valid, or it could not be validated.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeStarException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation