Package software.amazon.awssdk.services.codestar

Interface CodeStarAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface CodeStarAsyncClient extends AwsClient
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.

  • 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 Details

  • Method Details

    • 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.
      • SdkException 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 type.
      See Also:

    • associateTeamMember

      default CompletableFuture<AssociateTeamMemberResponse> associateTeamMember(Consumer<AssociateTeamMemberRequest.Builder> associateTeamMemberRequest)

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


      This is a convenience which creates an instance of the AssociateTeamMemberRequest.Builder avoiding the need to create one manually via AssociateTeamMemberRequest.builder()

      Parameters:
      associateTeamMemberRequest - A Consumer that will call methods on AssociateTeamMemberRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • createProject

      default CompletableFuture<CreateProjectResponse> 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:
      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.
      • SdkException 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 type.
      See Also:

    • createProject

      default CompletableFuture<CreateProjectResponse> createProject(Consumer<CreateProjectRequest.Builder> 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.


      This is a convenience which creates an instance of the CreateProjectRequest.Builder avoiding the need to create one manually via CreateProjectRequest.builder()

      Parameters:
      createProjectRequest - A Consumer that will call methods on CreateProjectRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • 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.
      • SdkException 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 type.
      See Also:

    • createUserProfile

      default CompletableFuture<CreateUserProfileResponse> createUserProfile(Consumer<CreateUserProfileRequest.Builder> 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.


      This is a convenience which creates an instance of the CreateUserProfileRequest.Builder avoiding the need to create one manually via CreateUserProfileRequest.builder()

      Parameters:
      createUserProfileRequest - A Consumer that will call methods on CreateUserProfileRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • 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.
      • SdkException 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 type.
      See Also:

    • deleteProject

      default CompletableFuture<DeleteProjectResponse> deleteProject(Consumer<DeleteProjectRequest.Builder> 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.


      This is a convenience which creates an instance of the DeleteProjectRequest.Builder avoiding the need to create one manually via DeleteProjectRequest.builder()

      Parameters:
      deleteProjectRequest - A Consumer that will call methods on DeleteProjectRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • 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.
      • SdkException 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 type.
      See Also:

    • deleteUserProfile

      default CompletableFuture<DeleteUserProfileResponse> deleteUserProfile(Consumer<DeleteUserProfileRequest.Builder> 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.


      This is a convenience which creates an instance of the DeleteUserProfileRequest.Builder avoiding the need to create one manually via DeleteUserProfileRequest.builder()

      Parameters:
      deleteUserProfileRequest - A Consumer that will call methods on DeleteUserProfileRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • 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.
      • SdkException 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 type.
      See Also:

    • describeProject

      default CompletableFuture<DescribeProjectResponse> describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest)

      Describes a project and its resources.


      This is a convenience which creates an instance of the DescribeProjectRequest.Builder avoiding the need to create one manually via DescribeProjectRequest.builder()

      Parameters:
      describeProjectRequest - A Consumer that will call methods on DescribeProjectRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • 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.
      • SdkException 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 type.
      See Also:

    • describeUserProfile

      default CompletableFuture<DescribeUserProfileResponse> describeUserProfile(Consumer<DescribeUserProfileRequest.Builder> describeUserProfileRequest)

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


      This is a convenience which creates an instance of the DescribeUserProfileRequest.Builder avoiding the need to create one manually via DescribeUserProfileRequest.builder()

      Parameters:
      describeUserProfileRequest - A Consumer that will call methods on DescribeUserProfileRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • 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.
      • SdkException 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 type.
      See Also:

    • disassociateTeamMember

      default CompletableFuture<DisassociateTeamMemberResponse> disassociateTeamMember(Consumer<DisassociateTeamMemberRequest.Builder> 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.


      This is a convenience which creates an instance of the DisassociateTeamMemberRequest.Builder avoiding the need to create one manually via DisassociateTeamMemberRequest.builder()

      Parameters:
      disassociateTeamMemberRequest - A Consumer that will call methods on DisassociateTeamMemberRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • 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.
      • SdkException 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 type.
      See Also:

    • listProjects

      default CompletableFuture<ListProjectsResponse> listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)

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


      This is a convenience which creates an instance of the ListProjectsRequest.Builder avoiding the need to create one manually via ListProjectsRequest.builder()

      Parameters:
      listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • listProjects

      default CompletableFuture<ListProjectsResponse> listProjects()

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

      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.
      • SdkException 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 type.
      See Also:

    • 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.
      • SdkException 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 type.
      See Also:

    • listResources

      default CompletableFuture<ListResourcesResponse> listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)

      Lists resources associated with a project in AWS CodeStar.


      This is a convenience which creates an instance of the ListResourcesRequest.Builder avoiding the need to create one manually via ListResourcesRequest.builder()

      Parameters:
      listResourcesRequest - A Consumer that will call methods on ListResourcesRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • listTagsForProject

      default CompletableFuture<ListTagsForProjectResponse> listTagsForProject(ListTagsForProjectRequest listTagsForProjectRequest)

      Gets the tags for a project.

      Parameters:
      listTagsForProjectRequest -
      Returns:
      A Java Future containing the result of the ListTagsForProject 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.
      • InvalidNextTokenException The next token is not valid.
      • SdkException 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 type.
      See Also:

    • listTagsForProject

      default CompletableFuture<ListTagsForProjectResponse> listTagsForProject(Consumer<ListTagsForProjectRequest.Builder> listTagsForProjectRequest)

      Gets the tags for a project.


      This is a convenience which creates an instance of the ListTagsForProjectRequest.Builder avoiding the need to create one manually via ListTagsForProjectRequest.builder()

      Parameters:
      listTagsForProjectRequest - A Consumer that will call methods on ListTagsForProjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForProject 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.
      • InvalidNextTokenException The next token is not valid.
      • SdkException 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 type.
      See Also:

    • 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.
      • SdkException 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 type.
      See Also:

    • listTeamMembers

      default CompletableFuture<ListTeamMembersResponse> listTeamMembers(Consumer<ListTeamMembersRequest.Builder> listTeamMembersRequest)

      Lists all team members associated with a project.


      This is a convenience which creates an instance of the ListTeamMembersRequest.Builder avoiding the need to create one manually via ListTeamMembersRequest.builder()

      Parameters:
      listTeamMembersRequest - A Consumer that will call methods on ListTeamMembersRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • 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.
      • SdkException 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 type.
      See Also:

    • listUserProfiles

      default CompletableFuture<ListUserProfilesResponse> listUserProfiles(Consumer<ListUserProfilesRequest.Builder> listUserProfilesRequest)

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


      This is a convenience which creates an instance of the ListUserProfilesRequest.Builder avoiding the need to create one manually via ListUserProfilesRequest.builder()

      Parameters:
      listUserProfilesRequest - A Consumer that will call methods on ListUserProfilesRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • listUserProfiles

      default CompletableFuture<ListUserProfilesResponse> listUserProfiles()

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

      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.
      • SdkException 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 type.
      See Also:

    • tagProject

      default CompletableFuture<TagProjectResponse> tagProject(TagProjectRequest tagProjectRequest)

      Adds tags to a project.

      Parameters:
      tagProjectRequest -
      Returns:
      A Java Future containing the result of the TagProject 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.
      • LimitExceededException A resource limit has been exceeded.
      • ConcurrentModificationException Another modification is being made. That modification must complete before you can make your change.
      • SdkException 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 type.
      See Also:

    • tagProject

      default CompletableFuture<TagProjectResponse> tagProject(Consumer<TagProjectRequest.Builder> tagProjectRequest)

      Adds tags to a project.


      This is a convenience which creates an instance of the TagProjectRequest.Builder avoiding the need to create one manually via TagProjectRequest.builder()

      Parameters:
      tagProjectRequest - A Consumer that will call methods on TagProjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagProject 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.
      • LimitExceededException A resource limit has been exceeded.
      • ConcurrentModificationException Another modification is being made. That modification must complete before you can make your change.
      • SdkException 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 type.
      See Also:

    • untagProject

      default CompletableFuture<UntagProjectResponse> untagProject(UntagProjectRequest untagProjectRequest)

      Removes tags from a project.

      Parameters:
      untagProjectRequest -
      Returns:
      A Java Future containing the result of the UntagProject 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.
      • LimitExceededException A resource limit has been exceeded.
      • ConcurrentModificationException Another modification is being made. That modification must complete before you can make your change.
      • SdkException 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 type.
      See Also:

    • untagProject

      default CompletableFuture<UntagProjectResponse> untagProject(Consumer<UntagProjectRequest.Builder> untagProjectRequest)

      Removes tags from a project.


      This is a convenience which creates an instance of the UntagProjectRequest.Builder avoiding the need to create one manually via UntagProjectRequest.builder()

      Parameters:
      untagProjectRequest - A Consumer that will call methods on UntagProjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagProject 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.
      • LimitExceededException A resource limit has been exceeded.
      • ConcurrentModificationException Another modification is being made. That modification must complete before you can make your change.
      • SdkException 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 type.
      See Also:

    • 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.
      • SdkException 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 type.
      See Also:

    • updateProject

      default CompletableFuture<UpdateProjectResponse> updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)

      Updates a project in AWS CodeStar.


      This is a convenience which creates an instance of the UpdateProjectRequest.Builder avoiding the need to create one manually via UpdateProjectRequest.builder()

      Parameters:
      updateProjectRequest - A Consumer that will call methods on UpdateProjectRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • 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.
      • SdkException 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 type.
      See Also:

    • updateTeamMember

      default CompletableFuture<UpdateTeamMemberResponse> updateTeamMember(Consumer<UpdateTeamMemberRequest.Builder> 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.


      This is a convenience which creates an instance of the UpdateTeamMemberRequest.Builder avoiding the need to create one manually via UpdateTeamMemberRequest.builder()

      Parameters:
      updateTeamMemberRequest - A Consumer that will call methods on UpdateTeamMemberRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • 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.
      • SdkException 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 type.
      See Also:

    • updateUserProfile

      default CompletableFuture<UpdateUserProfileResponse> updateUserProfile(Consumer<UpdateUserProfileRequest.Builder> 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.


      This is a convenience which creates an instance of the UpdateUserProfileRequest.Builder avoiding the need to create one manually via UpdateUserProfileRequest.builder()

      Parameters:
      updateUserProfileRequest - A Consumer that will call methods on UpdateUserProfileRequest.Builder to create a request.
      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.
      • SdkException 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 type.
      See Also:

    • serviceClientConfiguration

      default CodeStarServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

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