Package software.amazon.awssdk.services.codestar

Interface CodeStarClient

All Superinterfaces:

AutoCloseable

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

Service client for accessing CodeStar. 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.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

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

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static CodeStarClient create()

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

builder

static CodeStarClientBuilder builder()

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

associateTeamMember

default AssociateTeamMemberResponse associateTeamMember(AssociateTeamMemberRequest associateTeamMemberRequest)
                                                 throws LimitExceededException,
                                                        ProjectNotFoundException,
                                                        TeamMemberAlreadyAssociatedException,
                                                        ValidationException,
                                                        InvalidServiceRoleException,
                                                        ProjectConfigurationException,
                                                        ConcurrentModificationException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        CodeStarException

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

Parameters:

associateTeamMemberRequest -

Returns:

Result of the AssociateTeamMember operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createProject

default CreateProjectResponse createProject(CreateProjectRequest createProjectRequest)
                                     throws ProjectAlreadyExistsException,
                                            LimitExceededException,
                                            ValidationException,
                                            ProjectCreationFailedException,
                                            InvalidServiceRoleException,
                                            ProjectConfigurationException,
                                            ConcurrentModificationException,
                                            SdkBaseException,
                                            SdkClientException,
                                            CodeStarException

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

Parameters:

createProjectRequest -

Returns:

Result of the CreateProject operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createUserProfile

default CreateUserProfileResponse createUserProfile(CreateUserProfileRequest createUserProfileRequest)
                                             throws UserProfileAlreadyExistsException,
                                                    ValidationException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    CodeStarException

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:

Result of the CreateUserProfile operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteProject

default DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest)
                                     throws ConcurrentModificationException,
                                            ValidationException,
                                            InvalidServiceRoleException,
                                            SdkBaseException,
                                            SdkClientException,
                                            CodeStarException

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:

Result of the DeleteProject operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteUserProfile

default DeleteUserProfileResponse deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)
                                             throws ValidationException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    CodeStarException

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:

Result of the DeleteUserProfile operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeProject

default DescribeProjectResponse describeProject(DescribeProjectRequest describeProjectRequest)
                                         throws ProjectNotFoundException,
                                                ValidationException,
                                                InvalidServiceRoleException,
                                                ProjectConfigurationException,
                                                ConcurrentModificationException,
                                                SdkBaseException,
                                                SdkClientException,
                                                CodeStarException

Describes a project and its resources.

Parameters:

describeProjectRequest -

Returns:

Result of the DescribeProject operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeUserProfile

default DescribeUserProfileResponse describeUserProfile(DescribeUserProfileRequest describeUserProfileRequest)
                                                 throws UserProfileNotFoundException,
                                                        ValidationException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        CodeStarException

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

Parameters:

describeUserProfileRequest -

Returns:

Result of the DescribeUserProfile operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

disassociateTeamMember

default DisassociateTeamMemberResponse disassociateTeamMember(DisassociateTeamMemberRequest disassociateTeamMemberRequest)
                                                       throws ProjectNotFoundException,
                                                              ValidationException,
                                                              InvalidServiceRoleException,
                                                              ConcurrentModificationException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              CodeStarException

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:

Result of the DisassociateTeamMember operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listProjects

default ListProjectsResponse listProjects(ListProjectsRequest listProjectsRequest)
                                   throws InvalidNextTokenException,
                                          ValidationException,
                                          SdkBaseException,
                                          SdkClientException,
                                          CodeStarException

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

Parameters:

listProjectsRequest -

Returns:

Result of the ListProjects operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listResources

default ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest)
                                     throws ProjectNotFoundException,
                                            InvalidNextTokenException,
                                            ValidationException,
                                            SdkBaseException,
                                            SdkClientException,
                                            CodeStarException

Lists resources associated with a project in AWS CodeStar.

Parameters:

listResourcesRequest -

Returns:

Result of the ListResources operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listTeamMembers

default ListTeamMembersResponse listTeamMembers(ListTeamMembersRequest listTeamMembersRequest)
                                         throws ProjectNotFoundException,
                                                InvalidNextTokenException,
                                                ValidationException,
                                                SdkBaseException,
                                                SdkClientException,
                                                CodeStarException

Lists all team members associated with a project.

Parameters:

listTeamMembersRequest -

Returns:

Result of the ListTeamMembers operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listUserProfiles

default ListUserProfilesResponse listUserProfiles(ListUserProfilesRequest listUserProfilesRequest)
                                           throws InvalidNextTokenException,
                                                  ValidationException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  CodeStarException

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

Parameters:

listUserProfilesRequest -

Returns:

Result of the ListUserProfiles operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateProject

default UpdateProjectResponse updateProject(UpdateProjectRequest updateProjectRequest)
                                     throws ProjectNotFoundException,
                                            ValidationException,
                                            SdkBaseException,
                                            SdkClientException,
                                            CodeStarException

Updates a project in AWS CodeStar.

Parameters:

updateProjectRequest -

Returns:

Result of the UpdateProject operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateTeamMember

default UpdateTeamMemberResponse updateTeamMember(UpdateTeamMemberRequest updateTeamMemberRequest)
                                           throws LimitExceededException,
                                                  ProjectNotFoundException,
                                                  ValidationException,
                                                  InvalidServiceRoleException,
                                                  ProjectConfigurationException,
                                                  ConcurrentModificationException,
                                                  TeamMemberNotFoundException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  CodeStarException

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:

Result of the UpdateTeamMember operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateUserProfile

default UpdateUserProfileResponse updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)
                                             throws UserProfileNotFoundException,
                                                    ValidationException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    CodeStarException

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:

Result of the UpdateUserProfile operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()