{
"version": "2.0",
"service": "
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.
Adds an IAM user to the team for an AWS CodeStar project.
", "CreateProject": "Reserved for future use. To create a project, use the AWS CodeStar console.
", "CreateUserProfile": "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": "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": "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": "Describes a project and its resources.
", "DescribeUserProfile": "Describes a user in AWS CodeStar and the user attributes across all projects.
", "DisassociateTeamMember": "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": "Lists all projects in AWS CodeStar associated with your AWS account.
", "ListResources": "Lists resources associated with a project in AWS CodeStar.
", "ListTagsForProject": "Gets the tags for a project.
", "ListTeamMembers": "Lists all team members associated with a project.
", "ListUserProfiles": "Lists all the user profiles configured for your AWS account in AWS CodeStar.
", "TagProject": "Adds tags to a project.
", "UntagProject": "Removes tags from a project.
", "UpdateProject": "Updates a project in AWS CodeStar.
", "UpdateTeamMember": "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": "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.
" }, "shapes": { "AssociateTeamMemberRequest": { "base": null, "refs": { } }, "AssociateTeamMemberResult": { "base": null, "refs": { } }, "ClientRequestToken": { "base": null, "refs": { "AssociateTeamMemberRequest$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.
", "AssociateTeamMemberResult$clientRequestToken": "The user- or system-generated token from the initial request that can be used to repeat the request.
", "CreateProjectRequest$clientRequestToken": "Reserved for future use.
", "CreateProjectResult$clientRequestToken": "Reserved for future use.
", "DeleteProjectRequest$clientRequestToken": "A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request.
", "DescribeProjectResult$clientRequestToken": "A user- or system-generated token that identifies the entity that requested project creation.
" } }, "ConcurrentModificationException": { "base": "Another modification is being made. That modification must complete before you can make your change.
", "refs": { } }, "CreateProjectRequest": { "base": null, "refs": { } }, "CreateProjectResult": { "base": null, "refs": { } }, "CreateUserProfileRequest": { "base": null, "refs": { } }, "CreateUserProfileResult": { "base": null, "refs": { } }, "CreatedTimestamp": { "base": null, "refs": { "CreateUserProfileResult$createdTimestamp": "The date the user profile was created, in timestamp format.
", "DescribeProjectResult$createdTimeStamp": "The date and time the project was created, in timestamp format.
", "DescribeUserProfileResult$createdTimestamp": "The date and time when the user profile was created in AWS CodeStar, in timestamp format.
", "UpdateUserProfileResult$createdTimestamp": "The date the user profile was created, in timestamp format.
" } }, "DeleteProjectRequest": { "base": null, "refs": { } }, "DeleteProjectResult": { "base": null, "refs": { } }, "DeleteStack": { "base": null, "refs": { "DeleteProjectRequest$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.
" } }, "DeleteUserProfileRequest": { "base": null, "refs": { } }, "DeleteUserProfileResult": { "base": null, "refs": { } }, "DescribeProjectRequest": { "base": null, "refs": { } }, "DescribeProjectResult": { "base": null, "refs": { } }, "DescribeUserProfileRequest": { "base": null, "refs": { } }, "DescribeUserProfileResult": { "base": null, "refs": { } }, "DisassociateTeamMemberRequest": { "base": null, "refs": { } }, "DisassociateTeamMemberResult": { "base": null, "refs": { } }, "Email": { "base": null, "refs": { "CreateUserProfileRequest$emailAddress": "The email address that will be displayed as part of the user's profile in AWS CodeStar.
", "CreateUserProfileResult$emailAddress": "The email address that is displayed as part of the user's profile in AWS CodeStar.
", "DescribeUserProfileResult$emailAddress": "The email address for the user. Optional.
", "UpdateUserProfileRequest$emailAddress": "The email address that is displayed as part of the user's profile in AWS CodeStar.
", "UpdateUserProfileResult$emailAddress": "The email address that is displayed as part of the user's profile in AWS CodeStar.
", "UserProfileSummary$emailAddress": "The email address associated with the user.
" } }, "InvalidNextTokenException": { "base": "The next token is not valid.
", "refs": { } }, "InvalidServiceRoleException": { "base": "The service role is not valid.
", "refs": { } }, "LastModifiedTimestamp": { "base": null, "refs": { "CreateUserProfileResult$lastModifiedTimestamp": "The date the user profile was last modified, in timestamp format.
", "DescribeUserProfileResult$lastModifiedTimestamp": "The date and time when the user profile was last modified, in timestamp format.
", "UpdateUserProfileResult$lastModifiedTimestamp": "The date the user profile was last modified, in timestamp format.
" } }, "LimitExceededException": { "base": "A resource limit has been exceeded.
", "refs": { } }, "ListProjectsRequest": { "base": null, "refs": { } }, "ListProjectsResult": { "base": null, "refs": { } }, "ListResourcesRequest": { "base": null, "refs": { } }, "ListResourcesResult": { "base": null, "refs": { } }, "ListTagsForProjectRequest": { "base": null, "refs": { } }, "ListTagsForProjectResult": { "base": null, "refs": { } }, "ListTeamMembersRequest": { "base": null, "refs": { } }, "ListTeamMembersResult": { "base": null, "refs": { } }, "ListUserProfilesRequest": { "base": null, "refs": { } }, "ListUserProfilesResult": { "base": null, "refs": { } }, "MaxResults": { "base": null, "refs": { "ListProjectsRequest$maxResults": "The maximum amount of data that can be contained in a single set of results.
", "ListResourcesRequest$maxResults": "The maximum amount of data that can be contained in a single set of results.
", "ListTagsForProjectRequest$maxResults": "Reserved for future use.
", "ListTeamMembersRequest$maxResults": "The maximum number of team members you want returned in a response.
", "ListUserProfilesRequest$maxResults": "The maximum number of results to return in a response.
" } }, "PaginationToken": { "base": null, "refs": { "ListProjectsRequest$nextToken": "The continuation token to be used to return the next set of results, if the results cannot be returned in one response.
", "ListProjectsResult$nextToken": "The continuation token to use when requesting the next set of results, if there are more results to be returned.
", "ListResourcesRequest$nextToken": "The continuation token for the next set of results, if the results cannot be returned in one response.
", "ListResourcesResult$nextToken": "The continuation token to use when requesting the next set of results, if there are more results to be returned.
", "ListTagsForProjectRequest$nextToken": "Reserved for future use.
", "ListTagsForProjectResult$nextToken": "Reserved for future use.
", "ListTeamMembersRequest$nextToken": "The continuation token for the next set of results, if the results cannot be returned in one response.
", "ListTeamMembersResult$nextToken": "The continuation token to use when requesting the next set of results, if there are more results to be returned.
", "ListUserProfilesRequest$nextToken": "The continuation token for the next set of results, if the results cannot be returned in one response.
", "ListUserProfilesResult$nextToken": "The continuation token to use when requesting the next set of results, if there are more results to be returned.
" } }, "ProjectAlreadyExistsException": { "base": "An AWS CodeStar project with the same ID already exists in this region for the AWS account. AWS CodeStar project IDs must be unique within a region for the AWS account.
", "refs": { } }, "ProjectArn": { "base": null, "refs": { "CreateProjectResult$arn": "Reserved for future use.
", "DeleteProjectResult$projectArn": "The Amazon Resource Name (ARN) of the deleted project.
", "DescribeProjectResult$arn": "The Amazon Resource Name (ARN) for the project.
", "ProjectSummary$projectArn": "The Amazon Resource Name (ARN) of the project.
" } }, "ProjectConfigurationException": { "base": "Project configuration information is required but not specified.
", "refs": { } }, "ProjectCreationFailedException": { "base": "The project creation request was valid, but a nonspecific exception or error occurred during project creation. The project could not be created in AWS CodeStar.
", "refs": { } }, "ProjectDescription": { "base": null, "refs": { "CreateProjectRequest$description": "Reserved for future use.
", "DescribeProjectResult$description": "The description of the project, if any.
", "UpdateProjectRequest$description": "The description of the project, if any.
" } }, "ProjectId": { "base": null, "refs": { "AssociateTeamMemberRequest$projectId": "The ID of the project to which you will add the IAM user.
", "CreateProjectRequest$id": "Reserved for future use.
", "CreateProjectResult$id": "Reserved for future use.
", "DeleteProjectRequest$id": "The ID of the project to be deleted in AWS CodeStar.
", "DescribeProjectRequest$id": "The ID of the project.
", "DescribeProjectResult$id": "The ID of the project.
", "DisassociateTeamMemberRequest$projectId": "The ID of the AWS CodeStar project from which you want to remove a team member.
", "ListResourcesRequest$projectId": "The ID of the project.
", "ListTagsForProjectRequest$id": "The ID of the project to get tags for.
", "ListTeamMembersRequest$projectId": "The ID of the project for which you want to list team members.
", "ProjectSummary$projectId": "The ID of the project.
", "TagProjectRequest$id": "The ID of the project you want to add a tag to.
", "UntagProjectRequest$id": "The ID of the project to remove tags from.
", "UpdateProjectRequest$id": "The ID of the project you want to update.
", "UpdateTeamMemberRequest$projectId": "The ID of the project.
" } }, "ProjectName": { "base": null, "refs": { "CreateProjectRequest$name": "Reserved for future use.
", "DescribeProjectResult$name": "The display name for the project.
", "UpdateProjectRequest$name": "The name of the project you want to update.
" } }, "ProjectNotFoundException": { "base": "The specified AWS CodeStar project was not found.
", "refs": { } }, "ProjectSummary": { "base": "Information about the metadata for a project.
", "refs": { "ProjectsList$member": null } }, "ProjectTemplateId": { "base": null, "refs": { "CreateProjectResult$projectTemplateId": "Reserved for future use.
", "DescribeProjectResult$projectTemplateId": "The ID for the AWS CodeStar project template used to create the project.
" } }, "ProjectsList": { "base": null, "refs": { "ListProjectsResult$projects": "A list of projects.
" } }, "RemoteAccessAllowed": { "base": null, "refs": { "AssociateTeamMemberRequest$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.
", "TeamMember$remoteAccessAllowed": "Whether the user is allowed to remotely access project resources using an SSH public/private key pair.
", "UpdateTeamMemberRequest$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.
", "UpdateTeamMemberResult$remoteAccessAllowed": "Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile.
" } }, "Resource": { "base": "Information about a resource for a project.
", "refs": { "ResourcesResult$member": null } }, "ResourceId": { "base": null, "refs": { "Resource$id": "The Amazon Resource Name (ARN) of the resource.
" } }, "ResourcesResult": { "base": null, "refs": { "ListResourcesResult$resources": "An array of resources associated with the project.
" } }, "Role": { "base": null, "refs": { "AssociateTeamMemberRequest$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.
", "TeamMember$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.
", "UpdateTeamMemberRequest$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.
", "UpdateTeamMemberResult$projectRole": "The project role granted to the user.
" } }, "SshPublicKey": { "base": null, "refs": { "CreateUserProfileRequest$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.
", "CreateUserProfileResult$sshPublicKey": "The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project owner allows the user remote access to those resources.
", "DescribeUserProfileResult$sshPublicKey": "The SSH public key associated with the user. This SSH public key is associated with the user profile, and can be used in conjunction with the associated private key for access to project resources, such as Amazon EC2 instances, if a project owner grants remote access to those resources.
", "UpdateUserProfileRequest$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.
", "UpdateUserProfileResult$sshPublicKey": "The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project owner allows the user remote access to those resources.
", "UserProfileSummary$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.
" } }, "StackId": { "base": null, "refs": { "DeleteProjectResult$stackId": "The ID of the primary stack in AWS CloudFormation that will be deleted as part of deleting the project and its resources.
", "DescribeProjectResult$stackId": "The ID of the primary stack in AWS CloudFormation used to generate resources for the project.
" } }, "TagKey": { "base": null, "refs": { "TagKeys$member": null, "Tags$key": null } }, "TagKeys": { "base": null, "refs": { "UntagProjectRequest$tags": "The tags to remove from the project.
" } }, "TagProjectRequest": { "base": null, "refs": { } }, "TagProjectResult": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tags$value": null } }, "Tags": { "base": null, "refs": { "ListTagsForProjectResult$tags": "The tags for the project.
", "TagProjectRequest$tags": "The tags you want to add to the project.
", "TagProjectResult$tags": "The tags for the project.
" } }, "TeamMember": { "base": "Information about a team member in a project.
", "refs": { "TeamMemberResult$member": null } }, "TeamMemberAlreadyAssociatedException": { "base": "The team member is already associated with a role in this project.
", "refs": { } }, "TeamMemberNotFoundException": { "base": "The specified team member was not found.
", "refs": { } }, "TeamMemberResult": { "base": null, "refs": { "ListTeamMembersResult$teamMembers": "A list of team member objects for the project.
" } }, "UntagProjectRequest": { "base": null, "refs": { } }, "UntagProjectResult": { "base": null, "refs": { } }, "UpdateProjectRequest": { "base": null, "refs": { } }, "UpdateProjectResult": { "base": null, "refs": { } }, "UpdateTeamMemberRequest": { "base": null, "refs": { } }, "UpdateTeamMemberResult": { "base": null, "refs": { } }, "UpdateUserProfileRequest": { "base": null, "refs": { } }, "UpdateUserProfileResult": { "base": null, "refs": { } }, "UserArn": { "base": null, "refs": { "AssociateTeamMemberRequest$userArn": "The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.
", "CreateUserProfileRequest$userArn": "The Amazon Resource Name (ARN) of the user in IAM.
", "CreateUserProfileResult$userArn": "The Amazon Resource Name (ARN) of the user in IAM.
", "DeleteUserProfileRequest$userArn": "The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.
", "DeleteUserProfileResult$userArn": "The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar.
", "DescribeUserProfileRequest$userArn": "The Amazon Resource Name (ARN) of the user.
", "DescribeUserProfileResult$userArn": "The Amazon Resource Name (ARN) of the user.
", "DisassociateTeamMemberRequest$userArn": "The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove from the project.
", "TeamMember$userArn": "The Amazon Resource Name (ARN) of the user in IAM.
", "UpdateTeamMemberRequest$userArn": "The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.
", "UpdateTeamMemberResult$userArn": "The Amazon Resource Name (ARN) of the user whose team membership attributes were updated.
", "UpdateUserProfileRequest$userArn": "The name that will be displayed as the friendly name for the user in AWS CodeStar.
", "UpdateUserProfileResult$userArn": "The Amazon Resource Name (ARN) of the user in IAM.
", "UserProfileSummary$userArn": "The Amazon Resource Name (ARN) of the user in IAM.
" } }, "UserProfileAlreadyExistsException": { "base": "A user profile with that name already exists in this region for the AWS account. AWS CodeStar user profile names must be unique within a region for the AWS account.
", "refs": { } }, "UserProfileDisplayName": { "base": null, "refs": { "CreateUserProfileRequest$displayName": "The name that will be displayed as the friendly name for the user in AWS CodeStar.
", "CreateUserProfileResult$displayName": "The name that is displayed as the friendly name for the user in AWS CodeStar.
", "DescribeUserProfileResult$displayName": "The display name shown for the user in AWS CodeStar projects. For example, this could be set to both first and last name (\"Mary Major\") or a single name (\"Mary\"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example \"Mary Jane Major\") would generate an initial icon using the first character and the first character after the space (\"MJ\", not \"MM\").
", "UpdateUserProfileRequest$displayName": "The name that is displayed as the friendly name for the user in AWS CodeStar.
", "UpdateUserProfileResult$displayName": "The name that is displayed as the friendly name for the user in AWS CodeStar.
", "UserProfileSummary$displayName": "The display name of a user in AWS CodeStar. For example, this could be set to both first and last name (\"Mary Major\") or a single name (\"Mary\"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example \"Mary Jane Major\") would generate an initial icon using the first character and the first character after the space (\"MJ\", not \"MM\").
" } }, "UserProfileNotFoundException": { "base": "The user profile was not found.
", "refs": { } }, "UserProfileSummary": { "base": "Information about a user's profile in AWS CodeStar.
", "refs": { "UserProfilesList$member": null } }, "UserProfilesList": { "base": null, "refs": { "ListUserProfilesResult$userProfiles": "All the user profiles configured in AWS CodeStar for an AWS account.
" } }, "ValidationException": { "base": "The specified input is either not valid, or it could not be validated.
", "refs": { } } } }