AWS SDK Version 3 for .NET
API Reference

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 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:

Teams and team members, by calling the following:

Users, by calling the following:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.CodeStar.AmazonCodeStarClient

Namespace: Amazon.CodeStar
Assembly: AWSSDK.CodeStar.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonCodeStarClient : AmazonServiceClient
         IAmazonCodeStar, IAmazonService, IDisposable

The AmazonCodeStarClient type exposes the following members

Constructors

NameDescription
Public Method 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.



    
        
    

             

Public Method 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.



    
        
    

             

Public Method 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.



    
        
    

             

Public Method AmazonCodeStarClient(AWSCredentials)

Constructs AmazonCodeStarClient with AWS Credentials

Public Method AmazonCodeStarClient(AWSCredentials, RegionEndpoint)

Constructs AmazonCodeStarClient with AWS Credentials

Public Method AmazonCodeStarClient(AWSCredentials, AmazonCodeStarConfig)

Constructs AmazonCodeStarClient with AWS Credentials and an AmazonCodeStarClient Configuration object.

Public Method AmazonCodeStarClient(string, string)

Constructs AmazonCodeStarClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCodeStarClient(string, string, RegionEndpoint)

Constructs AmazonCodeStarClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCodeStarClient(string, string, AmazonCodeStarConfig)

Constructs AmazonCodeStarClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeStarClient Configuration object.

Public Method AmazonCodeStarClient(string, string, string)

Constructs AmazonCodeStarClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCodeStarClient(string, string, string, RegionEndpoint)

Constructs AmazonCodeStarClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCodeStarClient(string, string, string, AmazonCodeStarConfig)

Constructs AmazonCodeStarClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeStarClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateTeamMember(AssociateTeamMemberRequest)

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

Public Method AssociateTeamMemberAsync(AssociateTeamMemberRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateTeamMember operation.

Public Method CreateProject(CreateProjectRequest)

Reserved for future use. To create a project, use the AWS CodeStar console.

Public Method CreateProjectAsync(CreateProjectRequest, CancellationToken)

Initiates the asynchronous execution of the CreateProject operation.

Public Method 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.

Public Method CreateUserProfileAsync(CreateUserProfileRequest, CancellationToken)

Initiates the asynchronous execution of the CreateUserProfile operation.

Public Method 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.

Public Method DeleteProjectAsync(DeleteProjectRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteProject operation.

Public Method 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.

Public Method DeleteUserProfileAsync(DeleteUserProfileRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUserProfile operation.

Public Method DescribeProject(DescribeProjectRequest)

Describes a project and its resources.

Public Method DescribeProjectAsync(DescribeProjectRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeProject operation.

Public Method DescribeUserProfile(DescribeUserProfileRequest)

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

Public Method DescribeUserProfileAsync(DescribeUserProfileRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeUserProfile operation.

Public Method 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.

Public Method DisassociateTeamMemberAsync(DisassociateTeamMemberRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateTeamMember operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ListProjects(ListProjectsRequest)

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

Public Method ListProjectsAsync(ListProjectsRequest, CancellationToken)

Initiates the asynchronous execution of the ListProjects operation.

Public Method ListResources(ListResourcesRequest)

Lists resources associated with a project in AWS CodeStar.

Public Method ListResourcesAsync(ListResourcesRequest, CancellationToken)

Initiates the asynchronous execution of the ListResources operation.

Public Method ListTagsForProject(ListTagsForProjectRequest)

Gets the tags for a project.

Public Method ListTagsForProjectAsync(ListTagsForProjectRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsForProject operation.

Public Method ListTeamMembers(ListTeamMembersRequest)

Lists all team members associated with a project.

Public Method ListTeamMembersAsync(ListTeamMembersRequest, CancellationToken)

Initiates the asynchronous execution of the ListTeamMembers operation.

Public Method ListUserProfiles(ListUserProfilesRequest)

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

Public Method ListUserProfilesAsync(ListUserProfilesRequest, CancellationToken)

Initiates the asynchronous execution of the ListUserProfiles operation.

Public Method TagProject(TagProjectRequest)

Adds tags to a project.

Public Method TagProjectAsync(TagProjectRequest, CancellationToken)

Initiates the asynchronous execution of the TagProject operation.

Public Method UntagProject(UntagProjectRequest)

Removes tags from a project.

Public Method UntagProjectAsync(UntagProjectRequest, CancellationToken)

Initiates the asynchronous execution of the UntagProject operation.

Public Method UpdateProject(UpdateProjectRequest)

Updates a project in AWS CodeStar.

Public Method UpdateProjectAsync(UpdateProjectRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateProject operation.

Public Method 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.

Public Method UpdateTeamMemberAsync(UpdateTeamMemberRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateTeamMember operation.

Public Method 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.

Public Method UpdateUserProfileAsync(UpdateUserProfileRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateUserProfile operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms