| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CodeStar
Contents
- Service Configuration
- Errors
- ConcurrentModificationException
- InvalidNextTokenException
- InvalidServiceRoleException
- LimitExceededException
- ProjectAlreadyExistsException
- ProjectConfigurationException
- ProjectCreationFailedException
- ProjectNotFoundException
- TeamMemberAlreadyAssociatedException
- TeamMemberNotFoundException
- UserProfileAlreadyExistsException
- UserProfileNotFoundException
- ValidationException
- Waiters
- Operations
- AssociateTeamMember
- CreateProject
- CreateUserProfile
- DeleteProject
- DeleteUserProfile
- DescribeProject
- DescribeUserProfile
- DisassociateTeamMember
- ListProjects (Paginated)
- ListResources (Paginated)
- ListTagsForProject
- ListTeamMembers (Paginated)
- ListUserProfiles (Paginated)
- TagProject
- UntagProject
- UpdateProject
- UpdateTeamMember
- UpdateUserProfile
- Types
Description
Derived from API version 2017-04-19 of the AWS service descriptions, licensed under Apache 2.0.
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:
DeleteProject, which deletes a project.DescribeProject, which lists the attributes of a project.ListProjects, which lists all projects associated with your AWS account.ListResources, which lists the resources associated with a project.ListTagsForProject, which lists the tags associated with a project.TagProject, which adds tags to a project.UntagProject, which removes tags from a project.UpdateProject, which updates the attributes of a project.
Teams and team members, by calling the following:
AssociateTeamMember, which adds an IAM user to the team for a project.DisassociateTeamMember, which removes an IAM user from the team for a project.ListTeamMembers, which lists all the IAM users in the team for a project, including their roles and attributes.UpdateTeamMember, which updates a team member's attributes in a project.
Users, by calling the following:
CreateUserProfile, which creates a user profile that contains data associated with the user across all projects.DeleteUserProfile, which deletes all user profile information across all projects.DescribeUserProfile, which describes the profile of a user.ListUserProfiles, which lists all user profiles.UpdateUserProfile, which updates the profile for a user.
Synopsis
- defaultService :: Service
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _InvalidServiceRoleException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ProjectAlreadyExistsException :: AsError a => Fold a ServiceError
- _ProjectConfigurationException :: AsError a => Fold a ServiceError
- _ProjectCreationFailedException :: AsError a => Fold a ServiceError
- _ProjectNotFoundException :: AsError a => Fold a ServiceError
- _TeamMemberAlreadyAssociatedException :: AsError a => Fold a ServiceError
- _TeamMemberNotFoundException :: AsError a => Fold a ServiceError
- _UserProfileAlreadyExistsException :: AsError a => Fold a ServiceError
- _UserProfileNotFoundException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data AssociateTeamMember = AssociateTeamMember' (Maybe Text) (Maybe Bool) Text Text Text
- newAssociateTeamMember :: Text -> Text -> Text -> AssociateTeamMember
- data AssociateTeamMemberResponse = AssociateTeamMemberResponse' (Maybe Text) Int
- newAssociateTeamMemberResponse :: Int -> AssociateTeamMemberResponse
- data CreateProject = CreateProject' (Maybe Text) (Maybe (Sensitive Text)) (Maybe [Code]) (Maybe (HashMap Text Text)) (Maybe Toolchain) (Sensitive Text) Text
- newCreateProject :: Text -> Text -> CreateProject
- data CreateProjectResponse = CreateProjectResponse' (Maybe Text) (Maybe Text) Int Text Text
- newCreateProjectResponse :: Int -> Text -> Text -> CreateProjectResponse
- data CreateUserProfile = CreateUserProfile' (Maybe Text) Text (Sensitive Text) (Sensitive Text)
- newCreateUserProfile :: Text -> Text -> Text -> CreateUserProfile
- data CreateUserProfileResponse = CreateUserProfileResponse' (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe Text) Int Text
- newCreateUserProfileResponse :: Int -> Text -> CreateUserProfileResponse
- data DeleteProject = DeleteProject' (Maybe Text) (Maybe Bool) Text
- newDeleteProject :: Text -> DeleteProject
- data DeleteProjectResponse = DeleteProjectResponse' (Maybe Text) (Maybe Text) Int
- newDeleteProjectResponse :: Int -> DeleteProjectResponse
- data DeleteUserProfile = DeleteUserProfile' Text
- newDeleteUserProfile :: Text -> DeleteUserProfile
- data DeleteUserProfileResponse = DeleteUserProfileResponse' Int Text
- newDeleteUserProfileResponse :: Int -> Text -> DeleteUserProfileResponse
- data DescribeProject = DescribeProject' Text
- newDescribeProject :: Text -> DescribeProject
- data DescribeProjectResponse = DescribeProjectResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe ProjectStatus) Int
- newDescribeProjectResponse :: Int -> DescribeProjectResponse
- data DescribeUserProfile = DescribeUserProfile' Text
- newDescribeUserProfile :: Text -> DescribeUserProfile
- data DescribeUserProfileResponse = DescribeUserProfileResponse' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) Int Text POSIX POSIX
- newDescribeUserProfileResponse :: Int -> Text -> UTCTime -> UTCTime -> DescribeUserProfileResponse
- data DisassociateTeamMember = DisassociateTeamMember' Text Text
- newDisassociateTeamMember :: Text -> Text -> DisassociateTeamMember
- data DisassociateTeamMemberResponse = DisassociateTeamMemberResponse' Int
- newDisassociateTeamMemberResponse :: Int -> DisassociateTeamMemberResponse
- data ListProjects = ListProjects' (Maybe Natural) (Maybe Text)
- newListProjects :: ListProjects
- data ListProjectsResponse = ListProjectsResponse' (Maybe Text) Int [ProjectSummary]
- newListProjectsResponse :: Int -> ListProjectsResponse
- data ListResources = ListResources' (Maybe Natural) (Maybe Text) Text
- newListResources :: Text -> ListResources
- data ListResourcesResponse = ListResourcesResponse' (Maybe Text) (Maybe [Resource]) Int
- newListResourcesResponse :: Int -> ListResourcesResponse
- data ListTagsForProject = ListTagsForProject' (Maybe Natural) (Maybe Text) Text
- newListTagsForProject :: Text -> ListTagsForProject
- data ListTagsForProjectResponse = ListTagsForProjectResponse' (Maybe Text) (Maybe (HashMap Text Text)) Int
- newListTagsForProjectResponse :: Int -> ListTagsForProjectResponse
- data ListTeamMembers = ListTeamMembers' (Maybe Natural) (Maybe Text) Text
- newListTeamMembers :: Text -> ListTeamMembers
- data ListTeamMembersResponse = ListTeamMembersResponse' (Maybe Text) Int [TeamMember]
- newListTeamMembersResponse :: Int -> ListTeamMembersResponse
- data ListUserProfiles = ListUserProfiles' (Maybe Natural) (Maybe Text)
- newListUserProfiles :: ListUserProfiles
- data ListUserProfilesResponse = ListUserProfilesResponse' (Maybe Text) Int [UserProfileSummary]
- newListUserProfilesResponse :: Int -> ListUserProfilesResponse
- data TagProject = TagProject' Text (HashMap Text Text)
- newTagProject :: Text -> TagProject
- data TagProjectResponse = TagProjectResponse' (Maybe (HashMap Text Text)) Int
- newTagProjectResponse :: Int -> TagProjectResponse
- data UntagProject = UntagProject' Text [Text]
- newUntagProject :: Text -> UntagProject
- data UntagProjectResponse = UntagProjectResponse' Int
- newUntagProjectResponse :: Int -> UntagProjectResponse
- data UpdateProject = UpdateProject' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Text
- newUpdateProject :: Text -> UpdateProject
- data UpdateProjectResponse = UpdateProjectResponse' Int
- newUpdateProjectResponse :: Int -> UpdateProjectResponse
- data UpdateTeamMember = UpdateTeamMember' (Maybe Text) (Maybe Bool) Text Text
- newUpdateTeamMember :: Text -> Text -> UpdateTeamMember
- data UpdateTeamMemberResponse = UpdateTeamMemberResponse' (Maybe Text) (Maybe Bool) (Maybe Text) Int
- newUpdateTeamMemberResponse :: Int -> UpdateTeamMemberResponse
- data UpdateUserProfile = UpdateUserProfile' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) Text
- newUpdateUserProfile :: Text -> UpdateUserProfile
- data UpdateUserProfileResponse = UpdateUserProfileResponse' (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe Text) Int Text
- newUpdateUserProfileResponse :: Int -> Text -> UpdateUserProfileResponse
- data Code = Code' CodeSource CodeDestination
- newCode :: CodeSource -> CodeDestination -> Code
- data CodeCommitCodeDestination = CodeCommitCodeDestination' Text
- newCodeCommitCodeDestination :: Text -> CodeCommitCodeDestination
- data CodeDestination = CodeDestination' (Maybe CodeCommitCodeDestination) (Maybe GitHubCodeDestination)
- newCodeDestination :: CodeDestination
- data CodeSource = CodeSource' S3Location
- newCodeSource :: S3Location -> CodeSource
- data GitHubCodeDestination = GitHubCodeDestination' (Maybe Text) Text Text Text Bool Bool (Sensitive Text)
- newGitHubCodeDestination :: Text -> Text -> Text -> Bool -> Bool -> Text -> GitHubCodeDestination
- data ProjectStatus = ProjectStatus' (Maybe Text) Text
- newProjectStatus :: Text -> ProjectStatus
- data ProjectSummary = ProjectSummary' (Maybe Text) (Maybe Text)
- newProjectSummary :: ProjectSummary
- data Resource = Resource' Text
- newResource :: Text -> Resource
- data S3Location = S3Location' (Maybe Text) (Maybe Text)
- newS3Location :: S3Location
- data TeamMember = TeamMember' (Maybe Bool) Text Text
- newTeamMember :: Text -> Text -> TeamMember
- data Toolchain = Toolchain' (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) ToolchainSource
- newToolchain :: ToolchainSource -> Toolchain
- data ToolchainSource = ToolchainSource' S3Location
- newToolchainSource :: S3Location -> ToolchainSource
- data UserProfileSummary = UserProfileSummary' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text)
- newUserProfileSummary :: UserProfileSummary
Service Configuration
defaultService :: Service Source #
API version 2017-04-19 of the Amazon CodeStar SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CodeStar.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
Another modification is being made. That modification must complete before you can make your change.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
The next token is not valid.
InvalidServiceRoleException
_InvalidServiceRoleException :: AsError a => Fold a ServiceError Source #
The service role is not valid.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
A resource limit has been exceeded.
ProjectAlreadyExistsException
_ProjectAlreadyExistsException :: AsError a => Fold a ServiceError Source #
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.
ProjectConfigurationException
_ProjectConfigurationException :: AsError a => Fold a ServiceError Source #
Project configuration information is required but not specified.
ProjectCreationFailedException
_ProjectCreationFailedException :: AsError a => Fold a ServiceError Source #
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.
ProjectNotFoundException
_ProjectNotFoundException :: AsError a => Fold a ServiceError Source #
The specified AWS CodeStar project was not found.
TeamMemberAlreadyAssociatedException
_TeamMemberAlreadyAssociatedException :: AsError a => Fold a ServiceError Source #
The team member is already associated with a role in this project.
TeamMemberNotFoundException
_TeamMemberNotFoundException :: AsError a => Fold a ServiceError Source #
The specified team member was not found.
UserProfileAlreadyExistsException
_UserProfileAlreadyExistsException :: AsError a => Fold a ServiceError Source #
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.
UserProfileNotFoundException
_UserProfileNotFoundException :: AsError a => Fold a ServiceError Source #
The user profile was not found.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The specified input is either not valid, or it could not be validated.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateTeamMember
data AssociateTeamMember Source #
See: newAssociateTeamMember smart constructor.
Instances
newAssociateTeamMember Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AssociateTeamMember |
Create a value of AssociateTeamMember with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateTeamMember, associateTeamMember_clientRequestToken - A user- or system-generated token that identifies the entity that
requested the team member association to the project. This token can be
used to repeat the request.
AssociateTeamMember, associateTeamMember_remoteAccessAllowed - Whether the team member is allowed to use an SSH public/private key
pair to remotely access project resources, for example Amazon EC2
instances.
AssociateTeamMember, associateTeamMember_projectId - The ID of the project to which you will add the IAM user.
AssociateTeamMember, associateTeamMember_userArn - The Amazon Resource Name (ARN) for the IAM user you want to add to the
AWS CodeStar project.
AssociateTeamMember, associateTeamMember_projectRole - The AWS CodeStar project role that will apply to this user. This role
determines what actions a user can take in an AWS CodeStar project.
data AssociateTeamMemberResponse Source #
See: newAssociateTeamMemberResponse smart constructor.
Constructors
| AssociateTeamMemberResponse' (Maybe Text) Int |
Instances
newAssociateTeamMemberResponse Source #
Create a value of AssociateTeamMemberResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateTeamMember, associateTeamMemberResponse_clientRequestToken - The user- or system-generated token from the initial request that can be
used to repeat the request.
$sel:httpStatus:AssociateTeamMemberResponse', associateTeamMemberResponse_httpStatus - The response's http status code.
CreateProject
data CreateProject Source #
See: newCreateProject smart constructor.
Constructors
| CreateProject' (Maybe Text) (Maybe (Sensitive Text)) (Maybe [Code]) (Maybe (HashMap Text Text)) (Maybe Toolchain) (Sensitive Text) Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateProject |
Create a value of CreateProject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateProject, createProject_clientRequestToken - A user- or system-generated token that identifies the entity that
requested project creation. This token can be used to repeat the
request.
CreateProject, createProject_description - The description of the project, if any.
$sel:sourceCode:CreateProject', createProject_sourceCode - A list of the Code objects submitted with the project request. If this
parameter is specified, the request must also include the toolchain
parameter.
$sel:tags:CreateProject', createProject_tags - The tags created for the project.
$sel:toolchain:CreateProject', createProject_toolchain - 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, createProject_name - The display name for the project to be created in AWS CodeStar.
CreateProject, createProject_id - The ID of the project to be created in AWS CodeStar.
data CreateProjectResponse Source #
See: newCreateProjectResponse smart constructor.
Instances
newCreateProjectResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> CreateProjectResponse |
Create a value of CreateProjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateProject, createProjectResponse_clientRequestToken - A user- or system-generated token that identifies the entity that
requested project creation.
$sel:projectTemplateId:CreateProjectResponse', createProjectResponse_projectTemplateId - Reserved for future use.
$sel:httpStatus:CreateProjectResponse', createProjectResponse_httpStatus - The response's http status code.
CreateProject, createProjectResponse_id - The ID of the project.
$sel:arn:CreateProjectResponse', createProjectResponse_arn - The Amazon Resource Name (ARN) of the created project.
CreateUserProfile
data CreateUserProfile Source #
See: newCreateUserProfile smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateUserProfile |
Create a value of CreateUserProfile with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateUserProfile, createUserProfile_sshPublicKey - The SSH public key associated with the user in AWS CodeStar. If a
project owner allows the user remote access to project resources, this
public key will be used along with the user's private key for SSH
access.
CreateUserProfile, createUserProfile_userArn - The Amazon Resource Name (ARN) of the user in IAM.
CreateUserProfile, createUserProfile_displayName - The name that will be displayed as the friendly name for the user in AWS
CodeStar.
CreateUserProfile, createUserProfile_emailAddress - The email address that will be displayed as part of the user's profile
in AWS CodeStar.
data CreateUserProfileResponse Source #
See: newCreateUserProfileResponse smart constructor.
Constructors
| CreateUserProfileResponse' (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe Text) Int Text |
Instances
newCreateUserProfileResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateUserProfileResponse |
Create a value of CreateUserProfileResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdTimestamp:CreateUserProfileResponse', createUserProfileResponse_createdTimestamp - The date the user profile was created, in timestamp format.
CreateUserProfile, createUserProfileResponse_displayName - The name that is displayed as the friendly name for the user in AWS
CodeStar.
CreateUserProfile, createUserProfileResponse_emailAddress - The email address that is displayed as part of the user's profile in
AWS CodeStar.
$sel:lastModifiedTimestamp:CreateUserProfileResponse', createUserProfileResponse_lastModifiedTimestamp - The date the user profile was last modified, in timestamp format.
CreateUserProfile, createUserProfileResponse_sshPublicKey - The SSH public key associated with the user in AWS CodeStar. This is the
public portion of the public/private keypair the user can use to access
project resources if a project owner allows the user remote access to
those resources.
$sel:httpStatus:CreateUserProfileResponse', createUserProfileResponse_httpStatus - The response's http status code.
CreateUserProfile, createUserProfileResponse_userArn - The Amazon Resource Name (ARN) of the user in IAM.
DeleteProject
data DeleteProject Source #
See: newDeleteProject smart constructor.
Instances
Arguments
| :: Text | |
| -> DeleteProject |
Create a value of DeleteProject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:DeleteProject', deleteProject_clientRequestToken - A user- or system-generated token that identifies the entity that
requested project deletion. This token can be used to repeat the
request.
$sel:deleteStack:DeleteProject', deleteProject_deleteStack - Whether to send a delete request for the primary stack in AWS
CloudFormation originally used to generate the project and its
resources. This option will delete all AWS resources for the project
(except for any buckets in Amazon S3) as well as deleting the project
itself. Recommended for most use cases.
DeleteProject, deleteProject_id - The ID of the project to be deleted in AWS CodeStar.
data DeleteProjectResponse Source #
See: newDeleteProjectResponse smart constructor.
Instances
newDeleteProjectResponse Source #
Create a value of DeleteProjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteProjectResponse, deleteProjectResponse_projectArn - The Amazon Resource Name (ARN) of the deleted project.
$sel:stackId:DeleteProjectResponse', deleteProjectResponse_stackId - The ID of the primary stack in AWS CloudFormation that will be deleted
as part of deleting the project and its resources.
$sel:httpStatus:DeleteProjectResponse', deleteProjectResponse_httpStatus - The response's http status code.
DeleteUserProfile
data DeleteUserProfile Source #
See: newDeleteUserProfile smart constructor.
Constructors
| DeleteUserProfile' Text |
Instances
Arguments
| :: Text | |
| -> DeleteUserProfile |
Create a value of DeleteUserProfile with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteUserProfile, deleteUserProfile_userArn - The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.
data DeleteUserProfileResponse Source #
See: newDeleteUserProfileResponse smart constructor.
Constructors
| DeleteUserProfileResponse' Int Text |
Instances
newDeleteUserProfileResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DeleteUserProfileResponse |
Create a value of DeleteUserProfileResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteUserProfileResponse', deleteUserProfileResponse_httpStatus - The response's http status code.
DeleteUserProfile, deleteUserProfileResponse_userArn - The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar.
DescribeProject
data DescribeProject Source #
See: newDescribeProject smart constructor.
Constructors
| DescribeProject' Text |
Instances
Arguments
| :: Text | |
| -> DescribeProject |
Create a value of DescribeProject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeProject, describeProject_id - The ID of the project.
data DescribeProjectResponse Source #
See: newDescribeProjectResponse smart constructor.
Constructors
| DescribeProjectResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe ProjectStatus) Int |
Instances
newDescribeProjectResponse Source #
Create a value of DescribeProjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:DescribeProjectResponse', describeProjectResponse_arn - The Amazon Resource Name (ARN) for the project.
$sel:clientRequestToken:DescribeProjectResponse', describeProjectResponse_clientRequestToken - A user- or system-generated token that identifies the entity that
requested project creation.
$sel:createdTimeStamp:DescribeProjectResponse', describeProjectResponse_createdTimeStamp - The date and time the project was created, in timestamp format.
DescribeProjectResponse, describeProjectResponse_description - The description of the project, if any.
DescribeProject, describeProjectResponse_id - The ID of the project.
DescribeProjectResponse, describeProjectResponse_name - The display name for the project.
$sel:projectTemplateId:DescribeProjectResponse', describeProjectResponse_projectTemplateId - The ID for the AWS CodeStar project template used to create the project.
$sel:stackId:DescribeProjectResponse', describeProjectResponse_stackId - The ID of the primary stack in AWS CloudFormation used to generate
resources for the project.
$sel:status:DescribeProjectResponse', describeProjectResponse_status - The project creation or deletion status.
$sel:httpStatus:DescribeProjectResponse', describeProjectResponse_httpStatus - The response's http status code.
DescribeUserProfile
data DescribeUserProfile Source #
See: newDescribeUserProfile smart constructor.
Constructors
| DescribeUserProfile' Text |
Instances
newDescribeUserProfile Source #
Arguments
| :: Text | |
| -> DescribeUserProfile |
Create a value of DescribeUserProfile with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeUserProfile, describeUserProfile_userArn - The Amazon Resource Name (ARN) of the user.
data DescribeUserProfileResponse Source #
See: newDescribeUserProfileResponse smart constructor.
Constructors
| DescribeUserProfileResponse' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) Int Text POSIX POSIX |
Instances
newDescribeUserProfileResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> DescribeUserProfileResponse |
Create a value of DescribeUserProfileResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeUserProfileResponse, describeUserProfileResponse_displayName - The display name shown for the user in AWS CodeStar projects. For
example, this could be set to both first and last name ("Mary Major")
or a single name ("Mary"). The display name is also used to generate
the initial icon associated with the user in AWS CodeStar projects. If
spaces are included in the display name, the first character that
appears after the space will be used as the second character in the user
initial icon. The initial icon displays a maximum of two characters, so
a display name with more than one space (for example "Mary Jane
Major") would generate an initial icon using the first character and
the first character after the space ("MJ", not "MM").
DescribeUserProfileResponse, describeUserProfileResponse_emailAddress - The email address for the user. Optional.
DescribeUserProfileResponse, describeUserProfileResponse_sshPublicKey - The SSH public key associated with the user. This SSH public key is
associated with the user profile, and can be used in conjunction with
the associated private key for access to project resources, such as
Amazon EC2 instances, if a project owner grants remote access to those
resources.
$sel:httpStatus:DescribeUserProfileResponse', describeUserProfileResponse_httpStatus - The response's http status code.
DescribeUserProfile, describeUserProfileResponse_userArn - The Amazon Resource Name (ARN) of the user.
$sel:createdTimestamp:DescribeUserProfileResponse', describeUserProfileResponse_createdTimestamp - The date and time when the user profile was created in AWS CodeStar, in
timestamp format.
$sel:lastModifiedTimestamp:DescribeUserProfileResponse', describeUserProfileResponse_lastModifiedTimestamp - The date and time when the user profile was last modified, in timestamp
format.
DisassociateTeamMember
data DisassociateTeamMember Source #
See: newDisassociateTeamMember smart constructor.
Constructors
| DisassociateTeamMember' Text Text |
Instances
newDisassociateTeamMember Source #
Create a value of DisassociateTeamMember with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateTeamMember, disassociateTeamMember_projectId - The ID of the AWS CodeStar project from which you want to remove a team
member.
DisassociateTeamMember, disassociateTeamMember_userArn - The Amazon Resource Name (ARN) of the IAM user or group whom you want to
remove from the project.
data DisassociateTeamMemberResponse Source #
See: newDisassociateTeamMemberResponse smart constructor.
Constructors
| DisassociateTeamMemberResponse' Int |
Instances
newDisassociateTeamMemberResponse Source #
Create a value of DisassociateTeamMemberResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisassociateTeamMemberResponse', disassociateTeamMemberResponse_httpStatus - The response's http status code.
ListProjects (Paginated)
data ListProjects Source #
See: newListProjects smart constructor.
Constructors
| ListProjects' (Maybe Natural) (Maybe Text) |
Instances
newListProjects :: ListProjects Source #
Create a value of ListProjects with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListProjects', listProjects_maxResults - The maximum amount of data that can be contained in a single set of
results.
ListProjects, listProjects_nextToken - The continuation token to be used to return the next set of results, if
the results cannot be returned in one response.
data ListProjectsResponse Source #
See: newListProjectsResponse smart constructor.
Constructors
| ListProjectsResponse' (Maybe Text) Int [ProjectSummary] |
Instances
newListProjectsResponse Source #
Arguments
| :: Int | |
| -> ListProjectsResponse |
Create a value of ListProjectsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListProjects, listProjectsResponse_nextToken - The continuation token to use when requesting the next set of results,
if there are more results to be returned.
$sel:httpStatus:ListProjectsResponse', listProjectsResponse_httpStatus - The response's http status code.
$sel:projects:ListProjectsResponse', listProjectsResponse_projects - A list of projects.
ListResources (Paginated)
data ListResources Source #
See: newListResources smart constructor.
Instances
Arguments
| :: Text | |
| -> ListResources |
Create a value of ListResources with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListResources', listResources_maxResults - The maximum amount of data that can be contained in a single set of
results.
ListResources, listResources_nextToken - The continuation token for the next set of results, if the results
cannot be returned in one response.
ListResources, listResources_projectId - The ID of the project.
data ListResourcesResponse Source #
See: newListResourcesResponse smart constructor.
Instances
newListResourcesResponse Source #
Create a value of ListResourcesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListResources, listResourcesResponse_nextToken - The continuation token to use when requesting the next set of results,
if there are more results to be returned.
$sel:resources:ListResourcesResponse', listResourcesResponse_resources - An array of resources associated with the project.
$sel:httpStatus:ListResourcesResponse', listResourcesResponse_httpStatus - The response's http status code.
ListTagsForProject
data ListTagsForProject Source #
See: newListTagsForProject smart constructor.
Instances
newListTagsForProject Source #
Arguments
| :: Text | |
| -> ListTagsForProject |
Create a value of ListTagsForProject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTagsForProject', listTagsForProject_maxResults - Reserved for future use.
ListTagsForProject, listTagsForProject_nextToken - Reserved for future use.
ListTagsForProject, listTagsForProject_id - The ID of the project to get tags for.
data ListTagsForProjectResponse Source #
See: newListTagsForProjectResponse smart constructor.
Instances
newListTagsForProjectResponse Source #
Create a value of ListTagsForProjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForProject, listTagsForProjectResponse_nextToken - Reserved for future use.
$sel:tags:ListTagsForProjectResponse', listTagsForProjectResponse_tags - The tags for the project.
$sel:httpStatus:ListTagsForProjectResponse', listTagsForProjectResponse_httpStatus - The response's http status code.
ListTeamMembers (Paginated)
data ListTeamMembers Source #
See: newListTeamMembers smart constructor.
Instances
Arguments
| :: Text | |
| -> ListTeamMembers |
Create a value of ListTeamMembers with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTeamMembers', listTeamMembers_maxResults - The maximum number of team members you want returned in a response.
ListTeamMembers, listTeamMembers_nextToken - The continuation token for the next set of results, if the results
cannot be returned in one response.
ListTeamMembers, listTeamMembers_projectId - The ID of the project for which you want to list team members.
data ListTeamMembersResponse Source #
See: newListTeamMembersResponse smart constructor.
Constructors
| ListTeamMembersResponse' (Maybe Text) Int [TeamMember] |
Instances
newListTeamMembersResponse Source #
Create a value of ListTeamMembersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTeamMembers, listTeamMembersResponse_nextToken - The continuation token to use when requesting the next set of results,
if there are more results to be returned.
$sel:httpStatus:ListTeamMembersResponse', listTeamMembersResponse_httpStatus - The response's http status code.
$sel:teamMembers:ListTeamMembersResponse', listTeamMembersResponse_teamMembers - A list of team member objects for the project.
ListUserProfiles (Paginated)
data ListUserProfiles Source #
See: newListUserProfiles smart constructor.
Constructors
| ListUserProfiles' (Maybe Natural) (Maybe Text) |
Instances
newListUserProfiles :: ListUserProfiles Source #
Create a value of ListUserProfiles with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListUserProfiles', listUserProfiles_maxResults - The maximum number of results to return in a response.
ListUserProfiles, listUserProfiles_nextToken - The continuation token for the next set of results, if the results
cannot be returned in one response.
data ListUserProfilesResponse Source #
See: newListUserProfilesResponse smart constructor.
Constructors
| ListUserProfilesResponse' (Maybe Text) Int [UserProfileSummary] |
Instances
newListUserProfilesResponse Source #
Create a value of ListUserProfilesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListUserProfiles, listUserProfilesResponse_nextToken - The continuation token to use when requesting the next set of results,
if there are more results to be returned.
$sel:httpStatus:ListUserProfilesResponse', listUserProfilesResponse_httpStatus - The response's http status code.
$sel:userProfiles:ListUserProfilesResponse', listUserProfilesResponse_userProfiles - All the user profiles configured in AWS CodeStar for an AWS account.
TagProject
data TagProject Source #
See: newTagProject smart constructor.
Constructors
| TagProject' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagProject |
Create a value of TagProject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TagProject, tagProject_id - The ID of the project you want to add a tag to.
TagProject, tagProject_tags - The tags you want to add to the project.
data TagProjectResponse Source #
See: newTagProjectResponse smart constructor.
Instances
newTagProjectResponse Source #
Arguments
| :: Int | |
| -> TagProjectResponse |
Create a value of TagProjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TagProject, tagProjectResponse_tags - The tags for the project.
$sel:httpStatus:TagProjectResponse', tagProjectResponse_httpStatus - The response's http status code.
UntagProject
data UntagProject Source #
See: newUntagProject smart constructor.
Constructors
| UntagProject' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagProject |
Create a value of UntagProject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UntagProject, untagProject_id - The ID of the project to remove tags from.
$sel:tags:UntagProject', untagProject_tags - The tags to remove from the project.
data UntagProjectResponse Source #
See: newUntagProjectResponse smart constructor.
Constructors
| UntagProjectResponse' Int |
Instances
newUntagProjectResponse Source #
Arguments
| :: Int | |
| -> UntagProjectResponse |
Create a value of UntagProjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagProjectResponse', untagProjectResponse_httpStatus - The response's http status code.
UpdateProject
data UpdateProject Source #
See: newUpdateProject smart constructor.
Instances
Arguments
| :: Text | |
| -> UpdateProject |
Create a value of UpdateProject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateProject, updateProject_description - The description of the project, if any.
UpdateProject, updateProject_name - The name of the project you want to update.
UpdateProject, updateProject_id - The ID of the project you want to update.
data UpdateProjectResponse Source #
See: newUpdateProjectResponse smart constructor.
Constructors
| UpdateProjectResponse' Int |
Instances
newUpdateProjectResponse Source #
Create a value of UpdateProjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateProjectResponse', updateProjectResponse_httpStatus - The response's http status code.
UpdateTeamMember
data UpdateTeamMember Source #
See: newUpdateTeamMember smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateTeamMember |
Create a value of UpdateTeamMember with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateTeamMember, updateTeamMember_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.
UpdateTeamMember, updateTeamMember_remoteAccessAllowed - Whether a team member is allowed to remotely access project resources
using the SSH public key associated with the user's profile. Even if
this is set to True, the user must associate a public key with their
profile before the user can access resources.
UpdateTeamMember, updateTeamMember_projectId - The ID of the project.
UpdateTeamMember, updateTeamMember_userArn - The Amazon Resource Name (ARN) of the user for whom you want to change
team membership attributes.
data UpdateTeamMemberResponse Source #
See: newUpdateTeamMemberResponse smart constructor.
Instances
newUpdateTeamMemberResponse Source #
Create a value of UpdateTeamMemberResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateTeamMember, updateTeamMemberResponse_projectRole - The project role granted to the user.
UpdateTeamMember, updateTeamMemberResponse_remoteAccessAllowed - Whether a team member is allowed to remotely access project resources
using the SSH public key associated with the user's profile.
UpdateTeamMember, updateTeamMemberResponse_userArn - The Amazon Resource Name (ARN) of the user whose team membership
attributes were updated.
$sel:httpStatus:UpdateTeamMemberResponse', updateTeamMemberResponse_httpStatus - The response's http status code.
UpdateUserProfile
data UpdateUserProfile Source #
See: newUpdateUserProfile smart constructor.
Instances
Arguments
| :: Text | |
| -> UpdateUserProfile |
Create a value of UpdateUserProfile with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateUserProfile, updateUserProfile_displayName - The name that is displayed as the friendly name for the user in AWS
CodeStar.
UpdateUserProfile, updateUserProfile_emailAddress - The email address that is displayed as part of the user's profile in
AWS CodeStar.
UpdateUserProfile, updateUserProfile_sshPublicKey - The SSH public key associated with the user in AWS CodeStar. If a
project owner allows the user remote access to project resources, this
public key will be used along with the user's private key for SSH
access.
UpdateUserProfile, updateUserProfile_userArn - The name that will be displayed as the friendly name for the user in AWS
CodeStar.
data UpdateUserProfileResponse Source #
See: newUpdateUserProfileResponse smart constructor.
Constructors
| UpdateUserProfileResponse' (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe Text) Int Text |
Instances
newUpdateUserProfileResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> UpdateUserProfileResponse |
Create a value of UpdateUserProfileResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdTimestamp:UpdateUserProfileResponse', updateUserProfileResponse_createdTimestamp - The date the user profile was created, in timestamp format.
UpdateUserProfile, updateUserProfileResponse_displayName - The name that is displayed as the friendly name for the user in AWS
CodeStar.
UpdateUserProfile, updateUserProfileResponse_emailAddress - The email address that is displayed as part of the user's profile in
AWS CodeStar.
$sel:lastModifiedTimestamp:UpdateUserProfileResponse', updateUserProfileResponse_lastModifiedTimestamp - The date the user profile was last modified, in timestamp format.
UpdateUserProfile, updateUserProfileResponse_sshPublicKey - The SSH public key associated with the user in AWS CodeStar. This is the
public portion of the public/private keypair the user can use to access
project resources if a project owner allows the user remote access to
those resources.
$sel:httpStatus:UpdateUserProfileResponse', updateUserProfileResponse_httpStatus - The response's http status code.
UpdateUserProfile, updateUserProfileResponse_userArn - The Amazon Resource Name (ARN) of the user in IAM.
Types
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.
See: newCode smart constructor.
Constructors
| Code' CodeSource CodeDestination |
Instances
| ToJSON Code Source # | |
Defined in Amazonka.CodeStar.Types.Code | |
| Generic Code Source # | |
| Show Code Source # | |
| NFData Code Source # | |
Defined in Amazonka.CodeStar.Types.Code | |
| Eq Code Source # | |
| Hashable Code Source # | |
Defined in Amazonka.CodeStar.Types.Code | |
| type Rep Code Source # | |
Defined in Amazonka.CodeStar.Types.Code type Rep Code = D1 ('MetaData "Code" "Amazonka.CodeStar.Types.Code" "amazonka-codestar-2.0-J6u0QgMrENu7wBmwByxQnV" 'False) (C1 ('MetaCons "Code'" 'PrefixI 'True) (S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CodeSource) :*: S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CodeDestination))) | |
Arguments
| :: CodeSource | |
| -> CodeDestination | |
| -> Code |
Create a value of Code with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:source:Code', code_source - The location where the source code files provided with the project
request are stored. AWS CodeStar retrieves the files during project
creation.
$sel:destination:Code', code_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.
CodeCommitCodeDestination
data 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.
See: newCodeCommitCodeDestination smart constructor.
Constructors
| CodeCommitCodeDestination' Text |
Instances
newCodeCommitCodeDestination Source #
Create a value of CodeCommitCodeDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:CodeCommitCodeDestination', codeCommitCodeDestination_name - The name of the AWS CodeCommit repository to be created in AWS CodeStar.
CodeDestination
data 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.
See: newCodeDestination smart constructor.
Constructors
| CodeDestination' (Maybe CodeCommitCodeDestination) (Maybe GitHubCodeDestination) |
Instances
newCodeDestination :: CodeDestination Source #
Create a value of CodeDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:codeCommit:CodeDestination', codeDestination_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.
$sel:gitHub:CodeDestination', codeDestination_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.
CodeSource
data CodeSource Source #
The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.
See: newCodeSource smart constructor.
Constructors
| CodeSource' S3Location |
Instances
Arguments
| :: S3Location | |
| -> CodeSource |
Create a value of CodeSource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3:CodeSource', codeSource_s3 - Information about the Amazon S3 location where the source code files
provided with the project request are stored.
GitHubCodeDestination
data 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.
See: newGitHubCodeDestination smart constructor.
Instances
newGitHubCodeDestination Source #
Create a value of GitHubCodeDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:GitHubCodeDestination', gitHubCodeDestination_description - Description for the GitHub repository to be created in AWS CodeStar.
This description displays in GitHub after the repository is created.
$sel:name:GitHubCodeDestination', gitHubCodeDestination_name - Name of the GitHub repository to be created in AWS CodeStar.
$sel:type':GitHubCodeDestination', gitHubCodeDestination_type - The type of GitHub repository to be created in AWS CodeStar. Valid
values are User or Organization.
$sel:owner:GitHubCodeDestination', gitHubCodeDestination_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.
$sel:privateRepository:GitHubCodeDestination', gitHubCodeDestination_privateRepository - Whether the GitHub repository is to be a private repository.
$sel:issuesEnabled:GitHubCodeDestination', gitHubCodeDestination_issuesEnabled - Whether to enable issues for the GitHub repository.
$sel:token:GitHubCodeDestination', gitHubCodeDestination_token - The GitHub user's personal access token for the GitHub repository.
ProjectStatus
data ProjectStatus Source #
An indication of whether a project creation or deletion is failed or successful.
See: newProjectStatus smart constructor.
Constructors
| ProjectStatus' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> ProjectStatus |
Create a value of ProjectStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reason:ProjectStatus', projectStatus_reason - In the case of a project creation or deletion failure, a reason for the
failure.
$sel:state:ProjectStatus', projectStatus_state - The phase of completion for a project creation or deletion.
ProjectSummary
data ProjectSummary Source #
Information about the metadata for a project.
See: newProjectSummary smart constructor.
Constructors
| ProjectSummary' (Maybe Text) (Maybe Text) |
Instances
newProjectSummary :: ProjectSummary Source #
Create a value of ProjectSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:projectArn:ProjectSummary', projectSummary_projectArn - The Amazon Resource Name (ARN) of the project.
$sel:projectId:ProjectSummary', projectSummary_projectId - The ID of the project.
Resource
Information about a resource for a project.
See: newResource smart constructor.
Instances
| FromJSON Resource Source # | |
| Generic Resource Source # | |
| Read Resource Source # | |
| Show Resource Source # | |
| NFData Resource Source # | |
Defined in Amazonka.CodeStar.Types.Resource | |
| Eq Resource Source # | |
| Hashable Resource Source # | |
Defined in Amazonka.CodeStar.Types.Resource | |
| type Rep Resource Source # | |
Defined in Amazonka.CodeStar.Types.Resource | |
Create a value of Resource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:Resource', resource_id - The Amazon Resource Name (ARN) of the resource.
S3Location
data S3Location Source #
The Amazon S3 location where the source code files provided with the project request are stored.
See: newS3Location smart constructor.
Constructors
| S3Location' (Maybe Text) (Maybe Text) |
Instances
newS3Location :: S3Location Source #
Create a value of S3Location with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucketKey:S3Location', s3Location_bucketKey - The Amazon S3 object key where the source code files provided with the
project request are stored.
$sel:bucketName:S3Location', s3Location_bucketName - The Amazon S3 bucket name where the source code files provided with the
project request are stored.
TeamMember
data TeamMember Source #
Information about a team member in a project.
See: newTeamMember smart constructor.
Constructors
| TeamMember' (Maybe Bool) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> TeamMember |
Create a value of TeamMember with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:remoteAccessAllowed:TeamMember', teamMember_remoteAccessAllowed - Whether the user is allowed to remotely access project resources using
an SSH public/private key pair.
$sel:userArn:TeamMember', teamMember_userArn - The Amazon Resource Name (ARN) of the user in IAM.
$sel:projectRole:TeamMember', teamMember_projectRole - The role assigned to the user in the project. Project roles have
different levels of access. For more information, see
Working with Teams
in the AWS CodeStar User Guide.
Toolchain
The toolchain template file provided with the project request. AWS CodeStar uses the template to provision the toolchain stack in AWS CloudFormation.
See: newToolchain smart constructor.
Constructors
| Toolchain' (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) ToolchainSource |
Instances
| ToJSON Toolchain Source # | |
Defined in Amazonka.CodeStar.Types.Toolchain | |
| Generic Toolchain Source # | |
| Show Toolchain Source # | |
| NFData Toolchain Source # | |
Defined in Amazonka.CodeStar.Types.Toolchain | |
| Eq Toolchain Source # | |
| Hashable Toolchain Source # | |
Defined in Amazonka.CodeStar.Types.Toolchain | |
| type Rep Toolchain Source # | |
Defined in Amazonka.CodeStar.Types.Toolchain type Rep Toolchain = D1 ('MetaData "Toolchain" "Amazonka.CodeStar.Types.Toolchain" "amazonka-codestar-2.0-J6u0QgMrENu7wBmwByxQnV" 'False) (C1 ('MetaCons "Toolchain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "stackParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (Sensitive Text)))) :*: S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ToolchainSource)))) | |
Arguments
| :: ToolchainSource | |
| -> Toolchain |
Create a value of Toolchain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roleArn:Toolchain', toolchain_roleArn - The service role ARN for AWS CodeStar to use for the toolchain template
during stack provisioning.
$sel:stackParameters:Toolchain', toolchain_stackParameters - The list of parameter overrides to be passed into the toolchain template
during stack provisioning, if any.
$sel:source:Toolchain', toolchain_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
data 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.
See: newToolchainSource smart constructor.
Constructors
| ToolchainSource' S3Location |
Instances
Arguments
| :: S3Location | |
| -> ToolchainSource |
Create a value of ToolchainSource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3:ToolchainSource', toolchainSource_s3 - The Amazon S3 bucket where the toolchain template file provided with the
project request is stored.
UserProfileSummary
data UserProfileSummary Source #
Information about a user's profile in AWS CodeStar.
See: newUserProfileSummary smart constructor.
Constructors
| UserProfileSummary' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) |
Instances
newUserProfileSummary :: UserProfileSummary Source #
Create a value of UserProfileSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:displayName:UserProfileSummary', userProfileSummary_displayName - The display name of a user in AWS CodeStar. For example, this could be
set to both first and last name ("Mary Major") or a single name
("Mary"). The display name is also used to generate the initial icon
associated with the user in AWS CodeStar projects. If spaces are
included in the display name, the first character that appears after the
space will be used as the second character in the user initial icon. The
initial icon displays a maximum of two characters, so a display name
with more than one space (for example "Mary Jane Major") would
generate an initial icon using the first character and the first
character after the space ("MJ", not "MM").
$sel:emailAddress:UserProfileSummary', userProfileSummary_emailAddress - The email address associated with the user.
$sel:sshPublicKey:UserProfileSummary', userProfileSummary_sshPublicKey - The SSH public key associated with the user in AWS CodeStar. If a
project owner allows the user remote access to project resources, this
public key will be used along with the user's private key for SSH
access.
$sel:userArn:UserProfileSummary', userProfileSummary_userArn - The Amazon Resource Name (ARN) of the user in IAM.