Table of Contents
A low-level client representing 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:
import boto3
client = boto3.client('codestar')
These are the available methods:
Adds an IAM user to the team for an AWS CodeStar project.
See also: AWS API Documentation
Request Syntax
response = client.associate_team_member(
projectId='string',
clientRequestToken='string',
userArn='string',
projectRole='string',
remoteAccessAllowed=True|False
)
[REQUIRED]
The ID of the project to which you will add the IAM user.
[REQUIRED]
The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.
[REQUIRED]
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.
dict
Response Syntax
{
'clientRequestToken': 'string'
}
Response Structure
(dict) --
clientRequestToken (string) --
The user- or system-generated token from the initial request that can be used to repeat the request.
Exceptions
Check if an operation can be paginated.
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.
See also: AWS API Documentation
Request Syntax
response = client.create_project(
name='string',
id='string',
description='string',
clientRequestToken='string',
sourceCode=[
{
'source': {
's3': {
'bucketName': 'string',
'bucketKey': 'string'
}
},
'destination': {
'codeCommit': {
'name': 'string'
},
'gitHub': {
'name': 'string',
'description': 'string',
'type': 'string',
'owner': 'string',
'privateRepository': True|False,
'issuesEnabled': True|False,
'token': 'string'
}
}
},
],
toolchain={
'source': {
's3': {
'bucketName': 'string',
'bucketKey': 'string'
}
},
'roleArn': 'string',
'stackParameters': {
'string': 'string'
}
},
tags={
'string': 'string'
}
)
[REQUIRED]
The display name for the project to be created in AWS CodeStar.
[REQUIRED]
The ID of the project to be created in AWS CodeStar.
A list of the Code objects submitted with the project request. If this parameter is specified, the request must also include the toolchain parameter.
Location and destination information about the source code files provided with the project request. The source code is uploaded to the new project source repository after project creation.
The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.
Information about the Amazon S3 location where the source code files provided with the project request are stored.
The Amazon S3 bucket name where the source code files provided with the project request are stored.
The Amazon S3 object key where the source code files provided with the project request are stored.
The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or GitHub. After AWS CodeStar provisions the new repository, the source code files provided with the project request are placed in the repository.
Information about the AWS CodeCommit repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.
The name of the AWS CodeCommit repository to be created in AWS CodeStar.
Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.
Name of the GitHub repository to be created in AWS CodeStar.
Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after the repository is created.
The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.
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.
Whether the GitHub repository is to be a private repository.
Whether to enable issues for the GitHub repository.
The GitHub user's personal access token for the GitHub repository.
The name of the toolchain template file submitted with the project request. If this parameter is specified, the request must also include the sourceCode parameter.
The Amazon S3 location where the toolchain template file provided with the project request is stored. AWS CodeStar retrieves the file during project creation.
The Amazon S3 bucket where the toolchain template file provided with the project request is stored.
The Amazon S3 bucket name where the source code files provided with the project request are stored.
The Amazon S3 object key where the source code files provided with the project request are stored.
The service role ARN for AWS CodeStar to use for the toolchain template during stack provisioning.
The list of parameter overrides to be passed into the toolchain template during stack provisioning, if any.
The tags created for the project.
dict
Response Syntax
{
'id': 'string',
'arn': 'string',
'clientRequestToken': 'string',
'projectTemplateId': 'string'
}
Response Structure
(dict) --
id (string) --
The ID of the project.
arn (string) --
The Amazon Resource Name (ARN) of the created project.
clientRequestToken (string) --
A user- or system-generated token that identifies the entity that requested project creation.
projectTemplateId (string) --
Reserved for future use.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.create_user_profile(
userArn='string',
displayName='string',
emailAddress='string',
sshPublicKey='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the user in IAM.
[REQUIRED]
The name that will be displayed as the friendly name for the user in AWS CodeStar.
[REQUIRED]
The email address that will be displayed as part of the user's profile in AWS CodeStar.
dict
Response Syntax
{
'userArn': 'string',
'displayName': 'string',
'emailAddress': 'string',
'sshPublicKey': 'string',
'createdTimestamp': datetime(2015, 1, 1),
'lastModifiedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
userArn (string) --
The Amazon Resource Name (ARN) of the user in IAM.
displayName (string) --
The name that is displayed as the friendly name for the user in AWS CodeStar.
emailAddress (string) --
The email address that is displayed as part of the user's profile in AWS CodeStar.
sshPublicKey (string) --
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.
createdTimestamp (datetime) --
The date the user profile was created, in timestamp format.
lastModifiedTimestamp (datetime) --
The date the user profile was last modified, in timestamp format.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_project(
id='string',
clientRequestToken='string',
deleteStack=True|False
)
[REQUIRED]
The ID of the project to be deleted in AWS CodeStar.
dict
Response Syntax
{
'stackId': 'string',
'projectArn': 'string'
}
Response Structure
(dict) --
stackId (string) --
The ID of the primary stack in AWS CloudFormation that will be deleted as part of deleting the project and its resources.
projectArn (string) --
The Amazon Resource Name (ARN) of the deleted project.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_user_profile(
userArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.
{
'userArn': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar.
Exceptions
Describes a project and its resources.
See also: AWS API Documentation
Request Syntax
response = client.describe_project(
id='string'
)
[REQUIRED]
The ID of the project.
{
'name': 'string',
'id': 'string',
'arn': 'string',
'description': 'string',
'clientRequestToken': 'string',
'createdTimeStamp': datetime(2015, 1, 1),
'stackId': 'string',
'projectTemplateId': 'string',
'status': {
'state': 'string',
'reason': 'string'
}
}
Response Structure
The display name for the project.
The ID of the project.
The Amazon Resource Name (ARN) for the project.
The description of the project, if any.
A user- or system-generated token that identifies the entity that requested project creation.
The date and time the project was created, in timestamp format.
The ID of the primary stack in AWS CloudFormation used to generate resources for the project.
The ID for the AWS CodeStar project template used to create the project.
The project creation or deletion status.
The phase of completion for a project creation or deletion.
In the case of a project creation or deletion failure, a reason for the failure.
Exceptions
Describes a user in AWS CodeStar and the user attributes across all projects.
See also: AWS API Documentation
Request Syntax
response = client.describe_user_profile(
userArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the user.
{
'userArn': 'string',
'displayName': 'string',
'emailAddress': 'string',
'sshPublicKey': 'string',
'createdTimestamp': datetime(2015, 1, 1),
'lastModifiedTimestamp': datetime(2015, 1, 1)
}
Response Structure
The Amazon Resource Name (ARN) of the user.
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").
The email address for the user. Optional.
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.
The date and time when the user profile was created in AWS CodeStar, in timestamp format.
The date and time when the user profile was last modified, in timestamp format.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_team_member(
projectId='string',
userArn='string'
)
[REQUIRED]
The ID of the AWS CodeStar project from which you want to remove a team member.
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove from the project.
dict
Response Syntax
{}
Response Structure
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
Lists all projects in AWS CodeStar associated with your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_projects(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'projects': [
{
'projectId': 'string',
'projectArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
projects (list) --
A list of projects.
(dict) --
Information about the metadata for a project.
projectId (string) --
The ID of the project.
projectArn (string) --
The Amazon Resource Name (ARN) of the project.
nextToken (string) --
The continuation token to use when requesting the next set of results, if there are more results to be returned.
Exceptions
Lists resources associated with a project in AWS CodeStar.
See also: AWS API Documentation
Request Syntax
response = client.list_resources(
projectId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The ID of the project.
dict
Response Syntax
{
'resources': [
{
'id': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
resources (list) --
An array of resources associated with the project.
(dict) --
Information about a resource for a project.
id (string) --
The Amazon Resource Name (ARN) of the resource.
nextToken (string) --
The continuation token to use when requesting the next set of results, if there are more results to be returned.
Exceptions
Gets the tags for a project.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_project(
id='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The ID of the project to get tags for.
dict
Response Syntax
{
'tags': {
'string': 'string'
},
'nextToken': 'string'
}
Response Structure
(dict) --
tags (dict) --
The tags for the project.
nextToken (string) --
Reserved for future use.
Exceptions
Lists all team members associated with a project.
See also: AWS API Documentation
Request Syntax
response = client.list_team_members(
projectId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The ID of the project for which you want to list team members.
dict
Response Syntax
{
'teamMembers': [
{
'userArn': 'string',
'projectRole': 'string',
'remoteAccessAllowed': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
teamMembers (list) --
A list of team member objects for the project.
(dict) --
Information about a team member in a project.
userArn (string) --
The Amazon Resource Name (ARN) of the user in IAM.
projectRole (string) --
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 (boolean) --
Whether the user is allowed to remotely access project resources using an SSH public/private key pair.
nextToken (string) --
The continuation token to use when requesting the next set of results, if there are more results to be returned.
Exceptions
Lists all the user profiles configured for your AWS account in AWS CodeStar.
See also: AWS API Documentation
Request Syntax
response = client.list_user_profiles(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'userProfiles': [
{
'userArn': 'string',
'displayName': 'string',
'emailAddress': 'string',
'sshPublicKey': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
userProfiles (list) --
All the user profiles configured in AWS CodeStar for an AWS account.
(dict) --
Information about a user's profile in AWS CodeStar.
userArn (string) --
The Amazon Resource Name (ARN) of the user in IAM.
displayName (string) --
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").
emailAddress (string) --
The email address associated with the user.
sshPublicKey (string) --
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.
nextToken (string) --
The continuation token to use when requesting the next set of results, if there are more results to be returned.
Exceptions
Adds tags to a project.
See also: AWS API Documentation
Request Syntax
response = client.tag_project(
id='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The ID of the project you want to add a tag to.
[REQUIRED]
The tags you want to add to the project.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
The tags for the project.
Exceptions
Removes tags from a project.
See also: AWS API Documentation
Request Syntax
response = client.untag_project(
id='string',
tags=[
'string',
]
)
[REQUIRED]
The ID of the project to remove tags from.
[REQUIRED]
The tags to remove from the project.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates a project in AWS CodeStar.
See also: AWS API Documentation
Request Syntax
response = client.update_project(
id='string',
name='string',
description='string'
)
[REQUIRED]
The ID of the project you want to update.
dict
Response Syntax
{}
Response Structure
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.update_team_member(
projectId='string',
userArn='string',
projectRole='string',
remoteAccessAllowed=True|False
)
[REQUIRED]
The ID of the project.
[REQUIRED]
The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.
dict
Response Syntax
{
'userArn': 'string',
'projectRole': 'string',
'remoteAccessAllowed': True|False
}
Response Structure
(dict) --
userArn (string) --
The Amazon Resource Name (ARN) of the user whose team membership attributes were updated.
projectRole (string) --
The project role granted to the user.
remoteAccessAllowed (boolean) --
Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.update_user_profile(
userArn='string',
displayName='string',
emailAddress='string',
sshPublicKey='string'
)
[REQUIRED]
The name that will be displayed as the friendly name for the user in AWS CodeStar.
dict
Response Syntax
{
'userArn': 'string',
'displayName': 'string',
'emailAddress': 'string',
'sshPublicKey': 'string',
'createdTimestamp': datetime(2015, 1, 1),
'lastModifiedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
userArn (string) --
The Amazon Resource Name (ARN) of the user in IAM.
displayName (string) --
The name that is displayed as the friendly name for the user in AWS CodeStar.
emailAddress (string) --
The email address that is displayed as part of the user's profile in AWS CodeStar.
sshPublicKey (string) --
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.
createdTimestamp (datetime) --
The date the user profile was created, in timestamp format.
lastModifiedTimestamp (datetime) --
The date the user profile was last modified, in timestamp format.
Exceptions
The available paginators are:
paginator = client.get_paginator('list_projects')
Creates an iterator that will paginate through responses from CodeStar.Client.list_projects().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'projects': [
{
'projectId': 'string',
'projectArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
A list of projects.
Information about the metadata for a project.
The ID of the project.
The Amazon Resource Name (ARN) of the project.
A token to resume pagination.
paginator = client.get_paginator('list_resources')
Creates an iterator that will paginate through responses from CodeStar.Client.list_resources().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
projectId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the project.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'resources': [
{
'id': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
resources (list) --
An array of resources associated with the project.
(dict) --
Information about a resource for a project.
id (string) --
The Amazon Resource Name (ARN) of the resource.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_team_members')
Creates an iterator that will paginate through responses from CodeStar.Client.list_team_members().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
projectId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the project for which you want to list team members.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'teamMembers': [
{
'userArn': 'string',
'projectRole': 'string',
'remoteAccessAllowed': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
teamMembers (list) --
A list of team member objects for the project.
(dict) --
Information about a team member in a project.
userArn (string) --
The Amazon Resource Name (ARN) of the user in IAM.
projectRole (string) --
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 (boolean) --
Whether the user is allowed to remotely access project resources using an SSH public/private key pair.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_user_profiles')
Creates an iterator that will paginate through responses from CodeStar.Client.list_user_profiles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'userProfiles': [
{
'userArn': 'string',
'displayName': 'string',
'emailAddress': 'string',
'sshPublicKey': 'string'
},
],
'NextToken': 'string'
}
Response Structure
All the user profiles configured in AWS CodeStar for an AWS account.
Information about a user's profile in AWS CodeStar.
The Amazon Resource Name (ARN) of the user in IAM.
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").
The email address associated with the user.
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.
A token to resume pagination.