/* * 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.services.codestar.model.*; /** * Interface for accessing CodeStar asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.codestar.AbstractAWSCodeStarAsync} instead. *
*
*
* 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.
*
* Adds an IAM user to the team for an AWS CodeStar project. *
* * @param associateTeamMemberRequest * @return A Java Future containing the result of the AssociateTeamMember operation returned by the service. * @sample AWSCodeStarAsync.AssociateTeamMember * @see AWS * API Documentation */ java.util.concurrent.Future* Adds an IAM user to the team for an AWS CodeStar project. *
* * @param associateTeamMemberRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AssociateTeamMember operation returned by the service. * @sample AWSCodeStarAsyncHandler.AssociateTeamMember * @see AWS * API Documentation */ java.util.concurrent.Future* 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 A Java Future containing the result of the CreateProject operation returned by the service. * @sample AWSCodeStarAsync.CreateProject * @see AWS API * Documentation */ java.util.concurrent.Future* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateProject operation returned by the service. * @sample AWSCodeStarAsyncHandler.CreateProject * @see AWS API * Documentation */ java.util.concurrent.Future* 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 A Java Future containing the result of the CreateUserProfile operation returned by the service. * @sample AWSCodeStarAsync.CreateUserProfile * @see AWS API * Documentation */ java.util.concurrent.Future* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateUserProfile operation returned by the service. * @sample AWSCodeStarAsyncHandler.CreateUserProfile * @see AWS API * Documentation */ java.util.concurrent.Future* 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 A Java Future containing the result of the DeleteProject operation returned by the service. * @sample AWSCodeStarAsync.DeleteProject * @see AWS API * Documentation */ java.util.concurrent.Future* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteProject operation returned by the service. * @sample AWSCodeStarAsyncHandler.DeleteProject * @see AWS API * Documentation */ java.util.concurrent.Future* 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 A Java Future containing the result of the DeleteUserProfile operation returned by the service. * @sample AWSCodeStarAsync.DeleteUserProfile * @see AWS API * Documentation */ java.util.concurrent.Future* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteUserProfile operation returned by the service. * @sample AWSCodeStarAsyncHandler.DeleteUserProfile * @see AWS API * Documentation */ java.util.concurrent.Future* Describes a project and its resources. *
* * @param describeProjectRequest * @return A Java Future containing the result of the DescribeProject operation returned by the service. * @sample AWSCodeStarAsync.DescribeProject * @see AWS API * Documentation */ java.util.concurrent.Future* Describes a project and its resources. *
* * @param describeProjectRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeProject operation returned by the service. * @sample AWSCodeStarAsyncHandler.DescribeProject * @see AWS API * Documentation */ java.util.concurrent.Future* Describes a user in AWS CodeStar and the user attributes across all projects. *
* * @param describeUserProfileRequest * @return A Java Future containing the result of the DescribeUserProfile operation returned by the service. * @sample AWSCodeStarAsync.DescribeUserProfile * @see AWS * API Documentation */ java.util.concurrent.Future* Describes a user in AWS CodeStar and the user attributes across all projects. *
* * @param describeUserProfileRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeUserProfile operation returned by the service. * @sample AWSCodeStarAsyncHandler.DescribeUserProfile * @see AWS * API Documentation */ java.util.concurrent.Future* 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 A Java Future containing the result of the DisassociateTeamMember operation returned by the service. * @sample AWSCodeStarAsync.DisassociateTeamMember * @see AWS API Documentation */ java.util.concurrent.Future* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DisassociateTeamMember operation returned by the service. * @sample AWSCodeStarAsyncHandler.DisassociateTeamMember * @see AWS API Documentation */ java.util.concurrent.Future* Lists all projects in AWS CodeStar associated with your AWS account. *
* * @param listProjectsRequest * @return A Java Future containing the result of the ListProjects operation returned by the service. * @sample AWSCodeStarAsync.ListProjects * @see AWS API * Documentation */ java.util.concurrent.Future* Lists all projects in AWS CodeStar associated with your AWS account. *
* * @param listProjectsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListProjects operation returned by the service. * @sample AWSCodeStarAsyncHandler.ListProjects * @see AWS API * Documentation */ java.util.concurrent.Future* Lists resources associated with a project in AWS CodeStar. *
* * @param listResourcesRequest * @return A Java Future containing the result of the ListResources operation returned by the service. * @sample AWSCodeStarAsync.ListResources * @see AWS API * Documentation */ java.util.concurrent.Future* Lists resources associated with a project in AWS CodeStar. *
* * @param listResourcesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListResources operation returned by the service. * @sample AWSCodeStarAsyncHandler.ListResources * @see AWS API * Documentation */ java.util.concurrent.Future* Gets the tags for a project. *
* * @param listTagsForProjectRequest * @return A Java Future containing the result of the ListTagsForProject operation returned by the service. * @sample AWSCodeStarAsync.ListTagsForProject * @see AWS * API Documentation */ java.util.concurrent.Future* Gets the tags for a project. *
* * @param listTagsForProjectRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForProject operation returned by the service. * @sample AWSCodeStarAsyncHandler.ListTagsForProject * @see AWS * API Documentation */ java.util.concurrent.Future* Lists all team members associated with a project. *
* * @param listTeamMembersRequest * @return A Java Future containing the result of the ListTeamMembers operation returned by the service. * @sample AWSCodeStarAsync.ListTeamMembers * @see AWS API * Documentation */ java.util.concurrent.Future* Lists all team members associated with a project. *
* * @param listTeamMembersRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTeamMembers operation returned by the service. * @sample AWSCodeStarAsyncHandler.ListTeamMembers * @see AWS API * Documentation */ java.util.concurrent.Future* Lists all the user profiles configured for your AWS account in AWS CodeStar. *
* * @param listUserProfilesRequest * @return A Java Future containing the result of the ListUserProfiles operation returned by the service. * @sample AWSCodeStarAsync.ListUserProfiles * @see AWS API * Documentation */ java.util.concurrent.Future* Lists all the user profiles configured for your AWS account in AWS CodeStar. *
* * @param listUserProfilesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListUserProfiles operation returned by the service. * @sample AWSCodeStarAsyncHandler.ListUserProfiles * @see AWS API * Documentation */ java.util.concurrent.Future* Adds tags to a project. *
* * @param tagProjectRequest * @return A Java Future containing the result of the TagProject operation returned by the service. * @sample AWSCodeStarAsync.TagProject * @see AWS API * Documentation */ java.util.concurrent.Future* Adds tags to a project. *
* * @param tagProjectRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagProject operation returned by the service. * @sample AWSCodeStarAsyncHandler.TagProject * @see AWS API * Documentation */ java.util.concurrent.Future* Removes tags from a project. *
* * @param untagProjectRequest * @return A Java Future containing the result of the UntagProject operation returned by the service. * @sample AWSCodeStarAsync.UntagProject * @see AWS API * Documentation */ java.util.concurrent.Future* Removes tags from a project. *
* * @param untagProjectRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagProject operation returned by the service. * @sample AWSCodeStarAsyncHandler.UntagProject * @see AWS API * Documentation */ java.util.concurrent.Future* Updates a project in AWS CodeStar. *
* * @param updateProjectRequest * @return A Java Future containing the result of the UpdateProject operation returned by the service. * @sample AWSCodeStarAsync.UpdateProject * @see AWS API * Documentation */ java.util.concurrent.Future* Updates a project in AWS CodeStar. *
* * @param updateProjectRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateProject operation returned by the service. * @sample AWSCodeStarAsyncHandler.UpdateProject * @see AWS API * Documentation */ java.util.concurrent.Future* 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 A Java Future containing the result of the UpdateTeamMember operation returned by the service. * @sample AWSCodeStarAsync.UpdateTeamMember * @see AWS API * Documentation */ java.util.concurrent.Future* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateTeamMember operation returned by the service. * @sample AWSCodeStarAsyncHandler.UpdateTeamMember * @see AWS API * Documentation */ java.util.concurrent.Future* 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 A Java Future containing the result of the UpdateUserProfile operation returned by the service. * @sample AWSCodeStarAsync.UpdateUserProfile * @see AWS API * Documentation */ java.util.concurrent.Future* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateUserProfile operation returned by the service. * @sample AWSCodeStarAsyncHandler.UpdateUserProfile * @see AWS API * Documentation */ java.util.concurrent.Future