/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.codestar; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.codestar.model.*; /** * Interface for accessing CodeStar. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.codestar.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. *
*

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSCodeStar { /** * 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 RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "codestar"; /** *

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

* * @param associateTeamMemberRequest * @return Result of the AssociateTeamMember operation returned by the service. * @throws LimitExceededException * A resource limit has been exceeded. * @throws ProjectNotFoundException * The specified AWS CodeStar project was not found. * @throws TeamMemberAlreadyAssociatedException * The team member is already associated with a role in this project. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @throws InvalidServiceRoleException * The service role is not valid. * @throws ProjectConfigurationException * Project configuration information is required but not specified. * @throws ConcurrentModificationException * Another modification is being made. That modification must complete before you can make your change. * @sample AWSCodeStar.AssociateTeamMember * @see AWS * API Documentation */ AssociateTeamMemberResult associateTeamMember(AssociateTeamMemberRequest associateTeamMemberRequest); /** *

* 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. *

* * @param createProjectRequest * @return 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. * @throws LimitExceededException * A resource limit has been exceeded. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @throws 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. * @throws InvalidServiceRoleException * The service role is not valid. * @throws ProjectConfigurationException * Project configuration information is required but not specified. * @throws ConcurrentModificationException * Another modification is being made. That modification must complete before you can make your change. * @sample AWSCodeStar.CreateProject * @see AWS API * Documentation */ CreateProjectResult createProject(CreateProjectRequest createProjectRequest); /** *

* 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. *

* * @param createUserProfileRequest * @return 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. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @sample AWSCodeStar.CreateUserProfile * @see AWS API * Documentation */ CreateUserProfileResult createUserProfile(CreateUserProfileRequest createUserProfileRequest); /** *

* 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. *

* * @param deleteProjectRequest * @return 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. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @throws InvalidServiceRoleException * The service role is not valid. * @sample AWSCodeStar.DeleteProject * @see AWS API * Documentation */ DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest); /** *

* 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. *

* * @param deleteUserProfileRequest * @return Result of the DeleteUserProfile operation returned by the service. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @sample AWSCodeStar.DeleteUserProfile * @see AWS API * Documentation */ DeleteUserProfileResult deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest); /** *

* Describes a project and its resources. *

* * @param describeProjectRequest * @return Result of the DescribeProject operation returned by the service. * @throws ProjectNotFoundException * The specified AWS CodeStar project was not found. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @throws InvalidServiceRoleException * The service role is not valid. * @throws ProjectConfigurationException * Project configuration information is required but not specified. * @throws ConcurrentModificationException * Another modification is being made. That modification must complete before you can make your change. * @sample AWSCodeStar.DescribeProject * @see AWS API * Documentation */ DescribeProjectResult describeProject(DescribeProjectRequest describeProjectRequest); /** *

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

* * @param describeUserProfileRequest * @return Result of the DescribeUserProfile operation returned by the service. * @throws UserProfileNotFoundException * The user profile was not found. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @sample AWSCodeStar.DescribeUserProfile * @see AWS * API Documentation */ DescribeUserProfileResult describeUserProfile(DescribeUserProfileRequest describeUserProfileRequest); /** *

* 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. *

* * @param disassociateTeamMemberRequest * @return Result of the DisassociateTeamMember operation returned by the service. * @throws ProjectNotFoundException * The specified AWS CodeStar project was not found. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @throws InvalidServiceRoleException * The service role is not valid. * @throws ConcurrentModificationException * Another modification is being made. That modification must complete before you can make your change. * @sample AWSCodeStar.DisassociateTeamMember * @see AWS API Documentation */ DisassociateTeamMemberResult disassociateTeamMember(DisassociateTeamMemberRequest disassociateTeamMemberRequest); /** *

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

* * @param listProjectsRequest * @return Result of the ListProjects operation returned by the service. * @throws InvalidNextTokenException * The next token is not valid. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @sample AWSCodeStar.ListProjects * @see AWS API * Documentation */ ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest); /** *

* Lists resources associated with a project in AWS CodeStar. *

* * @param listResourcesRequest * @return Result of the ListResources operation returned by the service. * @throws ProjectNotFoundException * The specified AWS CodeStar project was not found. * @throws InvalidNextTokenException * The next token is not valid. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @sample AWSCodeStar.ListResources * @see AWS API * Documentation */ ListResourcesResult listResources(ListResourcesRequest listResourcesRequest); /** *

* Gets the tags for a project. *

* * @param listTagsForProjectRequest * @return Result of the ListTagsForProject operation returned by the service. * @throws ProjectNotFoundException * The specified AWS CodeStar project was not found. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @throws InvalidNextTokenException * The next token is not valid. * @sample AWSCodeStar.ListTagsForProject * @see AWS * API Documentation */ ListTagsForProjectResult listTagsForProject(ListTagsForProjectRequest listTagsForProjectRequest); /** *

* Lists all team members associated with a project. *

* * @param listTeamMembersRequest * @return Result of the ListTeamMembers operation returned by the service. * @throws ProjectNotFoundException * The specified AWS CodeStar project was not found. * @throws InvalidNextTokenException * The next token is not valid. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @sample AWSCodeStar.ListTeamMembers * @see AWS API * Documentation */ ListTeamMembersResult listTeamMembers(ListTeamMembersRequest listTeamMembersRequest); /** *

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

* * @param listUserProfilesRequest * @return Result of the ListUserProfiles operation returned by the service. * @throws InvalidNextTokenException * The next token is not valid. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @sample AWSCodeStar.ListUserProfiles * @see AWS API * Documentation */ ListUserProfilesResult listUserProfiles(ListUserProfilesRequest listUserProfilesRequest); /** *

* Adds tags to a project. *

* * @param tagProjectRequest * @return Result of the TagProject operation returned by the service. * @throws ProjectNotFoundException * The specified AWS CodeStar project was not found. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @throws LimitExceededException * A resource limit has been exceeded. * @throws ConcurrentModificationException * Another modification is being made. That modification must complete before you can make your change. * @sample AWSCodeStar.TagProject * @see AWS API * Documentation */ TagProjectResult tagProject(TagProjectRequest tagProjectRequest); /** *

* Removes tags from a project. *

* * @param untagProjectRequest * @return Result of the UntagProject operation returned by the service. * @throws ProjectNotFoundException * The specified AWS CodeStar project was not found. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @throws LimitExceededException * A resource limit has been exceeded. * @throws ConcurrentModificationException * Another modification is being made. That modification must complete before you can make your change. * @sample AWSCodeStar.UntagProject * @see AWS API * Documentation */ UntagProjectResult untagProject(UntagProjectRequest untagProjectRequest); /** *

* Updates a project in AWS CodeStar. *

* * @param updateProjectRequest * @return Result of the UpdateProject operation returned by the service. * @throws ProjectNotFoundException * The specified AWS CodeStar project was not found. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @sample AWSCodeStar.UpdateProject * @see AWS API * Documentation */ UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest); /** *

* 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. *

* * @param updateTeamMemberRequest * @return Result of the UpdateTeamMember operation returned by the service. * @throws LimitExceededException * A resource limit has been exceeded. * @throws ProjectNotFoundException * The specified AWS CodeStar project was not found. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @throws InvalidServiceRoleException * The service role is not valid. * @throws ProjectConfigurationException * Project configuration information is required but not specified. * @throws ConcurrentModificationException * Another modification is being made. That modification must complete before you can make your change. * @throws TeamMemberNotFoundException * The specified team member was not found. * @sample AWSCodeStar.UpdateTeamMember * @see AWS API * Documentation */ UpdateTeamMemberResult updateTeamMember(UpdateTeamMemberRequest updateTeamMemberRequest); /** *

* 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. *

* * @param updateUserProfileRequest * @return Result of the UpdateUserProfile operation returned by the service. * @throws UserProfileNotFoundException * The user profile was not found. * @throws ValidationException * The specified input is either not valid, or it could not be validated. * @sample AWSCodeStar.UpdateUserProfile * @see AWS API * Documentation */ UpdateUserProfileResult updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest); /** * 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. */ void shutdown(); /** * 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. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }