@Generated(value="software.amazon.awssdk:codegen") public interface CodeStarAsyncClient extends SdkClient
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AssociateTeamMemberResponse> |
associateTeamMember(AssociateTeamMemberRequest associateTeamMemberRequest)
Adds an IAM user to the team for an AWS CodeStar project.
|
default CompletableFuture<AssociateTeamMemberResponse> |
associateTeamMember(Consumer<AssociateTeamMemberRequest.Builder> associateTeamMemberRequest)
Adds an IAM user to the team for an AWS CodeStar project.
|
static CodeStarAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
CodeStarAsyncClient . |
static CodeStarAsyncClient |
create()
Create a
CodeStarAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateProjectResponse> |
createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)
Reserved for future use.
|
default CompletableFuture<CreateProjectResponse> |
createProject(CreateProjectRequest createProjectRequest)
Reserved for future use.
|
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.
|
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.
|
default CompletableFuture<DeleteProjectResponse> |
deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)
Deletes a project, including project resources.
|
default CompletableFuture<DeleteProjectResponse> |
deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes a project, including project resources.
|
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.
|
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.
|
default CompletableFuture<DescribeProjectResponse> |
describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest)
Describes a project and its resources.
|
default CompletableFuture<DescribeProjectResponse> |
describeProject(DescribeProjectRequest describeProjectRequest)
Describes a project and its resources.
|
default CompletableFuture<DescribeUserProfileResponse> |
describeUserProfile(Consumer<DescribeUserProfileRequest.Builder> describeUserProfileRequest)
Describes a user in AWS CodeStar and the user attributes across all projects.
|
default CompletableFuture<DescribeUserProfileResponse> |
describeUserProfile(DescribeUserProfileRequest describeUserProfileRequest)
Describes a user in AWS CodeStar and the user attributes across all projects.
|
default CompletableFuture<DisassociateTeamMemberResponse> |
disassociateTeamMember(Consumer<DisassociateTeamMemberRequest.Builder> disassociateTeamMemberRequest)
Removes a user from a project.
|
default CompletableFuture<DisassociateTeamMemberResponse> |
disassociateTeamMember(DisassociateTeamMemberRequest disassociateTeamMemberRequest)
Removes a user from a project.
|
default CompletableFuture<ListProjectsResponse> |
listProjects()
Lists all projects in AWS CodeStar associated with your AWS account.
|
default CompletableFuture<ListProjectsResponse> |
listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
Lists all projects in AWS CodeStar associated with your AWS account.
|
default CompletableFuture<ListProjectsResponse> |
listProjects(ListProjectsRequest listProjectsRequest)
Lists all projects in AWS CodeStar associated with your AWS account.
|
default CompletableFuture<ListResourcesResponse> |
listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Lists resources associated with a project in AWS CodeStar.
|
default CompletableFuture<ListResourcesResponse> |
listResources(ListResourcesRequest listResourcesRequest)
Lists resources associated with a project in AWS CodeStar.
|
default CompletableFuture<ListTagsForProjectResponse> |
listTagsForProject(Consumer<ListTagsForProjectRequest.Builder> listTagsForProjectRequest)
Gets the tags for a project.
|
default CompletableFuture<ListTagsForProjectResponse> |
listTagsForProject(ListTagsForProjectRequest listTagsForProjectRequest)
Gets the tags for a project.
|
default CompletableFuture<ListTeamMembersResponse> |
listTeamMembers(Consumer<ListTeamMembersRequest.Builder> listTeamMembersRequest)
Lists all team members associated with a project.
|
default CompletableFuture<ListTeamMembersResponse> |
listTeamMembers(ListTeamMembersRequest listTeamMembersRequest)
Lists all team members associated with a project.
|
default CompletableFuture<ListUserProfilesResponse> |
listUserProfiles()
Lists all the user profiles configured for your AWS account in AWS CodeStar.
|
default CompletableFuture<ListUserProfilesResponse> |
listUserProfiles(Consumer<ListUserProfilesRequest.Builder> listUserProfilesRequest)
Lists all the user profiles configured for your AWS account in AWS CodeStar.
|
default CompletableFuture<ListUserProfilesResponse> |
listUserProfiles(ListUserProfilesRequest listUserProfilesRequest)
Lists all the user profiles configured for your AWS account in AWS CodeStar.
|
default CompletableFuture<TagProjectResponse> |
tagProject(Consumer<TagProjectRequest.Builder> tagProjectRequest)
Adds tags to a project.
|
default CompletableFuture<TagProjectResponse> |
tagProject(TagProjectRequest tagProjectRequest)
Adds tags to a project.
|
default CompletableFuture<UntagProjectResponse> |
untagProject(Consumer<UntagProjectRequest.Builder> untagProjectRequest)
Removes tags from a project.
|
default CompletableFuture<UntagProjectResponse> |
untagProject(UntagProjectRequest untagProjectRequest)
Removes tags from a project.
|
default CompletableFuture<UpdateProjectResponse> |
updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)
Updates a project in AWS CodeStar.
|
default CompletableFuture<UpdateProjectResponse> |
updateProject(UpdateProjectRequest updateProjectRequest)
Updates a project in AWS CodeStar.
|
default CompletableFuture<UpdateTeamMemberResponse> |
updateTeamMember(Consumer<UpdateTeamMemberRequest.Builder> updateTeamMemberRequest)
Updates a team member's attributes in an AWS CodeStar project.
|
default CompletableFuture<UpdateTeamMemberResponse> |
updateTeamMember(UpdateTeamMemberRequest updateTeamMemberRequest)
Updates a team member's attributes in an AWS CodeStar project.
|
default CompletableFuture<UpdateUserProfileResponse> |
updateUserProfile(Consumer<UpdateUserProfileRequest.Builder> updateUserProfileRequest)
Updates a user's profile in AWS CodeStar.
|
default CompletableFuture<UpdateUserProfileResponse> |
updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)
Updates a user's profile in AWS CodeStar.
|
serviceName
close
static final String SERVICE_NAME
static CodeStarAsyncClient create()
CodeStarAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CodeStarAsyncClientBuilder builder()
CodeStarAsyncClient
.default CompletableFuture<AssociateTeamMemberResponse> associateTeamMember(AssociateTeamMemberRequest associateTeamMemberRequest)
Adds an IAM user to the team for an AWS CodeStar project.
associateTeamMemberRequest
- 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()
associateTeamMemberRequest
- A Consumer
that will call methods on AssociateTeamMemberRequest.Builder
to create a
request.default CompletableFuture<CreateProjectResponse> createProject(CreateProjectRequest createProjectRequest)
Reserved for future use. To create a project, use the AWS CodeStar console.
createProjectRequest
- default CompletableFuture<CreateProjectResponse> createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)
Reserved for future use. To create a project, use the AWS CodeStar console.
This is a convenience which creates an instance of the CreateProjectRequest.Builder
avoiding the need to
create one manually via CreateProjectRequest.builder()
createProjectRequest
- A Consumer
that will call methods on CreateProjectRequest.Builder
to create a request.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.
createUserProfileRequest
- 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()
createUserProfileRequest
- A Consumer
that will call methods on CreateUserProfileRequest.Builder
to create a request.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.
deleteProjectRequest
- 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()
deleteProjectRequest
- A Consumer
that will call methods on DeleteProjectRequest.Builder
to create a request.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.
deleteUserProfileRequest
- 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()
deleteUserProfileRequest
- A Consumer
that will call methods on DeleteUserProfileRequest.Builder
to create a request.default CompletableFuture<DescribeProjectResponse> describeProject(DescribeProjectRequest describeProjectRequest)
Describes a project and its resources.
describeProjectRequest
- 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()
describeProjectRequest
- A Consumer
that will call methods on DescribeProjectRequest.Builder
to create a request.default CompletableFuture<DescribeUserProfileResponse> describeUserProfile(DescribeUserProfileRequest describeUserProfileRequest)
Describes a user in AWS CodeStar and the user attributes across all projects.
describeUserProfileRequest
- 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()
describeUserProfileRequest
- A Consumer
that will call methods on DescribeUserProfileRequest.Builder
to create a
request.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.
disassociateTeamMemberRequest
- 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()
disassociateTeamMemberRequest
- A Consumer
that will call methods on DisassociateTeamMemberRequest.Builder
to create a
request.default CompletableFuture<ListProjectsResponse> listProjects(ListProjectsRequest listProjectsRequest)
Lists all projects in AWS CodeStar associated with your AWS account.
listProjectsRequest
- 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()
listProjectsRequest
- A Consumer
that will call methods on ListProjectsRequest.Builder
to create a request.default CompletableFuture<ListProjectsResponse> listProjects()
Lists all projects in AWS CodeStar associated with your AWS account.
default CompletableFuture<ListResourcesResponse> listResources(ListResourcesRequest listResourcesRequest)
Lists resources associated with a project in AWS CodeStar.
listResourcesRequest
- 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()
listResourcesRequest
- A Consumer
that will call methods on ListResourcesRequest.Builder
to create a request.default CompletableFuture<ListTagsForProjectResponse> listTagsForProject(ListTagsForProjectRequest listTagsForProjectRequest)
Gets the tags for a project.
listTagsForProjectRequest
- 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()
listTagsForProjectRequest
- A Consumer
that will call methods on ListTagsForProjectRequest.Builder
to create a
request.default CompletableFuture<ListTeamMembersResponse> listTeamMembers(ListTeamMembersRequest listTeamMembersRequest)
Lists all team members associated with a project.
listTeamMembersRequest
- 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()
listTeamMembersRequest
- A Consumer
that will call methods on ListTeamMembersRequest.Builder
to create a request.default CompletableFuture<ListUserProfilesResponse> listUserProfiles(ListUserProfilesRequest listUserProfilesRequest)
Lists all the user profiles configured for your AWS account in AWS CodeStar.
listUserProfilesRequest
- 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()
listUserProfilesRequest
- A Consumer
that will call methods on ListUserProfilesRequest.Builder
to create a request.default CompletableFuture<ListUserProfilesResponse> listUserProfiles()
Lists all the user profiles configured for your AWS account in AWS CodeStar.
default CompletableFuture<TagProjectResponse> tagProject(TagProjectRequest tagProjectRequest)
Adds tags to a project.
tagProjectRequest
- 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()
tagProjectRequest
- A Consumer
that will call methods on TagProjectRequest.Builder
to create a request.default CompletableFuture<UntagProjectResponse> untagProject(UntagProjectRequest untagProjectRequest)
Removes tags from a project.
untagProjectRequest
- 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()
untagProjectRequest
- A Consumer
that will call methods on UntagProjectRequest.Builder
to create a request.default CompletableFuture<UpdateProjectResponse> updateProject(UpdateProjectRequest updateProjectRequest)
Updates a project in AWS CodeStar.
updateProjectRequest
- 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()
updateProjectRequest
- A Consumer
that will call methods on UpdateProjectRequest.Builder
to create a request.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.
updateTeamMemberRequest
- 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()
updateTeamMemberRequest
- A Consumer
that will call methods on UpdateTeamMemberRequest.Builder
to create a request.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.
updateUserProfileRequest
- 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()
updateUserProfileRequest
- A Consumer
that will call methods on UpdateUserProfileRequest.Builder
to create a request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.