com.amazonaws.services.codestar

Class AWSCodeStarClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.codestar.AWSCodeStarClient

All Implemented Interfaces:

AWSCodeStar

Direct Known Subclasses:

AWSCodeStarAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSCodeStarClient
extends AmazonWebServiceClient
implements AWSCodeStar

Client for accessing CodeStar. All service calls made using this client are blocking, and will not return until the service call completes.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.codestar.AWSCodeStar

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateTeamMemberResult	associateTeamMember(AssociateTeamMemberRequest request) Adds an IAM user to the team for an AWS CodeStar project.
static AWSCodeStarClientBuilder	builder()
CreateProjectResult	createProject(CreateProjectRequest request) Creates a project, including project resources.
CreateUserProfileResult	createUserProfile(CreateUserProfileRequest request) 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 request) Deletes a project, including project resources.
DeleteUserProfileResult	deleteUserProfile(DeleteUserProfileRequest request) 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 request) Describes a project and its resources.
DescribeUserProfileResult	describeUserProfile(DescribeUserProfileRequest request) Describes a user in AWS CodeStar and the user attributes across all projects.
DisassociateTeamMemberResult	disassociateTeamMember(DisassociateTeamMemberRequest request) 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 request) Lists all projects in AWS CodeStar associated with your AWS account.
ListResourcesResult	listResources(ListResourcesRequest request) Lists resources associated with a project in AWS CodeStar.
ListTagsForProjectResult	listTagsForProject(ListTagsForProjectRequest request) Gets the tags for a project.
ListTeamMembersResult	listTeamMembers(ListTeamMembersRequest request) Lists all team members associated with a project.
ListUserProfilesResult	listUserProfiles(ListUserProfilesRequest request) 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 request) Adds tags to a project.
UntagProjectResult	untagProject(UntagProjectRequest request) Removes tags from a project.
UpdateProjectResult	updateProject(UpdateProjectRequest request) Updates a project in AWS CodeStar.
UpdateTeamMemberResult	updateTeamMember(UpdateTeamMemberRequest request) Updates a team member's attributes in an AWS CodeStar project.
UpdateUserProfileResult	updateUserProfile(UpdateUserProfileRequest request) Updates a user's profile in AWS CodeStar.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSCodeStarClientBuilder builder()

associateTeamMember

public AssociateTeamMemberResult associateTeamMember(AssociateTeamMemberRequest request)

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

Specified by:

associateTeamMember in interface AWSCodeStar

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

public CreateProjectResult createProject(CreateProjectRequest request)

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.

Specified by:

createProject in interface AWSCodeStar

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

public CreateUserProfileResult createUserProfile(CreateUserProfileRequest request)

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.

Specified by:

createUserProfile in interface AWSCodeStar

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

public DeleteProjectResult deleteProject(DeleteProjectRequest request)

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.

Specified by:

deleteProject in interface AWSCodeStar

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

public DeleteUserProfileResult deleteUserProfile(DeleteUserProfileRequest request)

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.

Specified by:

deleteUserProfile in interface AWSCodeStar

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

public DescribeProjectResult describeProject(DescribeProjectRequest request)

Describes a project and its resources.

Specified by:

describeProject in interface AWSCodeStar

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

public DescribeUserProfileResult describeUserProfile(DescribeUserProfileRequest request)

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

Specified by:

describeUserProfile in interface AWSCodeStar

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

public DisassociateTeamMemberResult disassociateTeamMember(DisassociateTeamMemberRequest request)

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.

Specified by:

disassociateTeamMember in interface AWSCodeStar

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

public ListProjectsResult listProjects(ListProjectsRequest request)

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

Specified by:

listProjects in interface AWSCodeStar

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

public ListResourcesResult listResources(ListResourcesRequest request)

Lists resources associated with a project in AWS CodeStar.

Specified by:

listResources in interface AWSCodeStar

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

public ListTagsForProjectResult listTagsForProject(ListTagsForProjectRequest request)

Gets the tags for a project.

Specified by:

listTagsForProject in interface AWSCodeStar

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

public ListTeamMembersResult listTeamMembers(ListTeamMembersRequest request)

Lists all team members associated with a project.

Specified by:

listTeamMembers in interface AWSCodeStar

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

public ListUserProfilesResult listUserProfiles(ListUserProfilesRequest request)

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

Specified by:

listUserProfiles in interface AWSCodeStar

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

public TagProjectResult tagProject(TagProjectRequest request)

Adds tags to a project.

Specified by:

tagProject in interface AWSCodeStar

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

public UntagProjectResult untagProject(UntagProjectRequest request)

Removes tags from a project.

Specified by:

untagProject in interface AWSCodeStar

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

public UpdateProjectResult updateProject(UpdateProjectRequest request)

Updates a project in AWS CodeStar.

Specified by:

updateProject in interface AWSCodeStar

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

public UpdateTeamMemberResult updateTeamMember(UpdateTeamMemberRequest request)

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.

Specified by:

updateTeamMember in interface AWSCodeStar

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

public UpdateUserProfileResult updateUserProfile(UpdateUserProfileRequest request)

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.

Specified by:

updateUserProfile in interface AWSCodeStar

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSCodeStar

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from interface: AWSCodeStar

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.

Specified by:

shutdown in interface AWSCodeStar

Overrides:

shutdown in class AmazonWebServiceClient