com.amazonaws.services.codestar

Interface AWSCodeStar

All Known Subinterfaces:

AWSCodeStarAsync

All Known Implementing Classes:

AbstractAWSCodeStar, AbstractAWSCodeStarAsync, AWSCodeStarAsyncClient, AWSCodeStarClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCodeStar

Interface for accessing CodeStar.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCodeStar instead.

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.

• DescribeProject, which lists the attributes of a project.

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

• ListResources, which lists the resources associated with a project.

• ListTagsForProject, which lists the tags associated with a project.

• TagProject, which adds tags to a project.

• UntagProject, which removes tags from a project.

• UpdateProject, which updates the attributes of a project.

Teams and team members, by calling the following:

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

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

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

• UpdateTeamMember, which updates a team member's attributes in a project.

Users, by calling the following:

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

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

• DescribeUserProfile, which describes the profile of a user.

• ListUserProfiles, which lists all user profiles.

• UpdateUserProfile, which updates the profile for a user.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateTeamMemberResult	associateTeamMember(AssociateTeamMemberRequest associateTeamMemberRequest) Adds an IAM user to the team for an AWS CodeStar project.
CreateProjectResult	createProject(CreateProjectRequest createProjectRequest) Creates a project, including project resources.
CreateUserProfileResult	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.
DeleteProjectResult	deleteProject(DeleteProjectRequest deleteProjectRequest) Deletes a project, including project resources.
DeleteUserProfileResult	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.
DescribeProjectResult	describeProject(DescribeProjectRequest describeProjectRequest) Describes a project and its resources.
DescribeUserProfileResult	describeUserProfile(DescribeUserProfileRequest describeUserProfileRequest) Describes a user in AWS CodeStar and the user attributes across all projects.
DisassociateTeamMemberResult	disassociateTeamMember(DisassociateTeamMemberRequest disassociateTeamMemberRequest) Removes a user from a project.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ListProjectsResult	listProjects(ListProjectsRequest listProjectsRequest) Lists all projects in AWS CodeStar associated with your AWS account.
ListResourcesResult	listResources(ListResourcesRequest listResourcesRequest) Lists resources associated with a project in AWS CodeStar.
ListTagsForProjectResult	listTagsForProject(ListTagsForProjectRequest listTagsForProjectRequest) Gets the tags for a project.
ListTeamMembersResult	listTeamMembers(ListTeamMembersRequest listTeamMembersRequest) Lists all team members associated with a project.
ListUserProfilesResult	listUserProfiles(ListUserProfilesRequest listUserProfilesRequest) Lists all the user profiles configured for your AWS account in AWS CodeStar.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagProjectResult	tagProject(TagProjectRequest tagProjectRequest) Adds tags to a project.
UntagProjectResult	untagProject(UntagProjectRequest untagProjectRequest) Removes tags from a project.
UpdateProjectResult	updateProject(UpdateProjectRequest updateProjectRequest) Updates a project in AWS CodeStar.
UpdateTeamMemberResult	updateTeamMember(UpdateTeamMemberRequest updateTeamMemberRequest) Updates a team member's attributes in an AWS CodeStar project.
UpdateUserProfileResult	updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest) Updates a user's profile in AWS CodeStar.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateTeamMember

AssociateTeamMemberResult associateTeamMember(AssociateTeamMemberRequest associateTeamMemberRequest)

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.

See Also:

AWS API Documentation

createProject

CreateProjectResult createProject(CreateProjectRequest createProjectRequest)

Creates a project, including project resources. This action creates a project based on a submitted project request. A set of source code files and a toolchain template file can be included with the project request. If these are not provided, an empty project is created.

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.

See Also:

AWS API Documentation

createUserProfile

CreateUserProfileResult 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:

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.

See Also:

AWS API Documentation

deleteProject

DeleteProjectResult 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:

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.

See Also:

AWS API Documentation

deleteUserProfile

DeleteUserProfileResult 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:

Result of the DeleteUserProfile operation returned by the service.

Throws:

ValidationException - The specified input is either not valid, or it could not be validated.

See Also:

AWS API Documentation

describeProject

DescribeProjectResult describeProject(DescribeProjectRequest describeProjectRequest)

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.

See Also:

AWS API Documentation

describeUserProfile

DescribeUserProfileResult describeUserProfile(DescribeUserProfileRequest describeUserProfileRequest)

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.

See Also:

AWS API Documentation

disassociateTeamMember

DisassociateTeamMemberResult 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:

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.

See Also:

AWS API Documentation

listProjects

ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest)

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.

See Also:

AWS API Documentation

listResources

ListResourcesResult listResources(ListResourcesRequest listResourcesRequest)

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.

See Also:

AWS API Documentation

listTagsForProject

ListTagsForProjectResult listTagsForProject(ListTagsForProjectRequest listTagsForProjectRequest)

Gets the tags for a project.

Parameters:

listTagsForProjectRequest -

Returns:

Result of the ListTagsForProject 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.

InvalidNextTokenException - The next token is not valid.

See Also:

AWS API Documentation

listTeamMembers

ListTeamMembersResult listTeamMembers(ListTeamMembersRequest listTeamMembersRequest)

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.

See Also:

AWS API Documentation

listUserProfiles

ListUserProfilesResult listUserProfiles(ListUserProfilesRequest listUserProfilesRequest)

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.

See Also:

AWS API Documentation

tagProject

TagProjectResult tagProject(TagProjectRequest tagProjectRequest)

Adds tags to a project.

Parameters:

tagProjectRequest -

Returns:

Result of the TagProject 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.

LimitExceededException - A resource limit has been exceeded.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

See Also:

AWS API Documentation

untagProject

UntagProjectResult untagProject(UntagProjectRequest untagProjectRequest)

Removes tags from a project.

Parameters:

untagProjectRequest -

Returns:

Result of the UntagProject 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.

LimitExceededException - A resource limit has been exceeded.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

See Also:

AWS API Documentation

updateProject

UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest)

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.

See Also:

AWS API Documentation

updateTeamMember

UpdateTeamMemberResult 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:

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.

See Also:

AWS API Documentation

updateUserProfile

UpdateUserProfileResult 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:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.