View on GitHub
CodeStar Structure Reference
CodeStar
public struct CodeStarClient object for interacting with AWS CodeStar service.
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: 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.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the CodeStar client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Adds an IAM user to the team for an AWS CodeStar project.
Declaration
Swift
public func associateTeamMember(_ input: AssociateTeamMemberRequest) -> EventLoopFuture<AssociateTeamMemberResult> -
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.
Declaration
Swift
public func createProject(_ input: CreateProjectRequest) -> EventLoopFuture<CreateProjectResult> -
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.
Declaration
Swift
public func createUserProfile(_ input: CreateUserProfileRequest) -> EventLoopFuture<CreateUserProfileResult> -
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.
Declaration
Swift
public func deleteProject(_ input: DeleteProjectRequest) -> EventLoopFuture<DeleteProjectResult> -
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.
Declaration
Swift
public func deleteUserProfile(_ input: DeleteUserProfileRequest) -> EventLoopFuture<DeleteUserProfileResult> -
Describes a project and its resources.
Declaration
Swift
public func describeProject(_ input: DescribeProjectRequest) -> EventLoopFuture<DescribeProjectResult> -
Describes a user in AWS CodeStar and the user attributes across all projects.
Declaration
Swift
public func describeUserProfile(_ input: DescribeUserProfileRequest) -> EventLoopFuture<DescribeUserProfileResult> -
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.
Declaration
Swift
public func disassociateTeamMember(_ input: DisassociateTeamMemberRequest) -> EventLoopFuture<DisassociateTeamMemberResult> -
Lists all projects in AWS CodeStar associated with your AWS account.
Declaration
Swift
public func listProjects(_ input: ListProjectsRequest) -> EventLoopFuture<ListProjectsResult> -
Lists resources associated with a project in AWS CodeStar.
Declaration
Swift
public func listResources(_ input: ListResourcesRequest) -> EventLoopFuture<ListResourcesResult> -
Gets the tags for a project.
Declaration
Swift
public func listTagsForProject(_ input: ListTagsForProjectRequest) -> EventLoopFuture<ListTagsForProjectResult> -
Lists all team members associated with a project.
Declaration
Swift
public func listTeamMembers(_ input: ListTeamMembersRequest) -> EventLoopFuture<ListTeamMembersResult> -
Lists all the user profiles configured for your AWS account in AWS CodeStar.
Declaration
Swift
public func listUserProfiles(_ input: ListUserProfilesRequest) -> EventLoopFuture<ListUserProfilesResult> -
Adds tags to a project.
Declaration
Swift
public func tagProject(_ input: TagProjectRequest) -> EventLoopFuture<TagProjectResult> -
Removes tags from a project.
Declaration
Swift
public func untagProject(_ input: UntagProjectRequest) -> EventLoopFuture<UntagProjectResult> -
Updates a project in AWS CodeStar.
Declaration
Swift
public func updateProject(_ input: UpdateProjectRequest) -> EventLoopFuture<UpdateProjectResult> -
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.
Declaration
Swift
public func updateTeamMember(_ input: UpdateTeamMemberRequest) -> EventLoopFuture<UpdateTeamMemberResult> -
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.
Declaration
Swift
public func updateUserProfile(_ input: UpdateUserProfileRequest) -> EventLoopFuture<UpdateUserProfileResult>