The AWS CodeStar API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• Code (p. 65)
• CodeCommitCodeDestination (p. 66)
• CodeDestination (p. 67)
• CodeSource (p. 68)
• GitHubCodeDestination (p. 69)
• ProjectStatus (p. 71)
• ProjectSummary (p. 72)
• Resource (p. 73)
• S3Location (p. 74)
• TeamMember (p. 75)
• Toolchain (p. 76)
• ToolchainSource (p. 77)
• UserProfileSummary (p. 78)
Code
Code
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.
Contents
destination
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.
Type: CodeDestination (p. 67) object Required: Yes
source
The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.
Type: CodeSource (p. 68) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CodeCommitCodeDestination
CodeCommitCodeDestination
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.
Contents
name
The name of the AWS CodeCommit repository to be created in AWS CodeStar.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^\S[\w.-]*$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CodeDestination
CodeDestination
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.
Contents
codeCommit
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.
Type: CodeCommitCodeDestination (p. 66) object Required: No
gitHub
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.
Type: GitHubCodeDestination (p. 69) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CodeSource
CodeSource
The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.
Contents
s3
Information about the Amazon S3 location where the source code files provided with the project request are stored.
Type: S3Location (p. 74) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
GitHubCodeDestination
GitHubCodeDestination
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.
Contents
description
Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after the repository is created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: ^\S(.*\S)?$
Required: No issuesEnabled
Whether to enable issues for the GitHub repository.
Type: Boolean Required: Yes name
Name of the GitHub repository to be created in AWS CodeStar.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^\S[\w.-]*$
Required: Yes 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^\S(.*\S)?$
Required: Yes privateRepository
Whether the GitHub repository is to be a private repository.
Type: Boolean Required: Yes token
The GitHub user's personal access token for the GitHub repository.
See Also
Type: String
Length Constraints: Minimum length of 1.
Required: Yes type
The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.
Type: String
Pattern: ^(user|organization|User|Organization)$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ProjectStatus
ProjectStatus
An indication of whether a project creation or deletion is failed or successful.
Contents
reason
In the case of a project creation or deletion failure, a reason for the failure.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: ^$|^\S(.*\S)?$
Required: No state
The phase of completion for a project creation or deletion.
Type: String
Pattern: ^(CreateInProgress|CreateComplete|CreateFailed|DeleteComplete|
DeleteFailed|DeleteInProgress|UpdateComplete|UpdateInProgress|UpdateFailed|
Unknown)$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ProjectSummary
ProjectSummary
Information about the metadata for a project.
Contents
projectArn
The Amazon Resource Name (ARN) of the project.
Type: String
Pattern: ^arn:aws[^:\s]*:codestar:[^:\s]+:[0-9]{12}:project\/[a-z]([a-z0-9|-])+$
Required: No projectId
The ID of the project.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 15.
Pattern: ^[a-z][a-z0-9-]+$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Resource
Resource
Information about a resource for a project.
Contents
id
The Amazon Resource Name (ARN) of the resource.
Type: String
Length Constraints: Minimum length of 11.
Pattern: (^arn\:aws\:\S.*\:.*)|(^amzn1\.ask\.skill\.[0-9a-f\-]+) Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
S3Location
S3Location
The Amazon S3 location where the source code files provided with the project request are stored.
Contents
bucketKey
The Amazon S3 object key where the source code files provided with the project request are stored.
Type: String Required: Yes bucketName
The Amazon S3 bucket name where the source code files provided with the project request are stored.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
TeamMember
TeamMember
Information about a team member in a project.
Contents
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.
Type: String
Pattern: ^(Owner|Viewer|Contributor)$
Required: Yes remoteAccessAllowed
Whether the user is allowed to remotely access project resources using an SSH public/private key pair.
Type: Boolean Required: No userArn
The Amazon Resource Name (ARN) of the user in IAM.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 95.
Pattern: ^arn:aws:iam::\d{12}:user(?:(\u002F)|(\u002F[\u0021-\u007E]+\u002F)) [\w+=,.@-]+$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Toolchain
Toolchain
The toolchain template file provided with the project request. AWS CodeStar uses the template to provision the toolchain stack in AWS CloudFormation.
Contents
roleArn
The service role ARN for AWS CodeStar to use for the toolchain template during stack provisioning.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Required: No source
The Amazon S3 location where the toolchain template file provided with the project request is stored. AWS CodeStar retrieves the file during project creation.
Type: ToolchainSource (p. 77) object Required: Yes
stackParameters
The list of parameter overrides to be passed into the toolchain template during stack provisioning, if any.
Type: String to string map
Map Entries: Maximum number of 25 items.
Key Length Constraints: Minimum length of 1. Maximum length of 30.
Key Pattern: ^\S(.*\S)?$
Value Length Constraints: Minimum length of 1. Maximum length of 150.
Value Pattern: ^\S(.*\S)?$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ToolchainSource
ToolchainSource
The Amazon S3 location where the toolchain template file provided with the project request is stored.
AWS CodeStar retrieves the file during project creation.
Contents
s3
The Amazon S3 bucket where the toolchain template file provided with the project request is stored.
Type: S3Location (p. 74) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3