| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CodeStar.Lens
Contents
Description
Synopsis
- listProjects_nextToken :: Lens' ListProjects (Maybe Text)
- listProjects_maxResults :: Lens' ListProjects (Maybe Natural)
- listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text)
- listProjectsResponse_httpStatus :: Lens' ListProjectsResponse Int
- listProjectsResponse_projects :: Lens' ListProjectsResponse [ProjectSummary]
- listTeamMembers_nextToken :: Lens' ListTeamMembers (Maybe Text)
- listTeamMembers_maxResults :: Lens' ListTeamMembers (Maybe Natural)
- listTeamMembers_projectId :: Lens' ListTeamMembers Text
- listTeamMembersResponse_nextToken :: Lens' ListTeamMembersResponse (Maybe Text)
- listTeamMembersResponse_httpStatus :: Lens' ListTeamMembersResponse Int
- listTeamMembersResponse_teamMembers :: Lens' ListTeamMembersResponse [TeamMember]
- deleteProject_deleteStack :: Lens' DeleteProject (Maybe Bool)
- deleteProject_clientRequestToken :: Lens' DeleteProject (Maybe Text)
- deleteProject_id :: Lens' DeleteProject Text
- deleteProjectResponse_projectArn :: Lens' DeleteProjectResponse (Maybe Text)
- deleteProjectResponse_stackId :: Lens' DeleteProjectResponse (Maybe Text)
- deleteProjectResponse_httpStatus :: Lens' DeleteProjectResponse Int
- updateProject_name :: Lens' UpdateProject (Maybe Text)
- updateProject_description :: Lens' UpdateProject (Maybe Text)
- updateProject_id :: Lens' UpdateProject Text
- updateProjectResponse_httpStatus :: Lens' UpdateProjectResponse Int
- disassociateTeamMember_projectId :: Lens' DisassociateTeamMember Text
- disassociateTeamMember_userArn :: Lens' DisassociateTeamMember Text
- disassociateTeamMemberResponse_httpStatus :: Lens' DisassociateTeamMemberResponse Int
- tagProject_id :: Lens' TagProject Text
- tagProject_tags :: Lens' TagProject (HashMap Text Text)
- tagProjectResponse_tags :: Lens' TagProjectResponse (Maybe (HashMap Text Text))
- tagProjectResponse_httpStatus :: Lens' TagProjectResponse Int
- describeProject_id :: Lens' DescribeProject Text
- describeProjectResponse_status :: Lens' DescribeProjectResponse (Maybe ProjectStatus)
- describeProjectResponse_arn :: Lens' DescribeProjectResponse (Maybe Text)
- describeProjectResponse_projectTemplateId :: Lens' DescribeProjectResponse (Maybe Text)
- describeProjectResponse_name :: Lens' DescribeProjectResponse (Maybe Text)
- describeProjectResponse_id :: Lens' DescribeProjectResponse (Maybe Text)
- describeProjectResponse_stackId :: Lens' DescribeProjectResponse (Maybe Text)
- describeProjectResponse_clientRequestToken :: Lens' DescribeProjectResponse (Maybe Text)
- describeProjectResponse_createdTimeStamp :: Lens' DescribeProjectResponse (Maybe UTCTime)
- describeProjectResponse_description :: Lens' DescribeProjectResponse (Maybe Text)
- describeProjectResponse_httpStatus :: Lens' DescribeProjectResponse Int
- listUserProfiles_nextToken :: Lens' ListUserProfiles (Maybe Text)
- listUserProfiles_maxResults :: Lens' ListUserProfiles (Maybe Natural)
- listUserProfilesResponse_nextToken :: Lens' ListUserProfilesResponse (Maybe Text)
- listUserProfilesResponse_httpStatus :: Lens' ListUserProfilesResponse Int
- listUserProfilesResponse_userProfiles :: Lens' ListUserProfilesResponse [UserProfileSummary]
- listResources_nextToken :: Lens' ListResources (Maybe Text)
- listResources_maxResults :: Lens' ListResources (Maybe Natural)
- listResources_projectId :: Lens' ListResources Text
- listResourcesResponse_resources :: Lens' ListResourcesResponse (Maybe [Resource])
- listResourcesResponse_nextToken :: Lens' ListResourcesResponse (Maybe Text)
- listResourcesResponse_httpStatus :: Lens' ListResourcesResponse Int
- associateTeamMember_remoteAccessAllowed :: Lens' AssociateTeamMember (Maybe Bool)
- associateTeamMember_clientRequestToken :: Lens' AssociateTeamMember (Maybe Text)
- associateTeamMember_projectId :: Lens' AssociateTeamMember Text
- associateTeamMember_userArn :: Lens' AssociateTeamMember Text
- associateTeamMember_projectRole :: Lens' AssociateTeamMember Text
- associateTeamMemberResponse_clientRequestToken :: Lens' AssociateTeamMemberResponse (Maybe Text)
- associateTeamMemberResponse_httpStatus :: Lens' AssociateTeamMemberResponse Int
- untagProject_id :: Lens' UntagProject Text
- untagProject_tags :: Lens' UntagProject [Text]
- untagProjectResponse_httpStatus :: Lens' UntagProjectResponse Int
- updateTeamMember_remoteAccessAllowed :: Lens' UpdateTeamMember (Maybe Bool)
- updateTeamMember_projectRole :: Lens' UpdateTeamMember (Maybe Text)
- updateTeamMember_projectId :: Lens' UpdateTeamMember Text
- updateTeamMember_userArn :: Lens' UpdateTeamMember Text
- updateTeamMemberResponse_userArn :: Lens' UpdateTeamMemberResponse (Maybe Text)
- updateTeamMemberResponse_remoteAccessAllowed :: Lens' UpdateTeamMemberResponse (Maybe Bool)
- updateTeamMemberResponse_projectRole :: Lens' UpdateTeamMemberResponse (Maybe Text)
- updateTeamMemberResponse_httpStatus :: Lens' UpdateTeamMemberResponse Int
- describeUserProfile_userArn :: Lens' DescribeUserProfile Text
- describeUserProfileResponse_sshPublicKey :: Lens' DescribeUserProfileResponse (Maybe Text)
- describeUserProfileResponse_emailAddress :: Lens' DescribeUserProfileResponse (Maybe Text)
- describeUserProfileResponse_displayName :: Lens' DescribeUserProfileResponse (Maybe Text)
- describeUserProfileResponse_httpStatus :: Lens' DescribeUserProfileResponse Int
- describeUserProfileResponse_userArn :: Lens' DescribeUserProfileResponse Text
- describeUserProfileResponse_createdTimestamp :: Lens' DescribeUserProfileResponse UTCTime
- describeUserProfileResponse_lastModifiedTimestamp :: Lens' DescribeUserProfileResponse UTCTime
- listTagsForProject_nextToken :: Lens' ListTagsForProject (Maybe Text)
- listTagsForProject_maxResults :: Lens' ListTagsForProject (Maybe Natural)
- listTagsForProject_id :: Lens' ListTagsForProject Text
- listTagsForProjectResponse_nextToken :: Lens' ListTagsForProjectResponse (Maybe Text)
- listTagsForProjectResponse_tags :: Lens' ListTagsForProjectResponse (Maybe (HashMap Text Text))
- listTagsForProjectResponse_httpStatus :: Lens' ListTagsForProjectResponse Int
- deleteUserProfile_userArn :: Lens' DeleteUserProfile Text
- deleteUserProfileResponse_httpStatus :: Lens' DeleteUserProfileResponse Int
- deleteUserProfileResponse_userArn :: Lens' DeleteUserProfileResponse Text
- updateUserProfile_sshPublicKey :: Lens' UpdateUserProfile (Maybe Text)
- updateUserProfile_emailAddress :: Lens' UpdateUserProfile (Maybe Text)
- updateUserProfile_displayName :: Lens' UpdateUserProfile (Maybe Text)
- updateUserProfile_userArn :: Lens' UpdateUserProfile Text
- updateUserProfileResponse_lastModifiedTimestamp :: Lens' UpdateUserProfileResponse (Maybe UTCTime)
- updateUserProfileResponse_sshPublicKey :: Lens' UpdateUserProfileResponse (Maybe Text)
- updateUserProfileResponse_emailAddress :: Lens' UpdateUserProfileResponse (Maybe Text)
- updateUserProfileResponse_displayName :: Lens' UpdateUserProfileResponse (Maybe Text)
- updateUserProfileResponse_createdTimestamp :: Lens' UpdateUserProfileResponse (Maybe UTCTime)
- updateUserProfileResponse_httpStatus :: Lens' UpdateUserProfileResponse Int
- updateUserProfileResponse_userArn :: Lens' UpdateUserProfileResponse Text
- createUserProfile_sshPublicKey :: Lens' CreateUserProfile (Maybe Text)
- createUserProfile_userArn :: Lens' CreateUserProfile Text
- createUserProfile_displayName :: Lens' CreateUserProfile Text
- createUserProfile_emailAddress :: Lens' CreateUserProfile Text
- createUserProfileResponse_lastModifiedTimestamp :: Lens' CreateUserProfileResponse (Maybe UTCTime)
- createUserProfileResponse_sshPublicKey :: Lens' CreateUserProfileResponse (Maybe Text)
- createUserProfileResponse_emailAddress :: Lens' CreateUserProfileResponse (Maybe Text)
- createUserProfileResponse_displayName :: Lens' CreateUserProfileResponse (Maybe Text)
- createUserProfileResponse_createdTimestamp :: Lens' CreateUserProfileResponse (Maybe UTCTime)
- createUserProfileResponse_httpStatus :: Lens' CreateUserProfileResponse Int
- createUserProfileResponse_userArn :: Lens' CreateUserProfileResponse Text
- createProject_sourceCode :: Lens' CreateProject (Maybe [Code])
- createProject_toolchain :: Lens' CreateProject (Maybe Toolchain)
- createProject_clientRequestToken :: Lens' CreateProject (Maybe Text)
- createProject_description :: Lens' CreateProject (Maybe Text)
- createProject_tags :: Lens' CreateProject (Maybe (HashMap Text Text))
- createProject_name :: Lens' CreateProject Text
- createProject_id :: Lens' CreateProject Text
- createProjectResponse_projectTemplateId :: Lens' CreateProjectResponse (Maybe Text)
- createProjectResponse_clientRequestToken :: Lens' CreateProjectResponse (Maybe Text)
- createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int
- createProjectResponse_id :: Lens' CreateProjectResponse Text
- createProjectResponse_arn :: Lens' CreateProjectResponse Text
- code_source :: Lens' Code CodeSource
- code_destination :: Lens' Code CodeDestination
- codeCommitCodeDestination_name :: Lens' CodeCommitCodeDestination Text
- codeDestination_codeCommit :: Lens' CodeDestination (Maybe CodeCommitCodeDestination)
- codeDestination_gitHub :: Lens' CodeDestination (Maybe GitHubCodeDestination)
- codeSource_s3 :: Lens' CodeSource S3Location
- gitHubCodeDestination_description :: Lens' GitHubCodeDestination (Maybe Text)
- gitHubCodeDestination_name :: Lens' GitHubCodeDestination Text
- gitHubCodeDestination_type :: Lens' GitHubCodeDestination Text
- gitHubCodeDestination_owner :: Lens' GitHubCodeDestination Text
- gitHubCodeDestination_privateRepository :: Lens' GitHubCodeDestination Bool
- gitHubCodeDestination_issuesEnabled :: Lens' GitHubCodeDestination Bool
- gitHubCodeDestination_token :: Lens' GitHubCodeDestination Text
- projectStatus_reason :: Lens' ProjectStatus (Maybe Text)
- projectStatus_state :: Lens' ProjectStatus Text
- projectSummary_projectArn :: Lens' ProjectSummary (Maybe Text)
- projectSummary_projectId :: Lens' ProjectSummary (Maybe Text)
- resource_id :: Lens' Resource Text
- s3Location_bucketKey :: Lens' S3Location (Maybe Text)
- s3Location_bucketName :: Lens' S3Location (Maybe Text)
- teamMember_remoteAccessAllowed :: Lens' TeamMember (Maybe Bool)
- teamMember_userArn :: Lens' TeamMember Text
- teamMember_projectRole :: Lens' TeamMember Text
- toolchain_stackParameters :: Lens' Toolchain (Maybe (HashMap Text Text))
- toolchain_roleArn :: Lens' Toolchain (Maybe Text)
- toolchain_source :: Lens' Toolchain ToolchainSource
- toolchainSource_s3 :: Lens' ToolchainSource S3Location
- userProfileSummary_sshPublicKey :: Lens' UserProfileSummary (Maybe Text)
- userProfileSummary_userArn :: Lens' UserProfileSummary (Maybe Text)
- userProfileSummary_emailAddress :: Lens' UserProfileSummary (Maybe Text)
- userProfileSummary_displayName :: Lens' UserProfileSummary (Maybe Text)
Operations
ListProjects
listProjects_nextToken :: Lens' ListProjects (Maybe Text) Source #
The continuation token to be used to return the next set of results, if the results cannot be returned in one response.
listProjects_maxResults :: Lens' ListProjects (Maybe Natural) Source #
The maximum amount of data that can be contained in a single set of results.
listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text) Source #
The continuation token to use when requesting the next set of results, if there are more results to be returned.
listProjectsResponse_httpStatus :: Lens' ListProjectsResponse Int Source #
The response's http status code.
listProjectsResponse_projects :: Lens' ListProjectsResponse [ProjectSummary] Source #
A list of projects.
ListTeamMembers
listTeamMembers_nextToken :: Lens' ListTeamMembers (Maybe Text) Source #
The continuation token for the next set of results, if the results cannot be returned in one response.
listTeamMembers_maxResults :: Lens' ListTeamMembers (Maybe Natural) Source #
The maximum number of team members you want returned in a response.
listTeamMembers_projectId :: Lens' ListTeamMembers Text Source #
The ID of the project for which you want to list team members.
listTeamMembersResponse_nextToken :: Lens' ListTeamMembersResponse (Maybe Text) Source #
The continuation token to use when requesting the next set of results, if there are more results to be returned.
listTeamMembersResponse_httpStatus :: Lens' ListTeamMembersResponse Int Source #
The response's http status code.
listTeamMembersResponse_teamMembers :: Lens' ListTeamMembersResponse [TeamMember] Source #
A list of team member objects for the project.
DeleteProject
deleteProject_deleteStack :: Lens' DeleteProject (Maybe Bool) Source #
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.
deleteProject_clientRequestToken :: Lens' DeleteProject (Maybe Text) Source #
A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request.
deleteProject_id :: Lens' DeleteProject Text Source #
The ID of the project to be deleted in AWS CodeStar.
deleteProjectResponse_projectArn :: Lens' DeleteProjectResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the deleted project.
deleteProjectResponse_stackId :: Lens' DeleteProjectResponse (Maybe Text) Source #
The ID of the primary stack in AWS CloudFormation that will be deleted as part of deleting the project and its resources.
deleteProjectResponse_httpStatus :: Lens' DeleteProjectResponse Int Source #
The response's http status code.
UpdateProject
updateProject_name :: Lens' UpdateProject (Maybe Text) Source #
The name of the project you want to update.
updateProject_description :: Lens' UpdateProject (Maybe Text) Source #
The description of the project, if any.
updateProject_id :: Lens' UpdateProject Text Source #
The ID of the project you want to update.
updateProjectResponse_httpStatus :: Lens' UpdateProjectResponse Int Source #
The response's http status code.
DisassociateTeamMember
disassociateTeamMember_projectId :: Lens' DisassociateTeamMember Text Source #
The ID of the AWS CodeStar project from which you want to remove a team member.
disassociateTeamMember_userArn :: Lens' DisassociateTeamMember Text Source #
The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove from the project.
disassociateTeamMemberResponse_httpStatus :: Lens' DisassociateTeamMemberResponse Int Source #
The response's http status code.
TagProject
tagProject_id :: Lens' TagProject Text Source #
The ID of the project you want to add a tag to.
tagProject_tags :: Lens' TagProject (HashMap Text Text) Source #
The tags you want to add to the project.
tagProjectResponse_tags :: Lens' TagProjectResponse (Maybe (HashMap Text Text)) Source #
The tags for the project.
tagProjectResponse_httpStatus :: Lens' TagProjectResponse Int Source #
The response's http status code.
DescribeProject
describeProject_id :: Lens' DescribeProject Text Source #
The ID of the project.
describeProjectResponse_status :: Lens' DescribeProjectResponse (Maybe ProjectStatus) Source #
The project creation or deletion status.
describeProjectResponse_arn :: Lens' DescribeProjectResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) for the project.
describeProjectResponse_projectTemplateId :: Lens' DescribeProjectResponse (Maybe Text) Source #
The ID for the AWS CodeStar project template used to create the project.
describeProjectResponse_name :: Lens' DescribeProjectResponse (Maybe Text) Source #
The display name for the project.
describeProjectResponse_id :: Lens' DescribeProjectResponse (Maybe Text) Source #
The ID of the project.
describeProjectResponse_stackId :: Lens' DescribeProjectResponse (Maybe Text) Source #
The ID of the primary stack in AWS CloudFormation used to generate resources for the project.
describeProjectResponse_clientRequestToken :: Lens' DescribeProjectResponse (Maybe Text) Source #
A user- or system-generated token that identifies the entity that requested project creation.
describeProjectResponse_createdTimeStamp :: Lens' DescribeProjectResponse (Maybe UTCTime) Source #
The date and time the project was created, in timestamp format.
describeProjectResponse_description :: Lens' DescribeProjectResponse (Maybe Text) Source #
The description of the project, if any.
describeProjectResponse_httpStatus :: Lens' DescribeProjectResponse Int Source #
The response's http status code.
ListUserProfiles
listUserProfiles_nextToken :: Lens' ListUserProfiles (Maybe Text) Source #
The continuation token for the next set of results, if the results cannot be returned in one response.
listUserProfiles_maxResults :: Lens' ListUserProfiles (Maybe Natural) Source #
The maximum number of results to return in a response.
listUserProfilesResponse_nextToken :: Lens' ListUserProfilesResponse (Maybe Text) Source #
The continuation token to use when requesting the next set of results, if there are more results to be returned.
listUserProfilesResponse_httpStatus :: Lens' ListUserProfilesResponse Int Source #
The response's http status code.
listUserProfilesResponse_userProfiles :: Lens' ListUserProfilesResponse [UserProfileSummary] Source #
All the user profiles configured in AWS CodeStar for an AWS account.
ListResources
listResources_nextToken :: Lens' ListResources (Maybe Text) Source #
The continuation token for the next set of results, if the results cannot be returned in one response.
listResources_maxResults :: Lens' ListResources (Maybe Natural) Source #
The maximum amount of data that can be contained in a single set of results.
listResources_projectId :: Lens' ListResources Text Source #
The ID of the project.
listResourcesResponse_resources :: Lens' ListResourcesResponse (Maybe [Resource]) Source #
An array of resources associated with the project.
listResourcesResponse_nextToken :: Lens' ListResourcesResponse (Maybe Text) Source #
The continuation token to use when requesting the next set of results, if there are more results to be returned.
listResourcesResponse_httpStatus :: Lens' ListResourcesResponse Int Source #
The response's http status code.
AssociateTeamMember
associateTeamMember_remoteAccessAllowed :: Lens' AssociateTeamMember (Maybe Bool) Source #
Whether the team member is allowed to use an SSH public/private key pair to remotely access project resources, for example Amazon EC2 instances.
associateTeamMember_clientRequestToken :: Lens' AssociateTeamMember (Maybe Text) Source #
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.
associateTeamMember_projectId :: Lens' AssociateTeamMember Text Source #
The ID of the project to which you will add the IAM user.
associateTeamMember_userArn :: Lens' AssociateTeamMember Text Source #
The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.
associateTeamMember_projectRole :: Lens' AssociateTeamMember Text Source #
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.
associateTeamMemberResponse_clientRequestToken :: Lens' AssociateTeamMemberResponse (Maybe Text) Source #
The user- or system-generated token from the initial request that can be used to repeat the request.
associateTeamMemberResponse_httpStatus :: Lens' AssociateTeamMemberResponse Int Source #
The response's http status code.
UntagProject
untagProject_id :: Lens' UntagProject Text Source #
The ID of the project to remove tags from.
untagProject_tags :: Lens' UntagProject [Text] Source #
The tags to remove from the project.
untagProjectResponse_httpStatus :: Lens' UntagProjectResponse Int Source #
The response's http status code.
UpdateTeamMember
updateTeamMember_remoteAccessAllowed :: Lens' UpdateTeamMember (Maybe Bool) Source #
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.
updateTeamMember_projectRole :: Lens' UpdateTeamMember (Maybe Text) Source #
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.
updateTeamMember_projectId :: Lens' UpdateTeamMember Text Source #
The ID of the project.
updateTeamMember_userArn :: Lens' UpdateTeamMember Text Source #
The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.
updateTeamMemberResponse_userArn :: Lens' UpdateTeamMemberResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user whose team membership attributes were updated.
updateTeamMemberResponse_remoteAccessAllowed :: Lens' UpdateTeamMemberResponse (Maybe Bool) Source #
Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile.
updateTeamMemberResponse_projectRole :: Lens' UpdateTeamMemberResponse (Maybe Text) Source #
The project role granted to the user.
updateTeamMemberResponse_httpStatus :: Lens' UpdateTeamMemberResponse Int Source #
The response's http status code.
DescribeUserProfile
describeUserProfile_userArn :: Lens' DescribeUserProfile Text Source #
The Amazon Resource Name (ARN) of the user.
describeUserProfileResponse_sshPublicKey :: Lens' DescribeUserProfileResponse (Maybe Text) Source #
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.
describeUserProfileResponse_emailAddress :: Lens' DescribeUserProfileResponse (Maybe Text) Source #
The email address for the user. Optional.
describeUserProfileResponse_displayName :: Lens' DescribeUserProfileResponse (Maybe Text) Source #
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").
describeUserProfileResponse_httpStatus :: Lens' DescribeUserProfileResponse Int Source #
The response's http status code.
describeUserProfileResponse_userArn :: Lens' DescribeUserProfileResponse Text Source #
The Amazon Resource Name (ARN) of the user.
describeUserProfileResponse_createdTimestamp :: Lens' DescribeUserProfileResponse UTCTime Source #
The date and time when the user profile was created in AWS CodeStar, in timestamp format.
describeUserProfileResponse_lastModifiedTimestamp :: Lens' DescribeUserProfileResponse UTCTime Source #
The date and time when the user profile was last modified, in timestamp format.
ListTagsForProject
listTagsForProject_nextToken :: Lens' ListTagsForProject (Maybe Text) Source #
Reserved for future use.
listTagsForProject_maxResults :: Lens' ListTagsForProject (Maybe Natural) Source #
Reserved for future use.
listTagsForProject_id :: Lens' ListTagsForProject Text Source #
The ID of the project to get tags for.
listTagsForProjectResponse_nextToken :: Lens' ListTagsForProjectResponse (Maybe Text) Source #
Reserved for future use.
listTagsForProjectResponse_tags :: Lens' ListTagsForProjectResponse (Maybe (HashMap Text Text)) Source #
The tags for the project.
listTagsForProjectResponse_httpStatus :: Lens' ListTagsForProjectResponse Int Source #
The response's http status code.
DeleteUserProfile
deleteUserProfile_userArn :: Lens' DeleteUserProfile Text Source #
The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.
deleteUserProfileResponse_httpStatus :: Lens' DeleteUserProfileResponse Int Source #
The response's http status code.
deleteUserProfileResponse_userArn :: Lens' DeleteUserProfileResponse Text Source #
The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar.
UpdateUserProfile
updateUserProfile_sshPublicKey :: Lens' UpdateUserProfile (Maybe Text) Source #
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.
updateUserProfile_emailAddress :: Lens' UpdateUserProfile (Maybe Text) Source #
The email address that is displayed as part of the user's profile in AWS CodeStar.
updateUserProfile_displayName :: Lens' UpdateUserProfile (Maybe Text) Source #
The name that is displayed as the friendly name for the user in AWS CodeStar.
updateUserProfile_userArn :: Lens' UpdateUserProfile Text Source #
The name that will be displayed as the friendly name for the user in AWS CodeStar.
updateUserProfileResponse_lastModifiedTimestamp :: Lens' UpdateUserProfileResponse (Maybe UTCTime) Source #
The date the user profile was last modified, in timestamp format.
updateUserProfileResponse_sshPublicKey :: Lens' UpdateUserProfileResponse (Maybe Text) Source #
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.
updateUserProfileResponse_emailAddress :: Lens' UpdateUserProfileResponse (Maybe Text) Source #
The email address that is displayed as part of the user's profile in AWS CodeStar.
updateUserProfileResponse_displayName :: Lens' UpdateUserProfileResponse (Maybe Text) Source #
The name that is displayed as the friendly name for the user in AWS CodeStar.
updateUserProfileResponse_createdTimestamp :: Lens' UpdateUserProfileResponse (Maybe UTCTime) Source #
The date the user profile was created, in timestamp format.
updateUserProfileResponse_httpStatus :: Lens' UpdateUserProfileResponse Int Source #
The response's http status code.
updateUserProfileResponse_userArn :: Lens' UpdateUserProfileResponse Text Source #
The Amazon Resource Name (ARN) of the user in IAM.
CreateUserProfile
createUserProfile_sshPublicKey :: Lens' CreateUserProfile (Maybe Text) Source #
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.
createUserProfile_userArn :: Lens' CreateUserProfile Text Source #
The Amazon Resource Name (ARN) of the user in IAM.
createUserProfile_displayName :: Lens' CreateUserProfile Text Source #
The name that will be displayed as the friendly name for the user in AWS CodeStar.
createUserProfile_emailAddress :: Lens' CreateUserProfile Text Source #
The email address that will be displayed as part of the user's profile in AWS CodeStar.
createUserProfileResponse_lastModifiedTimestamp :: Lens' CreateUserProfileResponse (Maybe UTCTime) Source #
The date the user profile was last modified, in timestamp format.
createUserProfileResponse_sshPublicKey :: Lens' CreateUserProfileResponse (Maybe Text) Source #
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.
createUserProfileResponse_emailAddress :: Lens' CreateUserProfileResponse (Maybe Text) Source #
The email address that is displayed as part of the user's profile in AWS CodeStar.
createUserProfileResponse_displayName :: Lens' CreateUserProfileResponse (Maybe Text) Source #
The name that is displayed as the friendly name for the user in AWS CodeStar.
createUserProfileResponse_createdTimestamp :: Lens' CreateUserProfileResponse (Maybe UTCTime) Source #
The date the user profile was created, in timestamp format.
createUserProfileResponse_httpStatus :: Lens' CreateUserProfileResponse Int Source #
The response's http status code.
createUserProfileResponse_userArn :: Lens' CreateUserProfileResponse Text Source #
The Amazon Resource Name (ARN) of the user in IAM.
CreateProject
createProject_sourceCode :: Lens' CreateProject (Maybe [Code]) Source #
A list of the Code objects submitted with the project request. If this parameter is specified, the request must also include the toolchain parameter.
createProject_toolchain :: Lens' CreateProject (Maybe Toolchain) Source #
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.
createProject_clientRequestToken :: Lens' CreateProject (Maybe Text) Source #
A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request.
createProject_description :: Lens' CreateProject (Maybe Text) Source #
The description of the project, if any.
createProject_tags :: Lens' CreateProject (Maybe (HashMap Text Text)) Source #
The tags created for the project.
createProject_name :: Lens' CreateProject Text Source #
The display name for the project to be created in AWS CodeStar.
createProject_id :: Lens' CreateProject Text Source #
The ID of the project to be created in AWS CodeStar.
createProjectResponse_projectTemplateId :: Lens' CreateProjectResponse (Maybe Text) Source #
Reserved for future use.
createProjectResponse_clientRequestToken :: Lens' CreateProjectResponse (Maybe Text) Source #
A user- or system-generated token that identifies the entity that requested project creation.
createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int Source #
The response's http status code.
createProjectResponse_id :: Lens' CreateProjectResponse Text Source #
The ID of the project.
createProjectResponse_arn :: Lens' CreateProjectResponse Text Source #
The Amazon Resource Name (ARN) of the created project.
Types
Code
code_source :: Lens' Code CodeSource Source #
The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.
code_destination :: Lens' Code CodeDestination Source #
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.
CodeCommitCodeDestination
codeCommitCodeDestination_name :: Lens' CodeCommitCodeDestination Text Source #
The name of the AWS CodeCommit repository to be created in AWS CodeStar.
CodeDestination
codeDestination_codeCommit :: Lens' CodeDestination (Maybe CodeCommitCodeDestination) Source #
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.
codeDestination_gitHub :: Lens' CodeDestination (Maybe GitHubCodeDestination) Source #
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
codeSource_s3 :: Lens' CodeSource S3Location Source #
Information about the Amazon S3 location where the source code files provided with the project request are stored.
GitHubCodeDestination
gitHubCodeDestination_description :: Lens' GitHubCodeDestination (Maybe Text) Source #
Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after the repository is created.
gitHubCodeDestination_name :: Lens' GitHubCodeDestination Text Source #
Name of the GitHub repository to be created in AWS CodeStar.
gitHubCodeDestination_type :: Lens' GitHubCodeDestination Text Source #
The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.
gitHubCodeDestination_owner :: Lens' GitHubCodeDestination Text Source #
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.
gitHubCodeDestination_privateRepository :: Lens' GitHubCodeDestination Bool Source #
Whether the GitHub repository is to be a private repository.
gitHubCodeDestination_issuesEnabled :: Lens' GitHubCodeDestination Bool Source #
Whether to enable issues for the GitHub repository.
gitHubCodeDestination_token :: Lens' GitHubCodeDestination Text Source #
The GitHub user's personal access token for the GitHub repository.
ProjectStatus
projectStatus_reason :: Lens' ProjectStatus (Maybe Text) Source #
In the case of a project creation or deletion failure, a reason for the failure.
projectStatus_state :: Lens' ProjectStatus Text Source #
The phase of completion for a project creation or deletion.
ProjectSummary
projectSummary_projectArn :: Lens' ProjectSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the project.
projectSummary_projectId :: Lens' ProjectSummary (Maybe Text) Source #
The ID of the project.
Resource
S3Location
s3Location_bucketKey :: Lens' S3Location (Maybe Text) Source #
The Amazon S3 object key where the source code files provided with the project request are stored.
s3Location_bucketName :: Lens' S3Location (Maybe Text) Source #
The Amazon S3 bucket name where the source code files provided with the project request are stored.
TeamMember
teamMember_remoteAccessAllowed :: Lens' TeamMember (Maybe Bool) Source #
Whether the user is allowed to remotely access project resources using an SSH public/private key pair.
teamMember_userArn :: Lens' TeamMember Text Source #
The Amazon Resource Name (ARN) of the user in IAM.
teamMember_projectRole :: Lens' TeamMember Text Source #
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.
Toolchain
toolchain_stackParameters :: Lens' Toolchain (Maybe (HashMap Text Text)) Source #
The list of parameter overrides to be passed into the toolchain template during stack provisioning, if any.
toolchain_roleArn :: Lens' Toolchain (Maybe Text) Source #
The service role ARN for AWS CodeStar to use for the toolchain template during stack provisioning.
toolchain_source :: Lens' Toolchain ToolchainSource 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.
ToolchainSource
toolchainSource_s3 :: Lens' ToolchainSource S3Location Source #
The Amazon S3 bucket where the toolchain template file provided with the project request is stored.
UserProfileSummary
userProfileSummary_sshPublicKey :: Lens' UserProfileSummary (Maybe Text) Source #
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.
userProfileSummary_userArn :: Lens' UserProfileSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user in IAM.
userProfileSummary_emailAddress :: Lens' UserProfileSummary (Maybe Text) Source #
The email address associated with the user.
userProfileSummary_displayName :: Lens' UserProfileSummary (Maybe Text) Source #
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").