CodeStar class

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.

Constructors

CodeStar({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

associateTeamMember({required String projectId, required String projectRole, required String userArn, String? clientRequestToken, bool? remoteAccessAllowed}) → Future<AssociateTeamMemberResult>

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

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createProject({required String id, required String name, String? clientRequestToken, String? description, List<Code>? sourceCode, Map<String, String>? tags, Toolchain? toolchain}) → Future<CreateProjectResult>

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({required String displayName, required String emailAddress, required String userArn, String? sshPublicKey}) → Future<CreateUserProfileResult>

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({required String id, String? clientRequestToken, bool? deleteStack}) → Future<DeleteProjectResult>

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({required String userArn}) → Future<DeleteUserProfileResult>

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({required String id}) → Future<DescribeProjectResult>

Describes a project and its resources.

describeUserProfile({required String userArn}) → Future<DescribeUserProfileResult>

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

disassociateTeamMember({required String projectId, required String userArn}) → Future<void>

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.

listProjects({int? maxResults, String? nextToken}) → Future<ListProjectsResult>

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

listResources({required String projectId, int? maxResults, String? nextToken}) → Future<ListResourcesResult>

Lists resources associated with a project in AWS CodeStar.

listTagsForProject({required String id, int? maxResults, String? nextToken}) → Future<ListTagsForProjectResult>

Gets the tags for a project.

listTeamMembers({required String projectId, int? maxResults, String? nextToken}) → Future<ListTeamMembersResult>

Lists all team members associated with a project.

listUserProfiles({int? maxResults, String? nextToken}) → Future<ListUserProfilesResult>

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

tagProject({required String id, required Map<String, String> tags}) → Future<TagProjectResult>

Adds tags to a project.

toString() → String

A string representation of this object.

inherited

untagProject({required String id, required List<String> tags}) → Future<void>

Removes tags from a project.

updateProject({required String id, String? description, String? name}) → Future<void>

Updates a project in AWS CodeStar.

updateTeamMember({required String projectId, required String userArn, String? projectRole, bool? remoteAccessAllowed}) → Future<UpdateTeamMemberResult>

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({required String userArn, String? displayName, String? emailAddress, String? sshPublicKey}) → Future<UpdateUserProfileResult>

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.

Operators

operator ==(Object other) → bool

The equality operator.

inherited