Icon

AWS CodeStar (version v1.*.*)

associate_team_member

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

Parameters

$body

Type: object

{
"clientRequestToken" : "A user- or system-generated token that identifies the entity that requested the team member association to the project. This token can be used to repeat the request.",
"projectRole" : "The AWS CodeStar project role that will apply to this user. This role determines what actions a user can take in an AWS CodeStar project.",
"remoteAccessAllowed" : "Whether the team member is allowed to use an SSH public/private key pair to remotely access project resources, for example Amazon EC2 instances.",
"userArn" : "The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.",
"projectId" : "The ID of the project to which you will add the IAM user."
}

create_project

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.

Parameters

$body

Type: object

{
"sourceCode" : [ {
"destination" : {
"gitHub" : {
"owner" : "The GitHub username for the owner of the GitHub repository to be created in AWS CodeStar. If this repository should be owned by a GitHub organization, provide its name.",
"issuesEnabled" : "Whether to enable issues for the GitHub repository.",
"name" : "Name of the GitHub repository to be created in AWS CodeStar.",
"description" : "Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after the repository is created.",
"privateRepository" : "Whether the GitHub repository is to be a private repository.",
"type" : "The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.",
"token" : "The GitHub user's personal access token for the GitHub repository."
},
"codeCommit" : {
"name" : "The name of the AWS CodeCommit repository to be created in AWS CodeStar."
}
},
"source" : {
"s3" : {
"bucketName" : "The Amazon S3 bucket name where the source code files provided with the project request are stored.",
"bucketKey" : "The Amazon S3 object key where the source code files provided with the project request are stored."
}
}
} ],
"clientRequestToken" : "A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request.",
"name" : "The display name for the project to be created in AWS CodeStar.",
"description" : "The description of the project, if any.",
"id" : "The ID of the project to be created in AWS CodeStar.",
"toolchain" : {
"roleArn" : "The service role ARN for AWS CodeStar to use for the toolchain template during stack provisioning.",
"stackParameters" : "The list of parameter overrides to be passed into the toolchain template during stack provisioning, if any.",
"source" : {
"s3" : {
"bucketName" : "The Amazon S3 bucket name where the source code files provided with the project request are stored.",
"bucketKey" : "The Amazon S3 object key where the source code files provided with the project request are stored."
}
}
},
"tags" : "The tags created for the project."
}

create_user_profile

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.

Parameters

$body

Type: object

{
"sshPublicKey" : "The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.",
"emailAddress" : "The email address that will be displayed as part of the user's profile in AWS CodeStar.",
"displayName" : "The name that will be displayed as the friendly name for the user in AWS CodeStar. ",
"userArn" : "The Amazon Resource Name (ARN) of the user in IAM."
}

delete_project

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.

Parameters

$body

Type: object

{
"clientRequestToken" : "A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request. ",
"deleteStack" : "Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources. This option will delete all AWS resources for the project (except for any buckets in Amazon S3) as well as deleting the project itself. Recommended for most use cases.",
"id" : "The ID of the project to be deleted in AWS CodeStar."
}

delete_user_profile

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.

Parameters

$body

Type: object

{
"userArn" : "The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar."
}

describe_project

Describes a project and its resources.

Parameters

$body

Type: object

{
"id" : "The ID of the project."
}

describe_user_profile

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

Parameters

$body

Type: object

{
"userArn" : "The Amazon Resource Name (ARN) of the user."
}

disassociate_team_member

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.

Parameters

$body

Type: object

{
"userArn" : "The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove from the project.",
"projectId" : "The ID of the AWS CodeStar project from which you want to remove a team member."
}

list_projects

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

This operation has no parameters

list_resources

Lists resources associated with a project in AWS CodeStar.

Parameters

$body

Type: object

{
"projectId" : "The ID of the project."
}

list_tags_for_project

Gets the tags for a project.

Parameters

$body

Type: object

{
"nextToken" : "Reserved for future use.",
"maxResults" : "Reserved for future use.",
"id" : "The ID of the project to get tags for."
}

list_team_members

Lists all team members associated with a project.

Parameters

$body

Type: object

{
"projectId" : "The ID of the project for which you want to list team members."
}

list_user_profiles

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

This operation has no parameters

tag_project

Adds tags to a project.

Parameters

$body

Type: object

{
"id" : "The ID of the project you want to add a tag to.",
"tags" : "The tags you want to add to the project."
}

untag_project

Removes tags from a project.

Parameters

$body

Type: object

{
"id" : "The ID of the project to remove tags from.",
"tags" : [ "string" ]
}

update_project

Updates a project in AWS CodeStar.

Parameters

$body

Type: object

{
"name" : "The name of the project you want to update.",
"description" : "The description of the project, if any.",
"id" : "The ID of the project you want to update."
}

update_team_member

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.

Parameters

$body

Type: object

{
"projectRole" : "The role assigned to the user in the project. Project roles have different levels of access. For more information, see Working with Teams in the AWS CodeStar User Guide.",
"remoteAccessAllowed" : "Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile. Even if this is set to True, the user must associate a public key with their profile before the user can access resources.",
"userArn" : "The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.",
"projectId" : "The ID of the project."
}

update_user_profile

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.

Parameters

$body

Type: object

{
"sshPublicKey" : "The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.",
"emailAddress" : "The email address that is displayed as part of the user's profile in AWS CodeStar.",
"displayName" : "The name that is displayed as the friendly name for the user in AWS CodeStar.",
"userArn" : "The name that will be displayed as the friendly name for the user in AWS CodeStar."
}