AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Implementation for accessing CodeStar
AWS CodeStarThis 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.
Namespace: Amazon.CodeStar
Assembly: AWSSDK.CodeStar.dll
Version: 3.x.y.z
public class AmazonCodeStarClient : AmazonServiceClient IAmazonCodeStar, IAmazonService, IDisposable
The AmazonCodeStarClient type exposes the following members
Name | Description | |
---|---|---|
AmazonCodeStarClient() |
Constructs AmazonCodeStarClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonCodeStarClient(RegionEndpoint) |
Constructs AmazonCodeStarClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonCodeStarClient(AmazonCodeStarConfig) |
Constructs AmazonCodeStarClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonCodeStarClient(AWSCredentials) |
Constructs AmazonCodeStarClient with AWS Credentials |
|
AmazonCodeStarClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonCodeStarClient with AWS Credentials |
|
AmazonCodeStarClient(AWSCredentials, AmazonCodeStarConfig) |
Constructs AmazonCodeStarClient with AWS Credentials and an AmazonCodeStarClient Configuration object. |
|
AmazonCodeStarClient(string, string) |
Constructs AmazonCodeStarClient with AWS Access Key ID and AWS Secret Key |
|
AmazonCodeStarClient(string, string, RegionEndpoint) |
Constructs AmazonCodeStarClient with AWS Access Key ID and AWS Secret Key |
|
AmazonCodeStarClient(string, string, AmazonCodeStarConfig) |
Constructs AmazonCodeStarClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeStarClient Configuration object. |
|
AmazonCodeStarClient(string, string, string) |
Constructs AmazonCodeStarClient with AWS Access Key ID and AWS Secret Key |
|
AmazonCodeStarClient(string, string, string, RegionEndpoint) |
Constructs AmazonCodeStarClient with AWS Access Key ID and AWS Secret Key |
|
AmazonCodeStarClient(string, string, string, AmazonCodeStarConfig) |
Constructs AmazonCodeStarClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeStarClient Configuration object. |
Name | Type | Description | |
---|---|---|---|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. |
Name | Description | |
---|---|---|
AssociateTeamMember(AssociateTeamMemberRequest) |
Adds an IAM user to the team for an AWS CodeStar project. |
|
AssociateTeamMemberAsync(AssociateTeamMemberRequest, CancellationToken) |
Adds an IAM user to the team for an AWS CodeStar project. |
|
CreateProject(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. |
|
CreateProjectAsync(CreateProjectRequest, CancellationToken) |
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. |
|
CreateUserProfile(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. |
|
CreateUserProfileAsync(CreateUserProfileRequest, CancellationToken) |
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. |
|
DeleteProject(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. |
|
DeleteProjectAsync(DeleteProjectRequest, CancellationToken) |
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. |
|
DeleteUserProfile(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. |
|
DeleteUserProfileAsync(DeleteUserProfileRequest, CancellationToken) |
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. |
|
DescribeProject(DescribeProjectRequest) |
Describes a project and its resources. |
|
DescribeProjectAsync(DescribeProjectRequest, CancellationToken) |
Describes a project and its resources. |
|
DescribeUserProfile(DescribeUserProfileRequest) |
Describes a user in AWS CodeStar and the user attributes across all projects. |
|
DescribeUserProfileAsync(DescribeUserProfileRequest, CancellationToken) |
Describes a user in AWS CodeStar and the user attributes across all projects. |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
DisassociateTeamMember(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. |
|
DisassociateTeamMemberAsync(DisassociateTeamMemberRequest, CancellationToken) |
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. |
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ListProjects(ListProjectsRequest) |
Lists all projects in AWS CodeStar associated with your AWS account. |
|
ListProjectsAsync(ListProjectsRequest, CancellationToken) |
Lists all projects in AWS CodeStar associated with your AWS account. |
|
ListResources(ListResourcesRequest) |
Lists resources associated with a project in AWS CodeStar. |
|
ListResourcesAsync(ListResourcesRequest, CancellationToken) |
Lists resources associated with a project in AWS CodeStar. |
|
ListTagsForProject(ListTagsForProjectRequest) |
Gets the tags for a project. |
|
ListTagsForProjectAsync(ListTagsForProjectRequest, CancellationToken) |
Gets the tags for a project. |
|
ListTeamMembers(ListTeamMembersRequest) |
Lists all team members associated with a project. |
|
ListTeamMembersAsync(ListTeamMembersRequest, CancellationToken) |
Lists all team members associated with a project. |
|
ListUserProfiles(ListUserProfilesRequest) |
Lists all the user profiles configured for your AWS account in AWS CodeStar. |
|
ListUserProfilesAsync(ListUserProfilesRequest, CancellationToken) |
Lists all the user profiles configured for your AWS account in AWS CodeStar. |
|
TagProject(TagProjectRequest) |
Adds tags to a project. |
|
TagProjectAsync(TagProjectRequest, CancellationToken) |
Adds tags to a project. |
|
UntagProject(UntagProjectRequest) |
Removes tags from a project. |
|
UntagProjectAsync(UntagProjectRequest, CancellationToken) |
Removes tags from a project. |
|
UpdateProject(UpdateProjectRequest) |
Updates a project in AWS CodeStar. |
|
UpdateProjectAsync(UpdateProjectRequest, CancellationToken) |
Updates a project in AWS CodeStar. |
|
UpdateTeamMember(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. |
|
UpdateTeamMemberAsync(UpdateTeamMemberRequest, CancellationToken) |
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. |
|
UpdateUserProfile(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. |
|
UpdateUserProfileAsync(UpdateUserProfileRequest, CancellationToken) |
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. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5