AWS CodeStar 2017-04-19
- Client: Aws\CodeStar\CodeStarClient
- Service ID: codestar
- Version: 2017-04-19
This page describes the parameters and results for the operations of the AWS CodeStar (2017-04-19), and shows how to use the Aws\CodeStar\CodeStarClient object to call the described operations. This documentation is specific to the 2017-04-19 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateTeamMember ( array $params = [] )
Adds an IAM user to the team for an AWS CodeStar project.
- CreateProject ( array $params = [] )
Creates a project, including project resources.
- CreateUserProfile ( array $params = [] )
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.
- DeleteProject ( array $params = [] )
Deletes a project, including project resources.
- DeleteUserProfile ( array $params = [] )
Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address.
- DescribeProject ( array $params = [] )
Describes a project and its resources.
- DescribeUserProfile ( array $params = [] )
Describes a user in AWS CodeStar and the user attributes across all projects.
- DisassociateTeamMember ( array $params = [] )
Removes a user from a project.
- ListProjects ( array $params = [] )
Lists all projects in AWS CodeStar associated with your AWS account.
- ListResources ( array $params = [] )
Lists resources associated with a project in AWS CodeStar.
- ListTagsForProject ( array $params = [] )
Gets the tags for a project.
- ListTeamMembers ( array $params = [] )
Lists all team members associated with a project.
- ListUserProfiles ( array $params = [] )
Lists all the user profiles configured for your AWS account in AWS CodeStar.
- TagProject ( array $params = [] )
Adds tags to a project.
- UntagProject ( array $params = [] )
Removes tags from a project.
- UpdateProject ( array $params = [] )
Updates a project in AWS CodeStar.
- UpdateTeamMember ( array $params = [] )
Updates a team member's attributes in an AWS CodeStar project.
- UpdateUserProfile ( array $params = [] )
Updates a user's profile in AWS CodeStar.
Operations
AssociateTeamMember
$result = $client->associateTeamMember([/* ... */]); $promise = $client->associateTeamMemberAsync([/* ... */]);
Adds an IAM user to the team for an AWS CodeStar project.
Parameter Syntax
$result = $client->associateTeamMember([
'clientRequestToken' => '<string>',
'projectId' => '<string>', // REQUIRED
'projectRole' => '<string>', // REQUIRED
'remoteAccessAllowed' => true || false,
'userArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientRequestToken
-
- Type: string
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.
- projectId
-
- Required: Yes
- Type: string
The ID of the project to which you will add the IAM user.
- projectRole
-
- Required: Yes
- Type: string
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
-
- Type: boolean
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
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.
Result Syntax
[
'clientRequestToken' => '<string>',
]
Result Details
Members
Errors
-
A resource limit has been exceeded.
-
The specified AWS CodeStar project was not found.
-
TeamMemberAlreadyAssociatedException:
The team member is already associated with a role in this project.
-
The specified input is either not valid, or it could not be validated.
-
The service role is not valid.
-
ProjectConfigurationException:
Project configuration information is required but not specified.
-
ConcurrentModificationException:
Another modification is being made. That modification must complete before you can make your change.
CreateProject
$result = $client->createProject([/* ... */]); $promise = $client->createProjectAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createProject([
'clientRequestToken' => '<string>',
'description' => '<string>',
'id' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'sourceCode' => [
[
'destination' => [ // REQUIRED
'codeCommit' => [
'name' => '<string>', // REQUIRED
],
'gitHub' => [
'description' => '<string>',
'issuesEnabled' => true || false, // REQUIRED
'name' => '<string>', // REQUIRED
'owner' => '<string>', // REQUIRED
'privateRepository' => true || false, // REQUIRED
'token' => '<string>', // REQUIRED
'type' => '<string>', // REQUIRED
],
],
'source' => [ // REQUIRED
's3' => [ // REQUIRED
'bucketKey' => '<string>',
'bucketName' => '<string>',
],
],
],
// ...
],
'tags' => ['<string>', ...],
'toolchain' => [
'roleArn' => '<string>',
'source' => [ // REQUIRED
's3' => [ // REQUIRED
'bucketKey' => '<string>',
'bucketName' => '<string>',
],
],
'stackParameters' => ['<string>', ...],
],
]);
Parameter Details
Members
- clientRequestToken
-
- Type: string
A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request.
- description
-
- Type: string
The description of the project, if any.
- id
-
- Required: Yes
- Type: string
The ID of the project to be created in AWS CodeStar.
- name
-
- Required: Yes
- Type: string
The display name for the project to be created in AWS CodeStar.
- sourceCode
-
- Type: Array of Code structures
A list of the Code objects submitted with the project request. If this parameter is specified, the request must also include the toolchain parameter.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags created for the project.
- toolchain
-
- Type: Toolchain structure
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.
Result Syntax
[
'arn' => '<string>',
'clientRequestToken' => '<string>',
'id' => '<string>',
'projectTemplateId' => '<string>',
]
Result Details
Members
- arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the created project.
- clientRequestToken
-
- Type: string
A user- or system-generated token that identifies the entity that requested project creation.
- id
-
- Required: Yes
- Type: string
The ID of the project.
- projectTemplateId
-
- Type: string
Reserved for future use.
Errors
-
ProjectAlreadyExistsException:
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.
-
A resource limit has been exceeded.
-
The specified input is either not valid, or it could not be validated.
-
ProjectCreationFailedException:
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.
-
The service role is not valid.
-
ProjectConfigurationException:
Project configuration information is required but not specified.
-
ConcurrentModificationException:
Another modification is being made. That modification must complete before you can make your change.
CreateUserProfile
$result = $client->createUserProfile([/* ... */]); $promise = $client->createUserProfileAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createUserProfile([
'displayName' => '<string>', // REQUIRED
'emailAddress' => '<string>', // REQUIRED
'sshPublicKey' => '<string>',
'userArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- displayName
-
- Required: Yes
- Type: string
The name that will be displayed as the friendly name for the user in AWS CodeStar.
- emailAddress
-
- Required: Yes
- Type: string
The email address that will be displayed as part of the user's profile in AWS CodeStar.
- sshPublicKey
-
- Type: 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.
- userArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the user in IAM.
Result Syntax
[
'createdTimestamp' => <DateTime>,
'displayName' => '<string>',
'emailAddress' => '<string>',
'lastModifiedTimestamp' => <DateTime>,
'sshPublicKey' => '<string>',
'userArn' => '<string>',
]
Result Details
Members
- createdTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the user profile was created, in timestamp format.
- displayName
-
- Type: string
The name that is displayed as the friendly name for the user in AWS CodeStar.
- emailAddress
-
- Type: string
The email address that is displayed as part of the user's profile in AWS CodeStar.
- lastModifiedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the user profile was last modified, in timestamp format.
- sshPublicKey
-
- Type: 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.
- userArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the user in IAM.
Errors
-
UserProfileAlreadyExistsException:
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.
-
The specified input is either not valid, or it could not be validated.
DeleteProject
$result = $client->deleteProject([/* ... */]); $promise = $client->deleteProjectAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteProject([
'clientRequestToken' => '<string>',
'deleteStack' => true || false,
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientRequestToken
-
- Type: string
A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request.
- deleteStack
-
- Type: boolean
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
-
- Required: Yes
- Type: string
The ID of the project to be deleted in AWS CodeStar.
Result Syntax
[
'projectArn' => '<string>',
'stackId' => '<string>',
]
Result Details
Members
Errors
-
ConcurrentModificationException:
Another modification is being made. That modification must complete before you can make your change.
-
The specified input is either not valid, or it could not be validated.
-
The service role is not valid.
DeleteUserProfile
$result = $client->deleteUserProfile([/* ... */]); $promise = $client->deleteUserProfileAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteUserProfile([
'userArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'userArn' => '<string>',
]
Result Details
Members
Errors
-
The specified input is either not valid, or it could not be validated.
DescribeProject
$result = $client->describeProject([/* ... */]); $promise = $client->describeProjectAsync([/* ... */]);
Describes a project and its resources.
Parameter Syntax
$result = $client->describeProject([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'arn' => '<string>',
'clientRequestToken' => '<string>',
'createdTimeStamp' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'name' => '<string>',
'projectTemplateId' => '<string>',
'stackId' => '<string>',
'status' => [
'reason' => '<string>',
'state' => '<string>',
],
]
Result Details
Members
- arn
-
- Type: string
The Amazon Resource Name (ARN) for the project.
- clientRequestToken
-
- Type: string
A user- or system-generated token that identifies the entity that requested project creation.
- createdTimeStamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time the project was created, in timestamp format.
- description
-
- Type: string
The description of the project, if any.
- id
-
- Type: string
The ID of the project.
- name
-
- Type: string
The display name for the project.
- projectTemplateId
-
- Type: string
The ID for the AWS CodeStar project template used to create the project.
- stackId
-
- Type: string
The ID of the primary stack in AWS CloudFormation used to generate resources for the project.
- status
-
- Type: ProjectStatus structure
The project creation or deletion status.
Errors
-
The specified AWS CodeStar project was not found.
-
The specified input is either not valid, or it could not be validated.
-
The service role is not valid.
-
ProjectConfigurationException:
Project configuration information is required but not specified.
-
ConcurrentModificationException:
Another modification is being made. That modification must complete before you can make your change.
DescribeUserProfile
$result = $client->describeUserProfile([/* ... */]); $promise = $client->describeUserProfileAsync([/* ... */]);
Describes a user in AWS CodeStar and the user attributes across all projects.
Parameter Syntax
$result = $client->describeUserProfile([
'userArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'createdTimestamp' => <DateTime>,
'displayName' => '<string>',
'emailAddress' => '<string>',
'lastModifiedTimestamp' => <DateTime>,
'sshPublicKey' => '<string>',
'userArn' => '<string>',
]
Result Details
Members
- createdTimestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the user profile was created in AWS CodeStar, in timestamp format.
- displayName
-
- Type: string
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").
- emailAddress
-
- Type: string
The email address for the user. Optional.
- lastModifiedTimestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the user profile was last modified, in timestamp format.
- sshPublicKey
-
- Type: string
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.
- userArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the user.
Errors
-
The user profile was not found.
-
The specified input is either not valid, or it could not be validated.
DisassociateTeamMember
$result = $client->disassociateTeamMember([/* ... */]); $promise = $client->disassociateTeamMemberAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->disassociateTeamMember([
'projectId' => '<string>', // REQUIRED
'userArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified AWS CodeStar project was not found.
-
The specified input is either not valid, or it could not be validated.
-
The service role is not valid.
-
ConcurrentModificationException:
Another modification is being made. That modification must complete before you can make your change.
ListProjects
$result = $client->listProjects([/* ... */]); $promise = $client->listProjectsAsync([/* ... */]);
Lists all projects in AWS CodeStar associated with your AWS account.
Parameter Syntax
$result = $client->listProjects([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'projects' => [
[
'projectArn' => '<string>',
'projectId' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The continuation token to use when requesting the next set of results, if there are more results to be returned.
- projects
-
- Required: Yes
- Type: Array of ProjectSummary structures
A list of projects.
Errors
-
The next token is not valid.
-
The specified input is either not valid, or it could not be validated.
ListResources
$result = $client->listResources([/* ... */]); $promise = $client->listResourcesAsync([/* ... */]);
Lists resources associated with a project in AWS CodeStar.
Parameter Syntax
$result = $client->listResources([
'maxResults' => <integer>,
'nextToken' => '<string>',
'projectId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'resources' => [
[
'id' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The continuation token to use when requesting the next set of results, if there are more results to be returned.
- resources
-
- Type: Array of Resource structures
An array of resources associated with the project.
Errors
-
The specified AWS CodeStar project was not found.
-
The next token is not valid.
-
The specified input is either not valid, or it could not be validated.
ListTagsForProject
$result = $client->listTagsForProject([/* ... */]); $promise = $client->listTagsForProjectAsync([/* ... */]);
Gets the tags for a project.
Parameter Syntax
$result = $client->listTagsForProject([
'id' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
The specified AWS CodeStar project was not found.
-
The specified input is either not valid, or it could not be validated.
-
The next token is not valid.
ListTeamMembers
$result = $client->listTeamMembers([/* ... */]); $promise = $client->listTeamMembersAsync([/* ... */]);
Lists all team members associated with a project.
Parameter Syntax
$result = $client->listTeamMembers([
'maxResults' => <integer>,
'nextToken' => '<string>',
'projectId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of team members you want returned in a response.
- nextToken
-
- Type: string
The continuation token for the next set of results, if the results cannot be returned in one response.
- projectId
-
- Required: Yes
- Type: string
The ID of the project for which you want to list team members.
Result Syntax
[
'nextToken' => '<string>',
'teamMembers' => [
[
'projectRole' => '<string>',
'remoteAccessAllowed' => true || false,
'userArn' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The continuation token to use when requesting the next set of results, if there are more results to be returned.
- teamMembers
-
- Required: Yes
- Type: Array of TeamMember structures
A list of team member objects for the project.
Errors
-
The specified AWS CodeStar project was not found.
-
The next token is not valid.
-
The specified input is either not valid, or it could not be validated.
ListUserProfiles
$result = $client->listUserProfiles([/* ... */]); $promise = $client->listUserProfilesAsync([/* ... */]);
Lists all the user profiles configured for your AWS account in AWS CodeStar.
Parameter Syntax
$result = $client->listUserProfiles([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'userProfiles' => [
[
'displayName' => '<string>',
'emailAddress' => '<string>',
'sshPublicKey' => '<string>',
'userArn' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The continuation token to use when requesting the next set of results, if there are more results to be returned.
- userProfiles
-
- Required: Yes
- Type: Array of UserProfileSummary structures
All the user profiles configured in AWS CodeStar for an AWS account.
Errors
-
The next token is not valid.
-
The specified input is either not valid, or it could not be validated.
TagProject
$result = $client->tagProject([/* ... */]); $promise = $client->tagProjectAsync([/* ... */]);
Adds tags to a project.
Parameter Syntax
$result = $client->tagProject([
'id' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
The specified AWS CodeStar project was not found.
-
The specified input is either not valid, or it could not be validated.
-
A resource limit has been exceeded.
-
ConcurrentModificationException:
Another modification is being made. That modification must complete before you can make your change.
UntagProject
$result = $client->untagProject([/* ... */]); $promise = $client->untagProjectAsync([/* ... */]);
Removes tags from a project.
Parameter Syntax
$result = $client->untagProject([
'id' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified AWS CodeStar project was not found.
-
The specified input is either not valid, or it could not be validated.
-
A resource limit has been exceeded.
-
ConcurrentModificationException:
Another modification is being made. That modification must complete before you can make your change.
UpdateProject
$result = $client->updateProject([/* ... */]); $promise = $client->updateProjectAsync([/* ... */]);
Updates a project in AWS CodeStar.
Parameter Syntax
$result = $client->updateProject([
'description' => '<string>',
'id' => '<string>', // REQUIRED
'name' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified AWS CodeStar project was not found.
-
The specified input is either not valid, or it could not be validated.
UpdateTeamMember
$result = $client->updateTeamMember([/* ... */]); $promise = $client->updateTeamMemberAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateTeamMember([
'projectId' => '<string>', // REQUIRED
'projectRole' => '<string>',
'remoteAccessAllowed' => true || false,
'userArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- projectId
-
- Required: Yes
- Type: string
The ID of the project.
- projectRole
-
- Type: 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
-
- Type: boolean
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
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.
Result Syntax
[
'projectRole' => '<string>',
'remoteAccessAllowed' => true || false,
'userArn' => '<string>',
]
Result Details
Members
- projectRole
-
- Type: string
The project role granted to the user.
- remoteAccessAllowed
-
- Type: boolean
Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile.
- userArn
-
- Type: string
The Amazon Resource Name (ARN) of the user whose team membership attributes were updated.
Errors
-
A resource limit has been exceeded.
-
The specified AWS CodeStar project was not found.
-
The specified input is either not valid, or it could not be validated.
-
The service role is not valid.
-
ProjectConfigurationException:
Project configuration information is required but not specified.
-
ConcurrentModificationException:
Another modification is being made. That modification must complete before you can make your change.
-
The specified team member was not found.
UpdateUserProfile
$result = $client->updateUserProfile([/* ... */]); $promise = $client->updateUserProfileAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateUserProfile([
'displayName' => '<string>',
'emailAddress' => '<string>',
'sshPublicKey' => '<string>',
'userArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- displayName
-
- Type: string
The name that is displayed as the friendly name for the user in AWS CodeStar.
- emailAddress
-
- Type: string
The email address that is displayed as part of the user's profile in AWS CodeStar.
- sshPublicKey
-
- Type: 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.
- userArn
-
- Required: Yes
- Type: string
The name that will be displayed as the friendly name for the user in AWS CodeStar.
Result Syntax
[
'createdTimestamp' => <DateTime>,
'displayName' => '<string>',
'emailAddress' => '<string>',
'lastModifiedTimestamp' => <DateTime>,
'sshPublicKey' => '<string>',
'userArn' => '<string>',
]
Result Details
Members
- createdTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the user profile was created, in timestamp format.
- displayName
-
- Type: string
The name that is displayed as the friendly name for the user in AWS CodeStar.
- emailAddress
-
- Type: string
The email address that is displayed as part of the user's profile in AWS CodeStar.
- lastModifiedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the user profile was last modified, in timestamp format.
- sshPublicKey
-
- Type: 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.
- userArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the user in IAM.
Errors
-
The user profile was not found.
-
The specified input is either not valid, or it could not be validated.
Shapes
Code
Description
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.
Members
- destination
-
- Required: Yes
- Type: CodeDestination structure
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.
- source
-
- Required: Yes
- Type: CodeSource structure
The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.
CodeCommitCodeDestination
Description
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.
Members
CodeDestination
Description
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.
Members
- codeCommit
-
- Type: CodeCommitCodeDestination structure
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.
- gitHub
-
- Type: GitHubCodeDestination structure
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.
CodeSource
Description
The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.
Members
- s3
-
- Required: Yes
- Type: S3Location structure
Information about the Amazon S3 location where the source code files provided with the project request are stored.
ConcurrentModificationException
Description
Another modification is being made. That modification must complete before you can make your change.
Members
GitHubCodeDestination
Description
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.
Members
- description
-
- Type: string
Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after the repository is created.
- issuesEnabled
-
- Required: Yes
- Type: boolean
Whether to enable issues for the GitHub repository.
- name
-
- Required: Yes
- Type: string
Name of the GitHub repository to be created in AWS CodeStar.
- owner
-
- Required: Yes
- Type: string
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.
- privateRepository
-
- Required: Yes
- Type: boolean
Whether the GitHub repository is to be a private repository.
- token
-
- Required: Yes
- Type: string
The GitHub user's personal access token for the GitHub repository.
- type
-
- Required: Yes
- Type: string
The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.
InvalidNextTokenException
Description
The next token is not valid.
Members
InvalidServiceRoleException
Description
The service role is not valid.
Members
LimitExceededException
Description
A resource limit has been exceeded.
Members
ProjectAlreadyExistsException
Description
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.
Members
ProjectConfigurationException
Description
Project configuration information is required but not specified.
Members
ProjectCreationFailedException
Description
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.
Members
ProjectNotFoundException
Description
The specified AWS CodeStar project was not found.
Members
ProjectStatus
Description
An indication of whether a project creation or deletion is failed or successful.
Members
ProjectSummary
Description
Information about the metadata for a project.
Members
Resource
Description
Information about a resource for a project.
Members
S3Location
Description
The Amazon S3 location where the source code files provided with the project request are stored.
Members
TeamMember
Description
Information about a team member in a project.
Members
- projectRole
-
- Required: Yes
- Type: 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
-
- Type: boolean
Whether the user is allowed to remotely access project resources using an SSH public/private key pair.
- userArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the user in IAM.
TeamMemberAlreadyAssociatedException
Description
The team member is already associated with a role in this project.
Members
TeamMemberNotFoundException
Description
The specified team member was not found.
Members
Toolchain
Description
The toolchain template file provided with the project request. AWS CodeStar uses the template to provision the toolchain stack in AWS CloudFormation.
Members
- roleArn
-
- Type: string
The service role ARN for AWS CodeStar to use for the toolchain template during stack provisioning.
- source
-
- Required: Yes
- Type: ToolchainSource structure
The Amazon S3 location where the toolchain template file provided with the project request is stored. AWS CodeStar retrieves the file during project creation.
- stackParameters
-
- Type: Associative array of custom strings keys (TemplateParameterKey) to strings
The list of parameter overrides to be passed into the toolchain template during stack provisioning, if any.
ToolchainSource
Description
The Amazon S3 location where the toolchain template file provided with the project request is stored. AWS CodeStar retrieves the file during project creation.
Members
- s3
-
- Required: Yes
- Type: S3Location structure
The Amazon S3 bucket where the toolchain template file provided with the project request is stored.
UserProfileAlreadyExistsException
Description
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.
Members
UserProfileNotFoundException
Description
The user profile was not found.
Members
UserProfileSummary
Description
Information about a user's profile in AWS CodeStar.
Members
- displayName
-
- Type: 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
-
- Type: string
The email address associated with the user.
- sshPublicKey
-
- Type: 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.
- userArn
-
- Type: string
The Amazon Resource Name (ARN) of the user in IAM.
ValidationException
Description
The specified input is either not valid, or it could not be validated.