| 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.CodeBuild
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- ListProjects (Paginated)
- DeleteProject
- UpdateProject
- DeleteSourceCredentials
- ListBuilds (Paginated)
- ListSourceCredentials
- ListReports (Paginated)
- DeleteReport
- CreateWebhook
- StopBuildBatch
- ListSharedProjects (Paginated)
- CreateReportGroup
- DescribeCodeCoverages (Paginated)
- ImportSourceCredentials
- ListBuildBatchesForProject (Paginated)
- BatchGetReportGroups
- DeleteBuildBatch
- StartBuild
- BatchGetBuildBatches
- RetryBuild
- ListBuildsForProject (Paginated)
- DescribeTestCases (Paginated)
- GetResourcePolicy
- BatchGetProjects
- BatchGetBuilds
- BatchGetReports
- UpdateWebhook
- DeleteWebhook
- StartBuildBatch
- RetryBuildBatch
- UpdateProjectVisibility
- ListReportsForReportGroup (Paginated)
- InvalidateProjectCache
- UpdateReportGroup
- DeleteReportGroup
- BatchDeleteBuilds
- ListReportGroups (Paginated)
- PutResourcePolicy
- DeleteResourcePolicy
- ListCuratedEnvironmentImages
- GetReportGroupTrend
- StopBuild
- ListBuildBatches (Paginated)
- CreateProject
- ListSharedReportGroups (Paginated)
- Types
- ArtifactNamespace
- ArtifactPackaging
- ArtifactsType
- AuthType
- BatchReportModeType
- BucketOwnerAccess
- BuildBatchPhaseType
- BuildPhaseType
- CacheMode
- CacheType
- ComputeType
- CredentialProviderType
- EnvironmentType
- EnvironmentVariableType
- FileSystemType
- ImagePullCredentialsType
- LanguageType
- LogsConfigStatusType
- PlatformType
- ProjectSortByType
- ProjectVisibilityType
- ReportCodeCoverageSortByType
- ReportExportConfigType
- ReportGroupSortByType
- ReportGroupStatusType
- ReportGroupTrendFieldType
- ReportPackagingType
- ReportStatusType
- ReportType
- RetryBuildBatchType
- ServerType
- SharedResourceSortByType
- SortOrderType
- SourceAuthType
- SourceType
- StatusType
- WebhookBuildType
- WebhookFilterType
- BatchRestrictions
- Build
- BuildArtifacts
- BuildBatch
- BuildBatchFilter
- BuildBatchPhase
- BuildGroup
- BuildNotDeleted
- BuildPhase
- BuildStatusConfig
- BuildSummary
- CloudWatchLogsConfig
- CodeCoverage
- CodeCoverageReportSummary
- DebugSession
- EnvironmentImage
- EnvironmentLanguage
- EnvironmentPlatform
- EnvironmentVariable
- ExportedEnvironmentVariable
- GitSubmodulesConfig
- LogsConfig
- LogsLocation
- NetworkInterface
- PhaseContext
- Project
- ProjectArtifacts
- ProjectBadge
- ProjectBuildBatchConfig
- ProjectCache
- ProjectEnvironment
- ProjectFileSystemLocation
- ProjectSource
- ProjectSourceVersion
- RegistryCredential
- Report
- ReportExportConfig
- ReportFilter
- ReportGroup
- ReportGroupTrendStats
- ReportWithRawData
- ResolvedArtifact
- S3LogsConfig
- S3ReportExportConfig
- SourceAuth
- SourceCredentialsInfo
- Tag
- TestCase
- TestCaseFilter
- TestReportSummary
- VpcConfig
- Webhook
- WebhookFilter
Description
Derived from API version 2016-10-06 of the AWS service descriptions, licensed under Apache 2.0.
CodeBuild
CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the <https:docs.aws.amazon.comcodebuildlatestuserguidewelcome.html CodeBuild User Guide>.
Synopsis
- defaultService :: Service
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _OAuthProviderException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccountLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- data ListProjects = ListProjects' (Maybe SortOrderType) (Maybe Text) (Maybe ProjectSortByType)
- newListProjects :: ListProjects
- data ListProjectsResponse = ListProjectsResponse' (Maybe Text) (Maybe (NonEmpty Text)) Int
- newListProjectsResponse :: Int -> ListProjectsResponse
- data DeleteProject = DeleteProject' Text
- newDeleteProject :: Text -> DeleteProject
- data DeleteProjectResponse = DeleteProjectResponse' Int
- newDeleteProjectResponse :: Int -> DeleteProjectResponse
- data UpdateProject = UpdateProject' (Maybe [ProjectArtifacts]) (Maybe ProjectArtifacts) (Maybe ProjectEnvironment) (Maybe Int) (Maybe Bool) (Maybe [ProjectSourceVersion]) (Maybe Natural) (Maybe ProjectCache) (Maybe [ProjectSource]) (Maybe Text) (Maybe VpcConfig) (Maybe ProjectSource) (Maybe LogsConfig) (Maybe [ProjectFileSystemLocation]) (Maybe ProjectBuildBatchConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Natural) Text
- newUpdateProject :: Text -> UpdateProject
- data UpdateProjectResponse = UpdateProjectResponse' (Maybe Project) Int
- newUpdateProjectResponse :: Int -> UpdateProjectResponse
- data DeleteSourceCredentials = DeleteSourceCredentials' Text
- newDeleteSourceCredentials :: Text -> DeleteSourceCredentials
- data DeleteSourceCredentialsResponse = DeleteSourceCredentialsResponse' (Maybe Text) Int
- newDeleteSourceCredentialsResponse :: Int -> DeleteSourceCredentialsResponse
- data ListBuilds = ListBuilds' (Maybe SortOrderType) (Maybe Text)
- newListBuilds :: ListBuilds
- data ListBuildsResponse = ListBuildsResponse' (Maybe (NonEmpty Text)) (Maybe Text) Int
- newListBuildsResponse :: Int -> ListBuildsResponse
- data ListSourceCredentials = ListSourceCredentials' {
- newListSourceCredentials :: ListSourceCredentials
- data ListSourceCredentialsResponse = ListSourceCredentialsResponse' (Maybe [SourceCredentialsInfo]) Int
- newListSourceCredentialsResponse :: Int -> ListSourceCredentialsResponse
- data ListReports = ListReports' (Maybe SortOrderType) (Maybe Text) (Maybe ReportFilter) (Maybe Natural)
- newListReports :: ListReports
- data ListReportsResponse = ListReportsResponse' (Maybe (NonEmpty Text)) (Maybe Text) Int
- newListReportsResponse :: Int -> ListReportsResponse
- data DeleteReport = DeleteReport' Text
- newDeleteReport :: Text -> DeleteReport
- data DeleteReportResponse = DeleteReportResponse' Int
- newDeleteReportResponse :: Int -> DeleteReportResponse
- data CreateWebhook = CreateWebhook' (Maybe Text) (Maybe [[WebhookFilter]]) (Maybe WebhookBuildType) Text
- newCreateWebhook :: Text -> CreateWebhook
- data CreateWebhookResponse = CreateWebhookResponse' (Maybe Webhook) Int
- newCreateWebhookResponse :: Int -> CreateWebhookResponse
- data StopBuildBatch = StopBuildBatch' Text
- newStopBuildBatch :: Text -> StopBuildBatch
- data StopBuildBatchResponse = StopBuildBatchResponse' (Maybe BuildBatch) Int
- newStopBuildBatchResponse :: Int -> StopBuildBatchResponse
- data ListSharedProjects = ListSharedProjects' (Maybe SortOrderType) (Maybe Text) (Maybe Natural) (Maybe SharedResourceSortByType)
- newListSharedProjects :: ListSharedProjects
- data ListSharedProjectsResponse = ListSharedProjectsResponse' (Maybe Text) (Maybe (NonEmpty Text)) Int
- newListSharedProjectsResponse :: Int -> ListSharedProjectsResponse
- data CreateReportGroup = CreateReportGroup' (Maybe [Tag]) Text ReportType ReportExportConfig
- newCreateReportGroup :: Text -> ReportType -> ReportExportConfig -> CreateReportGroup
- data CreateReportGroupResponse = CreateReportGroupResponse' (Maybe ReportGroup) Int
- newCreateReportGroupResponse :: Int -> CreateReportGroupResponse
- data DescribeCodeCoverages = DescribeCodeCoverages' (Maybe Double) (Maybe SortOrderType) (Maybe Double) (Maybe Text) (Maybe Natural) (Maybe ReportCodeCoverageSortByType) Text
- newDescribeCodeCoverages :: Text -> DescribeCodeCoverages
- data DescribeCodeCoveragesResponse = DescribeCodeCoveragesResponse' (Maybe [CodeCoverage]) (Maybe Text) Int
- newDescribeCodeCoveragesResponse :: Int -> DescribeCodeCoveragesResponse
- data ImportSourceCredentials = ImportSourceCredentials' (Maybe Text) (Maybe Bool) (Sensitive Text) ServerType AuthType
- newImportSourceCredentials :: Text -> ServerType -> AuthType -> ImportSourceCredentials
- data ImportSourceCredentialsResponse = ImportSourceCredentialsResponse' (Maybe Text) Int
- newImportSourceCredentialsResponse :: Int -> ImportSourceCredentialsResponse
- data ListBuildBatchesForProject = ListBuildBatchesForProject' (Maybe SortOrderType) (Maybe Text) (Maybe Text) (Maybe BuildBatchFilter) (Maybe Natural)
- newListBuildBatchesForProject :: ListBuildBatchesForProject
- data ListBuildBatchesForProjectResponse = ListBuildBatchesForProjectResponse' (Maybe [Text]) (Maybe Text) Int
- newListBuildBatchesForProjectResponse :: Int -> ListBuildBatchesForProjectResponse
- data BatchGetReportGroups = BatchGetReportGroups' (NonEmpty Text)
- newBatchGetReportGroups :: NonEmpty Text -> BatchGetReportGroups
- data BatchGetReportGroupsResponse = BatchGetReportGroupsResponse' (Maybe (NonEmpty ReportGroup)) (Maybe (NonEmpty Text)) Int
- newBatchGetReportGroupsResponse :: Int -> BatchGetReportGroupsResponse
- data DeleteBuildBatch = DeleteBuildBatch' Text
- newDeleteBuildBatch :: Text -> DeleteBuildBatch
- data DeleteBuildBatchResponse = DeleteBuildBatchResponse' (Maybe [BuildNotDeleted]) (Maybe (NonEmpty Text)) (Maybe Text) Int
- newDeleteBuildBatchResponse :: Int -> DeleteBuildBatchResponse
- data StartBuild = StartBuild' (Maybe Text) (Maybe Text) (Maybe [EnvironmentVariable]) (Maybe BuildStatusConfig) (Maybe Text) (Maybe Bool) (Maybe RegistryCredential) (Maybe Natural) (Maybe Text) (Maybe ProjectCache) (Maybe Natural) (Maybe [ProjectSource]) (Maybe Natural) (Maybe ImagePullCredentialsType) (Maybe LogsConfig) (Maybe SourceAuth) (Maybe GitSubmodulesConfig) (Maybe EnvironmentType) (Maybe Text) (Maybe ComputeType) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [ProjectSourceVersion]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [ProjectArtifacts]) (Maybe ProjectArtifacts) (Maybe SourceType) Text
- newStartBuild :: Text -> StartBuild
- data StartBuildResponse = StartBuildResponse' (Maybe Build) Int
- newStartBuildResponse :: Int -> StartBuildResponse
- data BatchGetBuildBatches = BatchGetBuildBatches' [Text]
- newBatchGetBuildBatches :: BatchGetBuildBatches
- data BatchGetBuildBatchesResponse = BatchGetBuildBatchesResponse' (Maybe [BuildBatch]) (Maybe [Text]) Int
- newBatchGetBuildBatchesResponse :: Int -> BatchGetBuildBatchesResponse
- data RetryBuild = RetryBuild' (Maybe Text) (Maybe Text)
- newRetryBuild :: RetryBuild
- data RetryBuildResponse = RetryBuildResponse' (Maybe Build) Int
- newRetryBuildResponse :: Int -> RetryBuildResponse
- data ListBuildsForProject = ListBuildsForProject' (Maybe SortOrderType) (Maybe Text) Text
- newListBuildsForProject :: Text -> ListBuildsForProject
- data ListBuildsForProjectResponse = ListBuildsForProjectResponse' (Maybe (NonEmpty Text)) (Maybe Text) Int
- newListBuildsForProjectResponse :: Int -> ListBuildsForProjectResponse
- data DescribeTestCases = DescribeTestCases' (Maybe Text) (Maybe TestCaseFilter) (Maybe Natural) Text
- newDescribeTestCases :: Text -> DescribeTestCases
- data DescribeTestCasesResponse = DescribeTestCasesResponse' (Maybe Text) (Maybe [TestCase]) Int
- newDescribeTestCasesResponse :: Int -> DescribeTestCasesResponse
- data GetResourcePolicy = GetResourcePolicy' Text
- newGetResourcePolicy :: Text -> GetResourcePolicy
- data GetResourcePolicyResponse = GetResourcePolicyResponse' (Maybe Text) Int
- newGetResourcePolicyResponse :: Int -> GetResourcePolicyResponse
- data BatchGetProjects = BatchGetProjects' (NonEmpty Text)
- newBatchGetProjects :: NonEmpty Text -> BatchGetProjects
- data BatchGetProjectsResponse = BatchGetProjectsResponse' (Maybe (NonEmpty Text)) (Maybe [Project]) Int
- newBatchGetProjectsResponse :: Int -> BatchGetProjectsResponse
- data BatchGetBuilds = BatchGetBuilds' (NonEmpty Text)
- newBatchGetBuilds :: NonEmpty Text -> BatchGetBuilds
- data BatchGetBuildsResponse = BatchGetBuildsResponse' (Maybe [Build]) (Maybe (NonEmpty Text)) Int
- newBatchGetBuildsResponse :: Int -> BatchGetBuildsResponse
- data BatchGetReports = BatchGetReports' (NonEmpty Text)
- newBatchGetReports :: NonEmpty Text -> BatchGetReports
- data BatchGetReportsResponse = BatchGetReportsResponse' (Maybe (NonEmpty Report)) (Maybe (NonEmpty Text)) Int
- newBatchGetReportsResponse :: Int -> BatchGetReportsResponse
- data UpdateWebhook = UpdateWebhook' (Maybe Text) (Maybe Bool) (Maybe [[WebhookFilter]]) (Maybe WebhookBuildType) Text
- newUpdateWebhook :: Text -> UpdateWebhook
- data UpdateWebhookResponse = UpdateWebhookResponse' (Maybe Webhook) Int
- newUpdateWebhookResponse :: Int -> UpdateWebhookResponse
- data DeleteWebhook = DeleteWebhook' Text
- newDeleteWebhook :: Text -> DeleteWebhook
- data DeleteWebhookResponse = DeleteWebhookResponse' Int
- newDeleteWebhookResponse :: Int -> DeleteWebhookResponse
- data StartBuildBatch = StartBuildBatch' (Maybe Text) (Maybe Text) (Maybe ProjectBuildBatchConfig) (Maybe [EnvironmentVariable]) (Maybe Text) (Maybe Bool) (Maybe RegistryCredential) (Maybe Text) (Maybe ProjectCache) (Maybe Natural) (Maybe [ProjectSource]) (Maybe Natural) (Maybe ImagePullCredentialsType) (Maybe LogsConfig) (Maybe SourceAuth) (Maybe GitSubmodulesConfig) (Maybe EnvironmentType) (Maybe Text) (Maybe ComputeType) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [ProjectSourceVersion]) (Maybe Bool) (Maybe Text) (Maybe [ProjectArtifacts]) (Maybe Natural) (Maybe ProjectArtifacts) (Maybe SourceType) Text
- newStartBuildBatch :: Text -> StartBuildBatch
- data StartBuildBatchResponse = StartBuildBatchResponse' (Maybe BuildBatch) Int
- newStartBuildBatchResponse :: Int -> StartBuildBatchResponse
- data RetryBuildBatch = RetryBuildBatch' (Maybe Text) (Maybe Text) (Maybe RetryBuildBatchType)
- newRetryBuildBatch :: RetryBuildBatch
- data RetryBuildBatchResponse = RetryBuildBatchResponse' (Maybe BuildBatch) Int
- newRetryBuildBatchResponse :: Int -> RetryBuildBatchResponse
- data UpdateProjectVisibility = UpdateProjectVisibility' (Maybe Text) Text ProjectVisibilityType
- newUpdateProjectVisibility :: Text -> ProjectVisibilityType -> UpdateProjectVisibility
- data UpdateProjectVisibilityResponse = UpdateProjectVisibilityResponse' (Maybe Text) (Maybe Text) (Maybe ProjectVisibilityType) Int
- newUpdateProjectVisibilityResponse :: Int -> UpdateProjectVisibilityResponse
- data ListReportsForReportGroup = ListReportsForReportGroup' (Maybe SortOrderType) (Maybe Text) (Maybe ReportFilter) (Maybe Natural) Text
- newListReportsForReportGroup :: Text -> ListReportsForReportGroup
- data ListReportsForReportGroupResponse = ListReportsForReportGroupResponse' (Maybe (NonEmpty Text)) (Maybe Text) Int
- newListReportsForReportGroupResponse :: Int -> ListReportsForReportGroupResponse
- data InvalidateProjectCache = InvalidateProjectCache' Text
- newInvalidateProjectCache :: Text -> InvalidateProjectCache
- data InvalidateProjectCacheResponse = InvalidateProjectCacheResponse' Int
- newInvalidateProjectCacheResponse :: Int -> InvalidateProjectCacheResponse
- data UpdateReportGroup = UpdateReportGroup' (Maybe ReportExportConfig) (Maybe [Tag]) Text
- newUpdateReportGroup :: Text -> UpdateReportGroup
- data UpdateReportGroupResponse = UpdateReportGroupResponse' (Maybe ReportGroup) Int
- newUpdateReportGroupResponse :: Int -> UpdateReportGroupResponse
- data DeleteReportGroup = DeleteReportGroup' (Maybe Bool) Text
- newDeleteReportGroup :: Text -> DeleteReportGroup
- data DeleteReportGroupResponse = DeleteReportGroupResponse' Int
- newDeleteReportGroupResponse :: Int -> DeleteReportGroupResponse
- data BatchDeleteBuilds = BatchDeleteBuilds' (NonEmpty Text)
- newBatchDeleteBuilds :: NonEmpty Text -> BatchDeleteBuilds
- data BatchDeleteBuildsResponse = BatchDeleteBuildsResponse' (Maybe [BuildNotDeleted]) (Maybe (NonEmpty Text)) Int
- newBatchDeleteBuildsResponse :: Int -> BatchDeleteBuildsResponse
- data ListReportGroups = ListReportGroups' (Maybe SortOrderType) (Maybe Text) (Maybe Natural) (Maybe ReportGroupSortByType)
- newListReportGroups :: ListReportGroups
- data ListReportGroupsResponse = ListReportGroupsResponse' (Maybe Text) (Maybe (NonEmpty Text)) Int
- newListReportGroupsResponse :: Int -> ListReportGroupsResponse
- data PutResourcePolicy = PutResourcePolicy' Text Text
- newPutResourcePolicy :: Text -> Text -> PutResourcePolicy
- data PutResourcePolicyResponse = PutResourcePolicyResponse' (Maybe Text) Int
- newPutResourcePolicyResponse :: Int -> PutResourcePolicyResponse
- data DeleteResourcePolicy = DeleteResourcePolicy' Text
- newDeleteResourcePolicy :: Text -> DeleteResourcePolicy
- data DeleteResourcePolicyResponse = DeleteResourcePolicyResponse' Int
- newDeleteResourcePolicyResponse :: Int -> DeleteResourcePolicyResponse
- data ListCuratedEnvironmentImages = ListCuratedEnvironmentImages' {
- newListCuratedEnvironmentImages :: ListCuratedEnvironmentImages
- data ListCuratedEnvironmentImagesResponse = ListCuratedEnvironmentImagesResponse' (Maybe [EnvironmentPlatform]) Int
- newListCuratedEnvironmentImagesResponse :: Int -> ListCuratedEnvironmentImagesResponse
- data GetReportGroupTrend = GetReportGroupTrend' (Maybe Natural) Text ReportGroupTrendFieldType
- newGetReportGroupTrend :: Text -> ReportGroupTrendFieldType -> GetReportGroupTrend
- data GetReportGroupTrendResponse = GetReportGroupTrendResponse' (Maybe [ReportWithRawData]) (Maybe ReportGroupTrendStats) Int
- newGetReportGroupTrendResponse :: Int -> GetReportGroupTrendResponse
- data StopBuild = StopBuild' Text
- newStopBuild :: Text -> StopBuild
- data StopBuildResponse = StopBuildResponse' (Maybe Build) Int
- newStopBuildResponse :: Int -> StopBuildResponse
- data ListBuildBatches = ListBuildBatches' (Maybe SortOrderType) (Maybe Text) (Maybe BuildBatchFilter) (Maybe Natural)
- newListBuildBatches :: ListBuildBatches
- data ListBuildBatchesResponse = ListBuildBatchesResponse' (Maybe [Text]) (Maybe Text) Int
- newListBuildBatchesResponse :: Int -> ListBuildBatchesResponse
- data CreateProject = CreateProject' (Maybe [ProjectArtifacts]) (Maybe Int) (Maybe Bool) (Maybe [ProjectSourceVersion]) (Maybe Natural) (Maybe ProjectCache) (Maybe [ProjectSource]) (Maybe Text) (Maybe VpcConfig) (Maybe LogsConfig) (Maybe [ProjectFileSystemLocation]) (Maybe ProjectBuildBatchConfig) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Natural) Text ProjectSource ProjectArtifacts ProjectEnvironment Text
- newCreateProject :: Text -> ProjectSource -> ProjectArtifacts -> ProjectEnvironment -> Text -> CreateProject
- data CreateProjectResponse = CreateProjectResponse' (Maybe Project) Int
- newCreateProjectResponse :: Int -> CreateProjectResponse
- data ListSharedReportGroups = ListSharedReportGroups' (Maybe SortOrderType) (Maybe Text) (Maybe Natural) (Maybe SharedResourceSortByType)
- newListSharedReportGroups :: ListSharedReportGroups
- data ListSharedReportGroupsResponse = ListSharedReportGroupsResponse' (Maybe Text) (Maybe (NonEmpty Text)) Int
- newListSharedReportGroupsResponse :: Int -> ListSharedReportGroupsResponse
- newtype ArtifactNamespace where
- ArtifactNamespace' { }
- pattern ArtifactNamespace_BUILD_ID :: ArtifactNamespace
- pattern ArtifactNamespace_NONE :: ArtifactNamespace
- newtype ArtifactPackaging where
- ArtifactPackaging' { }
- pattern ArtifactPackaging_NONE :: ArtifactPackaging
- pattern ArtifactPackaging_ZIP :: ArtifactPackaging
- newtype ArtifactsType where
- ArtifactsType' { }
- pattern ArtifactsType_CODEPIPELINE :: ArtifactsType
- pattern ArtifactsType_NO_ARTIFACTS :: ArtifactsType
- pattern ArtifactsType_S3 :: ArtifactsType
- newtype AuthType where
- AuthType' {
- fromAuthType :: Text
- pattern AuthType_BASIC_AUTH :: AuthType
- pattern AuthType_OAUTH :: AuthType
- pattern AuthType_PERSONAL_ACCESS_TOKEN :: AuthType
- AuthType' {
- newtype BatchReportModeType where
- newtype BucketOwnerAccess where
- BucketOwnerAccess' { }
- pattern BucketOwnerAccess_FULL :: BucketOwnerAccess
- pattern BucketOwnerAccess_NONE :: BucketOwnerAccess
- pattern BucketOwnerAccess_READ_ONLY :: BucketOwnerAccess
- newtype BuildBatchPhaseType where
- BuildBatchPhaseType' { }
- pattern BuildBatchPhaseType_COMBINE_ARTIFACTS :: BuildBatchPhaseType
- pattern BuildBatchPhaseType_DOWNLOAD_BATCHSPEC :: BuildBatchPhaseType
- pattern BuildBatchPhaseType_FAILED :: BuildBatchPhaseType
- pattern BuildBatchPhaseType_IN_PROGRESS :: BuildBatchPhaseType
- pattern BuildBatchPhaseType_STOPPED :: BuildBatchPhaseType
- pattern BuildBatchPhaseType_SUBMITTED :: BuildBatchPhaseType
- pattern BuildBatchPhaseType_SUCCEEDED :: BuildBatchPhaseType
- newtype BuildPhaseType where
- BuildPhaseType' { }
- pattern BuildPhaseType_BUILD :: BuildPhaseType
- pattern BuildPhaseType_COMPLETED :: BuildPhaseType
- pattern BuildPhaseType_DOWNLOAD_SOURCE :: BuildPhaseType
- pattern BuildPhaseType_FINALIZING :: BuildPhaseType
- pattern BuildPhaseType_INSTALL :: BuildPhaseType
- pattern BuildPhaseType_POST_BUILD :: BuildPhaseType
- pattern BuildPhaseType_PRE_BUILD :: BuildPhaseType
- pattern BuildPhaseType_PROVISIONING :: BuildPhaseType
- pattern BuildPhaseType_QUEUED :: BuildPhaseType
- pattern BuildPhaseType_SUBMITTED :: BuildPhaseType
- pattern BuildPhaseType_UPLOAD_ARTIFACTS :: BuildPhaseType
- newtype CacheMode where
- CacheMode' { }
- pattern CacheMode_LOCAL_CUSTOM_CACHE :: CacheMode
- pattern CacheMode_LOCAL_DOCKER_LAYER_CACHE :: CacheMode
- pattern CacheMode_LOCAL_SOURCE_CACHE :: CacheMode
- newtype CacheType where
- CacheType' { }
- pattern CacheType_LOCAL :: CacheType
- pattern CacheType_NO_CACHE :: CacheType
- pattern CacheType_S3 :: CacheType
- newtype ComputeType where
- ComputeType' { }
- pattern ComputeType_BUILD_GENERAL1_2XLARGE :: ComputeType
- pattern ComputeType_BUILD_GENERAL1_LARGE :: ComputeType
- pattern ComputeType_BUILD_GENERAL1_MEDIUM :: ComputeType
- pattern ComputeType_BUILD_GENERAL1_SMALL :: ComputeType
- newtype CredentialProviderType where
- newtype EnvironmentType where
- EnvironmentType' { }
- pattern EnvironmentType_ARM_CONTAINER :: EnvironmentType
- pattern EnvironmentType_LINUX_CONTAINER :: EnvironmentType
- pattern EnvironmentType_LINUX_GPU_CONTAINER :: EnvironmentType
- pattern EnvironmentType_WINDOWS_CONTAINER :: EnvironmentType
- pattern EnvironmentType_WINDOWS_SERVER_2019_CONTAINER :: EnvironmentType
- newtype EnvironmentVariableType where
- newtype FileSystemType where
- FileSystemType' { }
- pattern FileSystemType_EFS :: FileSystemType
- newtype ImagePullCredentialsType where
- newtype LanguageType where
- LanguageType' { }
- pattern LanguageType_ANDROID :: LanguageType
- pattern LanguageType_BASE :: LanguageType
- pattern LanguageType_DOCKER :: LanguageType
- pattern LanguageType_DOTNET :: LanguageType
- pattern LanguageType_GOLANG :: LanguageType
- pattern LanguageType_JAVA :: LanguageType
- pattern LanguageType_NODE_JS :: LanguageType
- pattern LanguageType_PHP :: LanguageType
- pattern LanguageType_PYTHON :: LanguageType
- pattern LanguageType_RUBY :: LanguageType
- newtype LogsConfigStatusType where
- newtype PlatformType where
- PlatformType' { }
- pattern PlatformType_AMAZON_LINUX :: PlatformType
- pattern PlatformType_DEBIAN :: PlatformType
- pattern PlatformType_UBUNTU :: PlatformType
- pattern PlatformType_WINDOWS_SERVER :: PlatformType
- newtype ProjectSortByType where
- newtype ProjectVisibilityType where
- newtype ReportCodeCoverageSortByType where
- newtype ReportExportConfigType where
- newtype ReportGroupSortByType where
- newtype ReportGroupStatusType where
- newtype ReportGroupTrendFieldType where
- ReportGroupTrendFieldType' { }
- pattern ReportGroupTrendFieldType_BRANCHES_COVERED :: ReportGroupTrendFieldType
- pattern ReportGroupTrendFieldType_BRANCHES_MISSED :: ReportGroupTrendFieldType
- pattern ReportGroupTrendFieldType_BRANCH_COVERAGE :: ReportGroupTrendFieldType
- pattern ReportGroupTrendFieldType_DURATION :: ReportGroupTrendFieldType
- pattern ReportGroupTrendFieldType_LINES_COVERED :: ReportGroupTrendFieldType
- pattern ReportGroupTrendFieldType_LINES_MISSED :: ReportGroupTrendFieldType
- pattern ReportGroupTrendFieldType_LINE_COVERAGE :: ReportGroupTrendFieldType
- pattern ReportGroupTrendFieldType_PASS_RATE :: ReportGroupTrendFieldType
- pattern ReportGroupTrendFieldType_TOTAL :: ReportGroupTrendFieldType
- newtype ReportPackagingType where
- ReportPackagingType' { }
- pattern ReportPackagingType_NONE :: ReportPackagingType
- pattern ReportPackagingType_ZIP :: ReportPackagingType
- newtype ReportStatusType where
- ReportStatusType' { }
- pattern ReportStatusType_DELETING :: ReportStatusType
- pattern ReportStatusType_FAILED :: ReportStatusType
- pattern ReportStatusType_GENERATING :: ReportStatusType
- pattern ReportStatusType_INCOMPLETE :: ReportStatusType
- pattern ReportStatusType_SUCCEEDED :: ReportStatusType
- newtype ReportType where
- ReportType' { }
- pattern ReportType_CODE_COVERAGE :: ReportType
- pattern ReportType_TEST :: ReportType
- newtype RetryBuildBatchType where
- newtype ServerType where
- ServerType' { }
- pattern ServerType_BITBUCKET :: ServerType
- pattern ServerType_GITHUB :: ServerType
- pattern ServerType_GITHUB_ENTERPRISE :: ServerType
- newtype SharedResourceSortByType where
- newtype SortOrderType where
- SortOrderType' { }
- pattern SortOrderType_ASCENDING :: SortOrderType
- pattern SortOrderType_DESCENDING :: SortOrderType
- newtype SourceAuthType where
- SourceAuthType' { }
- pattern SourceAuthType_OAUTH :: SourceAuthType
- newtype SourceType where
- SourceType' { }
- pattern SourceType_BITBUCKET :: SourceType
- pattern SourceType_CODECOMMIT :: SourceType
- pattern SourceType_CODEPIPELINE :: SourceType
- pattern SourceType_GITHUB :: SourceType
- pattern SourceType_GITHUB_ENTERPRISE :: SourceType
- pattern SourceType_NO_SOURCE :: SourceType
- pattern SourceType_S3 :: SourceType
- newtype StatusType where
- StatusType' { }
- pattern StatusType_FAILED :: StatusType
- pattern StatusType_FAULT :: StatusType
- pattern StatusType_IN_PROGRESS :: StatusType
- pattern StatusType_STOPPED :: StatusType
- pattern StatusType_SUCCEEDED :: StatusType
- pattern StatusType_TIMED_OUT :: StatusType
- newtype WebhookBuildType where
- WebhookBuildType' { }
- pattern WebhookBuildType_BUILD :: WebhookBuildType
- pattern WebhookBuildType_BUILD_BATCH :: WebhookBuildType
- newtype WebhookFilterType where
- WebhookFilterType' { }
- pattern WebhookFilterType_ACTOR_ACCOUNT_ID :: WebhookFilterType
- pattern WebhookFilterType_BASE_REF :: WebhookFilterType
- pattern WebhookFilterType_COMMIT_MESSAGE :: WebhookFilterType
- pattern WebhookFilterType_EVENT :: WebhookFilterType
- pattern WebhookFilterType_FILE_PATH :: WebhookFilterType
- pattern WebhookFilterType_HEAD_REF :: WebhookFilterType
- data BatchRestrictions = BatchRestrictions' (Maybe Int) (Maybe [Text])
- newBatchRestrictions :: BatchRestrictions
- data Build = Build' (Maybe [BuildPhase]) (Maybe Bool) (Maybe [BuildArtifacts]) (Maybe Text) (Maybe [ExportedEnvironmentVariable]) (Maybe Integer) (Maybe POSIX) (Maybe BuildArtifacts) (Maybe ProjectEnvironment) (Maybe Text) (Maybe NetworkInterface) (Maybe [ProjectSourceVersion]) (Maybe Text) (Maybe Int) (Maybe ProjectCache) (Maybe [ProjectSource]) (Maybe DebugSession) (Maybe Text) (Maybe Text) (Maybe LogsLocation) (Maybe Text) (Maybe VpcConfig) (Maybe POSIX) (Maybe Text) (Maybe StatusType) (Maybe ProjectSource) (Maybe Text) (Maybe [ProjectFileSystemLocation]) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Int)
- newBuild :: Build
- data BuildArtifacts = BuildArtifacts' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe BucketOwnerAccess)
- newBuildArtifacts :: BuildArtifacts
- data BuildBatch = BuildBatch' (Maybe [BuildBatchPhase]) (Maybe [BuildArtifacts]) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe BuildArtifacts) (Maybe ProjectEnvironment) (Maybe Text) (Maybe [ProjectSourceVersion]) (Maybe StatusType) (Maybe Text) (Maybe Integer) (Maybe Int) (Maybe ProjectCache) (Maybe [ProjectSource]) (Maybe Text) (Maybe Text) (Maybe VpcConfig) (Maybe POSIX) (Maybe Text) (Maybe [BuildGroup]) (Maybe ProjectSource) (Maybe Text) (Maybe [ProjectFileSystemLocation]) (Maybe ProjectBuildBatchConfig) (Maybe Text) (Maybe LogsConfig) (Maybe Text) (Maybe Bool)
- newBuildBatch :: BuildBatch
- data BuildBatchFilter = BuildBatchFilter' (Maybe StatusType)
- newBuildBatchFilter :: BuildBatchFilter
- data BuildBatchPhase = BuildBatchPhase' (Maybe [PhaseContext]) (Maybe POSIX) (Maybe StatusType) (Maybe BuildBatchPhaseType) (Maybe POSIX) (Maybe Integer)
- newBuildBatchPhase :: BuildBatchPhase
- data BuildGroup = BuildGroup' (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe BuildSummary) (Maybe [BuildSummary])
- newBuildGroup :: BuildGroup
- data BuildNotDeleted = BuildNotDeleted' (Maybe Text) (Maybe Text)
- newBuildNotDeleted :: BuildNotDeleted
- data BuildPhase = BuildPhase' (Maybe [PhaseContext]) (Maybe POSIX) (Maybe StatusType) (Maybe BuildPhaseType) (Maybe POSIX) (Maybe Integer)
- newBuildPhase :: BuildPhase
- data BuildStatusConfig = BuildStatusConfig' (Maybe Text) (Maybe Text)
- newBuildStatusConfig :: BuildStatusConfig
- data BuildSummary = BuildSummary' (Maybe [ResolvedArtifact]) (Maybe ResolvedArtifact) (Maybe Text) (Maybe StatusType) (Maybe POSIX)
- newBuildSummary :: BuildSummary
- data CloudWatchLogsConfig = CloudWatchLogsConfig' (Maybe Text) (Maybe Text) LogsConfigStatusType
- newCloudWatchLogsConfig :: LogsConfigStatusType -> CloudWatchLogsConfig
- data CodeCoverage = CodeCoverage' (Maybe POSIX) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Double) (Maybe Text) (Maybe Double) (Maybe Text)
- newCodeCoverage :: CodeCoverage
- data CodeCoverageReportSummary = CodeCoverageReportSummary' (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Double) (Maybe Double)
- newCodeCoverageReportSummary :: CodeCoverageReportSummary
- data DebugSession = DebugSession' (Maybe Bool) (Maybe Text)
- newDebugSession :: DebugSession
- data EnvironmentImage = EnvironmentImage' (Maybe [Text]) (Maybe Text) (Maybe Text)
- newEnvironmentImage :: EnvironmentImage
- data EnvironmentLanguage = EnvironmentLanguage' (Maybe [EnvironmentImage]) (Maybe LanguageType)
- newEnvironmentLanguage :: EnvironmentLanguage
- data EnvironmentPlatform = EnvironmentPlatform' (Maybe PlatformType) (Maybe [EnvironmentLanguage])
- newEnvironmentPlatform :: EnvironmentPlatform
- data EnvironmentVariable = EnvironmentVariable' (Maybe EnvironmentVariableType) Text Text
- newEnvironmentVariable :: Text -> Text -> EnvironmentVariable
- data ExportedEnvironmentVariable = ExportedEnvironmentVariable' (Maybe Text) (Maybe Text)
- newExportedEnvironmentVariable :: ExportedEnvironmentVariable
- data GitSubmodulesConfig = GitSubmodulesConfig' Bool
- newGitSubmodulesConfig :: Bool -> GitSubmodulesConfig
- data LogsConfig = LogsConfig' (Maybe S3LogsConfig) (Maybe CloudWatchLogsConfig)
- newLogsConfig :: LogsConfig
- data LogsLocation = LogsLocation' (Maybe Text) (Maybe S3LogsConfig) (Maybe CloudWatchLogsConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newLogsLocation :: LogsLocation
- data NetworkInterface = NetworkInterface' (Maybe Text) (Maybe Text)
- newNetworkInterface :: NetworkInterface
- data PhaseContext = PhaseContext' (Maybe Text) (Maybe Text)
- newPhaseContext :: PhaseContext
- data Project = Project' (Maybe [ProjectArtifacts]) (Maybe Text) (Maybe Text) (Maybe ProjectArtifacts) (Maybe ProjectEnvironment) (Maybe POSIX) (Maybe Int) (Maybe [ProjectSourceVersion]) (Maybe Natural) (Maybe ProjectCache) (Maybe [ProjectSource]) (Maybe Text) (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe ProjectSource) (Maybe ProjectBadge) (Maybe LogsConfig) (Maybe [ProjectFileSystemLocation]) (Maybe ProjectBuildBatchConfig) (Maybe Text) (Maybe POSIX) (Maybe ProjectVisibilityType) (Maybe Webhook) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Natural)
- newProject :: Project
- data ProjectArtifacts = ProjectArtifacts' (Maybe ArtifactPackaging) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe BucketOwnerAccess) (Maybe ArtifactNamespace) ArtifactsType
- newProjectArtifacts :: ArtifactsType -> ProjectArtifacts
- data ProjectBadge = ProjectBadge' (Maybe Bool) (Maybe Text)
- newProjectBadge :: ProjectBadge
- data ProjectBuildBatchConfig = ProjectBuildBatchConfig' (Maybe Bool) (Maybe Int) (Maybe BatchRestrictions) (Maybe BatchReportModeType) (Maybe Text)
- newProjectBuildBatchConfig :: ProjectBuildBatchConfig
- data ProjectCache = ProjectCache' (Maybe Text) (Maybe [CacheMode]) CacheType
- newProjectCache :: CacheType -> ProjectCache
- data ProjectEnvironment = ProjectEnvironment' (Maybe ImagePullCredentialsType) (Maybe Bool) (Maybe RegistryCredential) (Maybe Text) (Maybe [EnvironmentVariable]) EnvironmentType Text ComputeType
- newProjectEnvironment :: EnvironmentType -> Text -> ComputeType -> ProjectEnvironment
- data ProjectFileSystemLocation = ProjectFileSystemLocation' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe FileSystemType) (Maybe Text)
- newProjectFileSystemLocation :: ProjectFileSystemLocation
- data ProjectSource = ProjectSource' (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe SourceAuth) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe GitSubmodulesConfig) (Maybe BuildStatusConfig) SourceType
- newProjectSource :: SourceType -> ProjectSource
- data ProjectSourceVersion = ProjectSourceVersion' Text Text
- newProjectSourceVersion :: Text -> Text -> ProjectSourceVersion
- data RegistryCredential = RegistryCredential' Text CredentialProviderType
- newRegistryCredential :: Text -> CredentialProviderType -> RegistryCredential
- data Report = Report' (Maybe Text) (Maybe ReportStatusType) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe CodeCoverageReportSummary) (Maybe TestReportSummary) (Maybe ReportType) (Maybe ReportExportConfig)
- newReport :: Report
- data ReportExportConfig = ReportExportConfig' (Maybe ReportExportConfigType) (Maybe S3ReportExportConfig)
- newReportExportConfig :: ReportExportConfig
- data ReportFilter = ReportFilter' (Maybe ReportStatusType)
- newReportFilter :: ReportFilter
- data ReportGroup = ReportGroup' (Maybe ReportGroupStatusType) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ReportType) (Maybe POSIX) (Maybe ReportExportConfig) (Maybe [Tag])
- newReportGroup :: ReportGroup
- data ReportGroupTrendStats = ReportGroupTrendStats' (Maybe Text) (Maybe Text) (Maybe Text)
- newReportGroupTrendStats :: ReportGroupTrendStats
- data ReportWithRawData = ReportWithRawData' (Maybe Text) (Maybe Text)
- newReportWithRawData :: ReportWithRawData
- data ResolvedArtifact = ResolvedArtifact' (Maybe Text) (Maybe Text) (Maybe ArtifactsType)
- newResolvedArtifact :: ResolvedArtifact
- data S3LogsConfig = S3LogsConfig' (Maybe Text) (Maybe Bool) (Maybe BucketOwnerAccess) LogsConfigStatusType
- newS3LogsConfig :: LogsConfigStatusType -> S3LogsConfig
- data S3ReportExportConfig = S3ReportExportConfig' (Maybe ReportPackagingType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text)
- newS3ReportExportConfig :: S3ReportExportConfig
- data SourceAuth = SourceAuth' (Maybe Text) SourceAuthType
- newSourceAuth :: SourceAuthType -> SourceAuth
- data SourceCredentialsInfo = SourceCredentialsInfo' (Maybe Text) (Maybe ServerType) (Maybe AuthType)
- newSourceCredentialsInfo :: SourceCredentialsInfo
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
- data TestCase = TestCase' (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newTestCase :: TestCase
- data TestCaseFilter = TestCaseFilter' (Maybe Text) (Maybe Text)
- newTestCaseFilter :: TestCaseFilter
- data TestReportSummary = TestReportSummary' Int (HashMap Text Int) Integer
- newTestReportSummary :: Int -> Integer -> TestReportSummary
- data VpcConfig = VpcConfig' (Maybe [Text]) (Maybe Text) (Maybe [Text])
- newVpcConfig :: VpcConfig
- data Webhook = Webhook' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [[WebhookFilter]]) (Maybe Text) (Maybe WebhookBuildType)
- newWebhook :: Webhook
- data WebhookFilter = WebhookFilter' (Maybe Bool) WebhookFilterType Text
- newWebhookFilter :: WebhookFilterType -> Text -> WebhookFilter
Service Configuration
defaultService :: Service Source #
API version 2016-10-06 of the Amazon CodeBuild 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 CodeBuild.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource with the same settings already exists.
OAuthProviderException
_OAuthProviderException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There was a problem with the underlying OAuth provider.
AccountLimitExceededException
_AccountLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.
InvalidInputException
_InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input value that was provided is not valid.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified Amazon Web Services resource cannot be found.
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.
ListProjects (Paginated)
data ListProjects Source #
See: newListProjects smart constructor.
Constructors
| ListProjects' (Maybe SortOrderType) (Maybe Text) (Maybe ProjectSortByType) |
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:sortOrder:ListProjects', listProjects_sortOrder - The order in which to list build projects. Valid values include:
ASCENDING: List in ascending order.DESCENDING: List in descending order.
Use sortBy to specify the criterion to be used to list build project
names.
$sel:nextToken:ListProjects', listProjects_nextToken - During a previous call, if there are more than 100 items in the list,
only the first 100 items are returned, along with a unique string called
a nextToken. To get the next batch of items in the list, call this
operation again, adding the next token to the call. To get all of the
items in the list, keep calling this operation with each subsequent next
token that is returned, until no more next tokens are returned.
$sel:sortBy:ListProjects', listProjects_sortBy - The criterion to be used to list build project names. Valid values
include:
CREATED_TIME: List based on when each build project was created.LAST_MODIFIED_TIME: List based on when information about each build project was last changed.NAME: List based on each build project's name.
Use sortOrder to specify in what order to list the build project names
based on the preceding criteria.
data ListProjectsResponse Source #
See: newListProjectsResponse smart constructor.
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:
$sel:nextToken:ListProjects', listProjectsResponse_nextToken - If there are more than 100 items in the list, only the first 100 items
are returned, along with a unique string called a nextToken. To get
the next batch of items in the list, call this operation again, adding
the next token to the call.
$sel:projects:ListProjectsResponse', listProjectsResponse_projects - The list of build project names, with each build project name
representing a single build project.
$sel:httpStatus:ListProjectsResponse', listProjectsResponse_httpStatus - The response's http status code.
DeleteProject
data DeleteProject Source #
See: newDeleteProject smart constructor.
Constructors
| DeleteProject' Text |
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:name:DeleteProject', deleteProject_name - The name of the build project.
data DeleteProjectResponse Source #
See: newDeleteProjectResponse smart constructor.
Constructors
| DeleteProjectResponse' Int |
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:
$sel:httpStatus:DeleteProjectResponse', deleteProjectResponse_httpStatus - The response's http status code.
UpdateProject
data UpdateProject Source #
See: newUpdateProject smart constructor.
Constructors
| UpdateProject' (Maybe [ProjectArtifacts]) (Maybe ProjectArtifacts) (Maybe ProjectEnvironment) (Maybe Int) (Maybe Bool) (Maybe [ProjectSourceVersion]) (Maybe Natural) (Maybe ProjectCache) (Maybe [ProjectSource]) (Maybe Text) (Maybe VpcConfig) (Maybe ProjectSource) (Maybe LogsConfig) (Maybe [ProjectFileSystemLocation]) (Maybe ProjectBuildBatchConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Natural) Text |
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:
$sel:secondaryArtifacts:UpdateProject', updateProject_secondaryArtifacts - An array of ProjectArtifact objects.
$sel:artifacts:UpdateProject', updateProject_artifacts - Information to be changed about the build output artifacts for the build
project.
$sel:environment:UpdateProject', updateProject_environment - Information to be changed about the build environment for the build
project.
$sel:concurrentBuildLimit:UpdateProject', updateProject_concurrentBuildLimit - The maximum number of concurrent builds that are allowed for this
project.
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
To remove this limit, set this value to -1.
$sel:badgeEnabled:UpdateProject', updateProject_badgeEnabled - Set this to true to generate a publicly accessible URL for your
project's build badge.
$sel:secondarySourceVersions:UpdateProject', updateProject_secondarySourceVersions - An array of ProjectSourceVersion objects. If secondarySourceVersions
is specified at the build level, then they take over these
secondarySourceVersions (at the project level).
$sel:queuedTimeoutInMinutes:UpdateProject', updateProject_queuedTimeoutInMinutes - The number of minutes a build is allowed to be queued before it times
out.
$sel:cache:UpdateProject', updateProject_cache - Stores recently used information so that it can be quickly accessed at a
later time.
$sel:secondarySources:UpdateProject', updateProject_secondarySources - An array of ProjectSource objects.
$sel:sourceVersion:UpdateProject', updateProject_sourceVersion - A version of the build input to be built for this project. If not
specified, the latest version is used. If specified, it must be one of:
- For CodeCommit: the commit ID, branch, or Git tag to use.
- For GitHub: the commit ID, pull request ID, branch name, or tag name
that corresponds to the version of the source code you want to
build. If a pull request ID is specified, it must use the format
pr/pull-request-ID(for examplepr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. - For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
- For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version
takes precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
$sel:vpcConfig:UpdateProject', updateProject_vpcConfig - VpcConfig enables CodeBuild to access resources in an Amazon VPC.
$sel:source:UpdateProject', updateProject_source - Information to be changed about the build input source code for the
build project.
$sel:logsConfig:UpdateProject', updateProject_logsConfig - Information about logs for the build project. A project can create logs
in CloudWatch Logs, logs in an S3 bucket, or both.
$sel:fileSystemLocations:UpdateProject', updateProject_fileSystemLocations - An array of ProjectFileSystemLocation objects for a CodeBuild build
project. A ProjectFileSystemLocation object specifies the
identifier, location, mountOptions, mountPoint, and type of a
file system created using Amazon Elastic File System.
$sel:buildBatchConfig:UpdateProject', updateProject_buildBatchConfig - Undocumented member.
$sel:encryptionKey:UpdateProject', updateProject_encryptionKey - The Key Management Service customer master key (CMK) to be used for
encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if
available, the CMK's alias (using the format alias/<alias-name>).
$sel:description:UpdateProject', updateProject_description - A new or replacement description of the build project.
$sel:serviceRole:UpdateProject', updateProject_serviceRole - The replacement ARN of the IAM role that enables CodeBuild to interact
with dependent Amazon Web Services services on behalf of the Amazon Web
Services account.
$sel:tags:UpdateProject', updateProject_tags - An updated list of tag key and value pairs associated with this build
project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
$sel:timeoutInMinutes:UpdateProject', updateProject_timeoutInMinutes - The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild
to wait before timing out any related build that did not get marked as
completed.
$sel:name:UpdateProject', updateProject_name - The name of the build project.
You cannot change a build project's name.
data UpdateProjectResponse Source #
See: newUpdateProjectResponse smart constructor.
Constructors
| UpdateProjectResponse' (Maybe Project) 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:project:UpdateProjectResponse', updateProjectResponse_project - Information about the build project that was changed.
$sel:httpStatus:UpdateProjectResponse', updateProjectResponse_httpStatus - The response's http status code.
DeleteSourceCredentials
data DeleteSourceCredentials Source #
See: newDeleteSourceCredentials smart constructor.
Constructors
| DeleteSourceCredentials' Text |
Instances
newDeleteSourceCredentials Source #
Arguments
| :: Text | |
| -> DeleteSourceCredentials |
Create a value of DeleteSourceCredentials 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:DeleteSourceCredentials', deleteSourceCredentials_arn - The Amazon Resource Name (ARN) of the token.
data DeleteSourceCredentialsResponse Source #
See: newDeleteSourceCredentialsResponse smart constructor.
Constructors
| DeleteSourceCredentialsResponse' (Maybe Text) Int |
Instances
newDeleteSourceCredentialsResponse Source #
Create a value of DeleteSourceCredentialsResponse 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:DeleteSourceCredentials', deleteSourceCredentialsResponse_arn - The Amazon Resource Name (ARN) of the token.
$sel:httpStatus:DeleteSourceCredentialsResponse', deleteSourceCredentialsResponse_httpStatus - The response's http status code.
ListBuilds (Paginated)
data ListBuilds Source #
See: newListBuilds smart constructor.
Constructors
| ListBuilds' (Maybe SortOrderType) (Maybe Text) |
Instances
newListBuilds :: ListBuilds Source #
Create a value of ListBuilds 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:sortOrder:ListBuilds', listBuilds_sortOrder - The order to list build IDs. Valid values include:
ASCENDING: List the build IDs in ascending order by build ID.DESCENDING: List the build IDs in descending order by build ID.
$sel:nextToken:ListBuilds', listBuilds_nextToken - During a previous call, if there are more than 100 items in the list,
only the first 100 items are returned, along with a unique string called
a nextToken. To get the next batch of items in the list, call this
operation again, adding the next token to the call. To get all of the
items in the list, keep calling this operation with each subsequent next
token that is returned, until no more next tokens are returned.
data ListBuildsResponse Source #
See: newListBuildsResponse smart constructor.
Instances
newListBuildsResponse Source #
Arguments
| :: Int | |
| -> ListBuildsResponse |
Create a value of ListBuildsResponse 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:ids:ListBuildsResponse', listBuildsResponse_ids - A list of build IDs, with each build ID representing a single build.
$sel:nextToken:ListBuilds', listBuildsResponse_nextToken - If there are more than 100 items in the list, only the first 100 items
are returned, along with a unique string called a nextToken. To get
the next batch of items in the list, call this operation again, adding
the next token to the call.
$sel:httpStatus:ListBuildsResponse', listBuildsResponse_httpStatus - The response's http status code.
ListSourceCredentials
data ListSourceCredentials Source #
See: newListSourceCredentials smart constructor.
Constructors
| ListSourceCredentials' | |
Instances
newListSourceCredentials :: ListSourceCredentials Source #
Create a value of ListSourceCredentials with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data ListSourceCredentialsResponse Source #
See: newListSourceCredentialsResponse smart constructor.
Constructors
| ListSourceCredentialsResponse' (Maybe [SourceCredentialsInfo]) Int |
Instances
newListSourceCredentialsResponse Source #
Create a value of ListSourceCredentialsResponse 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:sourceCredentialsInfos:ListSourceCredentialsResponse', listSourceCredentialsResponse_sourceCredentialsInfos - A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo
object includes the authentication type, token ARN, and type of source
provider for one set of credentials.
$sel:httpStatus:ListSourceCredentialsResponse', listSourceCredentialsResponse_httpStatus - The response's http status code.
ListReports (Paginated)
data ListReports Source #
See: newListReports smart constructor.
Constructors
| ListReports' (Maybe SortOrderType) (Maybe Text) (Maybe ReportFilter) (Maybe Natural) |
Instances
newListReports :: ListReports Source #
Create a value of ListReports 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:sortOrder:ListReports', listReports_sortOrder - Specifies the sort order for the list of returned reports. Valid values
are:
ASCENDING: return reports in chronological order based on their creation date.DESCENDING: return reports in the reverse chronological order based on their creation date.
$sel:nextToken:ListReports', listReports_nextToken - During a previous call, the maximum number of items that can be returned
is the value specified in maxResults. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
$sel:filter':ListReports', listReports_filter - A ReportFilter object used to filter the returned reports.
$sel:maxResults:ListReports', listReports_maxResults - The maximum number of paginated reports returned per response. Use
nextToken to iterate pages in the list of returned Report objects.
The default value is 100.
data ListReportsResponse Source #
See: newListReportsResponse smart constructor.
Instances
newListReportsResponse Source #
Arguments
| :: Int | |
| -> ListReportsResponse |
Create a value of ListReportsResponse 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:reports:ListReportsResponse', listReportsResponse_reports - The list of returned ARNs for the reports in the current Amazon Web
Services account.
$sel:nextToken:ListReports', listReportsResponse_nextToken - During a previous call, the maximum number of items that can be returned
is the value specified in maxResults. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
$sel:httpStatus:ListReportsResponse', listReportsResponse_httpStatus - The response's http status code.
DeleteReport
data DeleteReport Source #
See: newDeleteReport smart constructor.
Constructors
| DeleteReport' Text |
Instances
Arguments
| :: Text | |
| -> DeleteReport |
Create a value of DeleteReport 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:DeleteReport', deleteReport_arn - The ARN of the report to delete.
data DeleteReportResponse Source #
See: newDeleteReportResponse smart constructor.
Constructors
| DeleteReportResponse' Int |
Instances
newDeleteReportResponse Source #
Arguments
| :: Int | |
| -> DeleteReportResponse |
Create a value of DeleteReportResponse 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:DeleteReportResponse', deleteReportResponse_httpStatus - The response's http status code.
CreateWebhook
data CreateWebhook Source #
See: newCreateWebhook smart constructor.
Constructors
| CreateWebhook' (Maybe Text) (Maybe [[WebhookFilter]]) (Maybe WebhookBuildType) Text |
Instances
Arguments
| :: Text | |
| -> CreateWebhook |
Create a value of CreateWebhook 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:branchFilter:CreateWebhook', createWebhook_branchFilter - A regular expression used to determine which repository branches are
built when a webhook is triggered. If the name of a branch matches the
regular expression, then it is built. If branchFilter is empty, then
all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
$sel:filterGroups:CreateWebhook', createWebhook_filterGroups - An array of arrays of WebhookFilter objects used to determine which
webhooks are triggered. At least one WebhookFilter in the array must
specify EVENT as its type.
For a build to be triggered, at least one filter group in the
filterGroups array must pass. For a filter group to pass, each of its
filters must pass.
$sel:buildType:CreateWebhook', createWebhook_buildType - Specifies the type of build this webhook will trigger.
$sel:projectName:CreateWebhook', createWebhook_projectName - The name of the CodeBuild project.
data CreateWebhookResponse Source #
See: newCreateWebhookResponse smart constructor.
Constructors
| CreateWebhookResponse' (Maybe Webhook) Int |
Instances
newCreateWebhookResponse Source #
Create a value of CreateWebhookResponse 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:webhook:CreateWebhookResponse', createWebhookResponse_webhook - Information about a webhook that connects repository events to a build
project in CodeBuild.
$sel:httpStatus:CreateWebhookResponse', createWebhookResponse_httpStatus - The response's http status code.
StopBuildBatch
data StopBuildBatch Source #
See: newStopBuildBatch smart constructor.
Constructors
| StopBuildBatch' Text |
Instances
Arguments
| :: Text | |
| -> StopBuildBatch |
Create a value of StopBuildBatch 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:StopBuildBatch', stopBuildBatch_id - The identifier of the batch build to stop.
data StopBuildBatchResponse Source #
See: newStopBuildBatchResponse smart constructor.
Constructors
| StopBuildBatchResponse' (Maybe BuildBatch) Int |
Instances
newStopBuildBatchResponse Source #
Create a value of StopBuildBatchResponse 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:buildBatch:StopBuildBatchResponse', stopBuildBatchResponse_buildBatch - Undocumented member.
$sel:httpStatus:StopBuildBatchResponse', stopBuildBatchResponse_httpStatus - The response's http status code.
ListSharedProjects (Paginated)
data ListSharedProjects Source #
See: newListSharedProjects smart constructor.
Constructors
| ListSharedProjects' (Maybe SortOrderType) (Maybe Text) (Maybe Natural) (Maybe SharedResourceSortByType) |
Instances
newListSharedProjects :: ListSharedProjects Source #
Create a value of ListSharedProjects 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:sortOrder:ListSharedProjects', listSharedProjects_sortOrder - The order in which to list shared build projects. Valid values include:
ASCENDING: List in ascending order.DESCENDING: List in descending order.
$sel:nextToken:ListSharedProjects', listSharedProjects_nextToken - During a previous call, the maximum number of items that can be returned
is the value specified in maxResults. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
$sel:maxResults:ListSharedProjects', listSharedProjects_maxResults - The maximum number of paginated shared build projects returned per
response. Use nextToken to iterate pages in the list of returned
Project objects. The default value is 100.
$sel:sortBy:ListSharedProjects', listSharedProjects_sortBy - The criterion to be used to list build projects shared with the current
Amazon Web Services account or user. Valid values include:
ARN: List based on the ARN.MODIFIED_TIME: List based on when information about the shared project was last changed.
data ListSharedProjectsResponse Source #
See: newListSharedProjectsResponse smart constructor.
Instances
newListSharedProjectsResponse Source #
Create a value of ListSharedProjectsResponse 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:nextToken:ListSharedProjects', listSharedProjectsResponse_nextToken - During a previous call, the maximum number of items that can be returned
is the value specified in maxResults. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
$sel:projects:ListSharedProjectsResponse', listSharedProjectsResponse_projects - The list of ARNs for the build projects shared with the current Amazon
Web Services account or user.
$sel:httpStatus:ListSharedProjectsResponse', listSharedProjectsResponse_httpStatus - The response's http status code.
CreateReportGroup
data CreateReportGroup Source #
See: newCreateReportGroup smart constructor.
Constructors
| CreateReportGroup' (Maybe [Tag]) Text ReportType ReportExportConfig |
Instances
Arguments
| :: Text | |
| -> ReportType | |
| -> ReportExportConfig | |
| -> CreateReportGroup |
Create a value of CreateReportGroup 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:tags:CreateReportGroup', createReportGroup_tags - A list of tag key and value pairs associated with this report group.
These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
$sel:name:CreateReportGroup', createReportGroup_name - The name of the report group.
$sel:type':CreateReportGroup', createReportGroup_type - The type of report group.
$sel:exportConfig:CreateReportGroup', createReportGroup_exportConfig - A ReportExportConfig object that contains information about where the
report group test results are exported.
data CreateReportGroupResponse Source #
See: newCreateReportGroupResponse smart constructor.
Constructors
| CreateReportGroupResponse' (Maybe ReportGroup) Int |
Instances
newCreateReportGroupResponse Source #
Create a value of CreateReportGroupResponse 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:reportGroup:CreateReportGroupResponse', createReportGroupResponse_reportGroup - Information about the report group that was created.
$sel:httpStatus:CreateReportGroupResponse', createReportGroupResponse_httpStatus - The response's http status code.
DescribeCodeCoverages (Paginated)
data DescribeCodeCoverages Source #
See: newDescribeCodeCoverages smart constructor.
Constructors
| DescribeCodeCoverages' (Maybe Double) (Maybe SortOrderType) (Maybe Double) (Maybe Text) (Maybe Natural) (Maybe ReportCodeCoverageSortByType) Text |
Instances
newDescribeCodeCoverages Source #
Create a value of DescribeCodeCoverages 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:minLineCoveragePercentage:DescribeCodeCoverages', describeCodeCoverages_minLineCoveragePercentage - The minimum line coverage percentage to report.
$sel:sortOrder:DescribeCodeCoverages', describeCodeCoverages_sortOrder - Specifies if the results are sorted in ascending or descending order.
$sel:maxLineCoveragePercentage:DescribeCodeCoverages', describeCodeCoverages_maxLineCoveragePercentage - The maximum line coverage percentage to report.
$sel:nextToken:DescribeCodeCoverages', describeCodeCoverages_nextToken - The nextToken value returned from a previous call to
DescribeCodeCoverages. This specifies the next item to return. To
return the beginning of the list, exclude this parameter.
$sel:maxResults:DescribeCodeCoverages', describeCodeCoverages_maxResults - The maximum number of results to return.
$sel:sortBy:DescribeCodeCoverages', describeCodeCoverages_sortBy - Specifies how the results are sorted. Possible values are:
- FILE_PATH
- The results are sorted by file path.
- LINE_COVERAGE_PERCENTAGE
- The results are sorted by the percentage of lines that are covered.
$sel:reportArn:DescribeCodeCoverages', describeCodeCoverages_reportArn - The ARN of the report for which test cases are returned.
data DescribeCodeCoveragesResponse Source #
See: newDescribeCodeCoveragesResponse smart constructor.
Constructors
| DescribeCodeCoveragesResponse' (Maybe [CodeCoverage]) (Maybe Text) Int |
Instances
newDescribeCodeCoveragesResponse Source #
Create a value of DescribeCodeCoveragesResponse 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:codeCoverages:DescribeCodeCoveragesResponse', describeCodeCoveragesResponse_codeCoverages - An array of CodeCoverage objects that contain the results.
$sel:nextToken:DescribeCodeCoverages', describeCodeCoveragesResponse_nextToken - If there are more items to return, this contains a token that is passed
to a subsequent call to DescribeCodeCoverages to retrieve the next set
of items.
$sel:httpStatus:DescribeCodeCoveragesResponse', describeCodeCoveragesResponse_httpStatus - The response's http status code.
ImportSourceCredentials
data ImportSourceCredentials Source #
See: newImportSourceCredentials smart constructor.
Constructors
| ImportSourceCredentials' (Maybe Text) (Maybe Bool) (Sensitive Text) ServerType AuthType |
Instances
newImportSourceCredentials Source #
Arguments
| :: Text | |
| -> ServerType | |
| -> AuthType | |
| -> ImportSourceCredentials |
Create a value of ImportSourceCredentials 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:username:ImportSourceCredentials', importSourceCredentials_username - The Bitbucket username when the authType is BASIC_AUTH. This parameter
is not valid for other types of source providers or connections.
$sel:shouldOverwrite:ImportSourceCredentials', importSourceCredentials_shouldOverwrite - Set to false to prevent overwriting the repository source credentials.
Set to true to overwrite the repository source credentials. The
default value is true.
$sel:token:ImportSourceCredentials', importSourceCredentials_token - For GitHub or GitHub Enterprise, this is the personal access token. For
Bitbucket, this is the app password.
$sel:serverType:ImportSourceCredentials', importSourceCredentials_serverType - The source provider used for this project.
$sel:authType:ImportSourceCredentials', importSourceCredentials_authType - The type of authentication used to connect to a GitHub, GitHub
Enterprise, or Bitbucket repository. An OAUTH connection is not
supported by the API and must be created using the CodeBuild console.
data ImportSourceCredentialsResponse Source #
See: newImportSourceCredentialsResponse smart constructor.
Constructors
| ImportSourceCredentialsResponse' (Maybe Text) Int |
Instances
newImportSourceCredentialsResponse Source #
Create a value of ImportSourceCredentialsResponse 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:ImportSourceCredentialsResponse', importSourceCredentialsResponse_arn - The Amazon Resource Name (ARN) of the token.
$sel:httpStatus:ImportSourceCredentialsResponse', importSourceCredentialsResponse_httpStatus - The response's http status code.
ListBuildBatchesForProject (Paginated)
data ListBuildBatchesForProject Source #
See: newListBuildBatchesForProject smart constructor.
Constructors
| ListBuildBatchesForProject' (Maybe SortOrderType) (Maybe Text) (Maybe Text) (Maybe BuildBatchFilter) (Maybe Natural) |
Instances
newListBuildBatchesForProject :: ListBuildBatchesForProject Source #
Create a value of ListBuildBatchesForProject 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:sortOrder:ListBuildBatchesForProject', listBuildBatchesForProject_sortOrder - Specifies the sort order of the returned items. Valid values include:
ASCENDING: List the batch build identifiers in ascending order by identifier.DESCENDING: List the batch build identifiers in descending order by identifier.
$sel:nextToken:ListBuildBatchesForProject', listBuildBatchesForProject_nextToken - The nextToken value returned from a previous call to
ListBuildBatchesForProject. This specifies the next item to return. To
return the beginning of the list, exclude this parameter.
$sel:projectName:ListBuildBatchesForProject', listBuildBatchesForProject_projectName - The name of the project.
$sel:filter':ListBuildBatchesForProject', listBuildBatchesForProject_filter - A BuildBatchFilter object that specifies the filters for the search.
$sel:maxResults:ListBuildBatchesForProject', listBuildBatchesForProject_maxResults - The maximum number of results to return.
data ListBuildBatchesForProjectResponse Source #
See: newListBuildBatchesForProjectResponse smart constructor.
Instances
newListBuildBatchesForProjectResponse Source #
Arguments
| :: Int | |
| -> ListBuildBatchesForProjectResponse |
Create a value of ListBuildBatchesForProjectResponse 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:ids:ListBuildBatchesForProjectResponse', listBuildBatchesForProjectResponse_ids - An array of strings that contains the batch build identifiers.
$sel:nextToken:ListBuildBatchesForProject', listBuildBatchesForProjectResponse_nextToken - If there are more items to return, this contains a token that is passed
to a subsequent call to ListBuildBatchesForProject to retrieve the
next set of items.
$sel:httpStatus:ListBuildBatchesForProjectResponse', listBuildBatchesForProjectResponse_httpStatus - The response's http status code.
BatchGetReportGroups
data BatchGetReportGroups Source #
See: newBatchGetReportGroups smart constructor.
Constructors
| BatchGetReportGroups' (NonEmpty Text) |
Instances
newBatchGetReportGroups Source #
Create a value of BatchGetReportGroups 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:reportGroupArns:BatchGetReportGroups', batchGetReportGroups_reportGroupArns - An array of report group ARNs that identify the report groups to return.
data BatchGetReportGroupsResponse Source #
See: newBatchGetReportGroupsResponse smart constructor.
Constructors
| BatchGetReportGroupsResponse' (Maybe (NonEmpty ReportGroup)) (Maybe (NonEmpty Text)) Int |
Instances
newBatchGetReportGroupsResponse Source #
Create a value of BatchGetReportGroupsResponse 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:reportGroups:BatchGetReportGroupsResponse', batchGetReportGroupsResponse_reportGroups - The array of report groups returned by BatchGetReportGroups.
$sel:reportGroupsNotFound:BatchGetReportGroupsResponse', batchGetReportGroupsResponse_reportGroupsNotFound - An array of ARNs passed to BatchGetReportGroups that are not
associated with a ReportGroup.
$sel:httpStatus:BatchGetReportGroupsResponse', batchGetReportGroupsResponse_httpStatus - The response's http status code.
DeleteBuildBatch
data DeleteBuildBatch Source #
See: newDeleteBuildBatch smart constructor.
Constructors
| DeleteBuildBatch' Text |
Instances
Arguments
| :: Text | |
| -> DeleteBuildBatch |
Create a value of DeleteBuildBatch 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:DeleteBuildBatch', deleteBuildBatch_id - The identifier of the batch build to delete.
data DeleteBuildBatchResponse Source #
See: newDeleteBuildBatchResponse smart constructor.
Constructors
| DeleteBuildBatchResponse' (Maybe [BuildNotDeleted]) (Maybe (NonEmpty Text)) (Maybe Text) Int |
Instances
newDeleteBuildBatchResponse Source #
Create a value of DeleteBuildBatchResponse 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:buildsNotDeleted:DeleteBuildBatchResponse', deleteBuildBatchResponse_buildsNotDeleted - An array of BuildNotDeleted objects that specify the builds that could
not be deleted.
$sel:buildsDeleted:DeleteBuildBatchResponse', deleteBuildBatchResponse_buildsDeleted - An array of strings that contain the identifiers of the builds that were
deleted.
$sel:statusCode:DeleteBuildBatchResponse', deleteBuildBatchResponse_statusCode - The status code.
$sel:httpStatus:DeleteBuildBatchResponse', deleteBuildBatchResponse_httpStatus - The response's http status code.
StartBuild
data StartBuild Source #
See: newStartBuild smart constructor.
Constructors
| StartBuild' (Maybe Text) (Maybe Text) (Maybe [EnvironmentVariable]) (Maybe BuildStatusConfig) (Maybe Text) (Maybe Bool) (Maybe RegistryCredential) (Maybe Natural) (Maybe Text) (Maybe ProjectCache) (Maybe Natural) (Maybe [ProjectSource]) (Maybe Natural) (Maybe ImagePullCredentialsType) (Maybe LogsConfig) (Maybe SourceAuth) (Maybe GitSubmodulesConfig) (Maybe EnvironmentType) (Maybe Text) (Maybe ComputeType) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [ProjectSourceVersion]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [ProjectArtifacts]) (Maybe ProjectArtifacts) (Maybe SourceType) Text |
Instances
Arguments
| :: Text | |
| -> StartBuild |
Create a value of StartBuild 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:encryptionKeyOverride:StartBuild', startBuild_encryptionKeyOverride - The Key Management Service customer master key (CMK) that overrides the
one specified in the build project. The CMK key encrypts the build
output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if
available, the CMK's alias (using the format alias/<alias-name>).
$sel:sourceLocationOverride:StartBuild', startBuild_sourceLocationOverride - A location that overrides, for this build, the source location for the
one defined in the build project.
$sel:environmentVariablesOverride:StartBuild', startBuild_environmentVariablesOverride - A set of environment variables that overrides, for this build only, the
latest ones already defined in the build project.
$sel:buildStatusConfigOverride:StartBuild', startBuild_buildStatusConfigOverride - Contains information that defines how the build project reports the
build status to the source provider. This option is only used when the
source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
$sel:idempotencyToken:StartBuild', startBuild_idempotencyToken - A unique, case sensitive identifier you provide to ensure the
idempotency of the StartBuild request. The token is included in the
StartBuild request and is valid for 5 minutes. If you repeat the
StartBuild request with the same token, but change a parameter,
CodeBuild returns a parameter mismatch error.
$sel:debugSessionEnabled:StartBuild', startBuild_debugSessionEnabled - Specifies if session debugging is enabled for this build. For more
information, see
Viewing a running build in Session Manager.
$sel:registryCredentialOverride:StartBuild', startBuild_registryCredentialOverride - The credentials for access to a private registry.
$sel:timeoutInMinutesOverride:StartBuild', startBuild_timeoutInMinutesOverride - The number of build timeout minutes, from 5 to 480 (8 hours), that
overrides, for this build only, the latest setting already defined in
the build project.
$sel:serviceRoleOverride:StartBuild', startBuild_serviceRoleOverride - The name of a service role for this build that overrides the one
specified in the build project.
$sel:cacheOverride:StartBuild', startBuild_cacheOverride - A ProjectCache object specified for this build that overrides the one
defined in the build project.
$sel:queuedTimeoutInMinutesOverride:StartBuild', startBuild_queuedTimeoutInMinutesOverride - The number of minutes a build is allowed to be queued before it times
out.
$sel:secondarySourcesOverride:StartBuild', startBuild_secondarySourcesOverride - An array of ProjectSource objects.
$sel:gitCloneDepthOverride:StartBuild', startBuild_gitCloneDepthOverride - The user-defined depth of history, with a minimum value of 0, that
overrides, for this build only, any previous depth of history defined in
the build project.
$sel:imagePullCredentialsTypeOverride:StartBuild', startBuild_imagePullCredentialsTypeOverride - The type of credentials CodeBuild uses to pull images in your build.
There are two valid values:
- CODEBUILD
- Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
- SERVICE_ROLE
- Specifies that CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use
SERVICE_ROLE credentials. When using an CodeBuild curated image, you
must use CODEBUILD credentials.
$sel:logsConfigOverride:StartBuild', startBuild_logsConfigOverride - Log settings for this build that override the log settings defined in
the build project.
$sel:sourceAuthOverride:StartBuild', startBuild_sourceAuthOverride - An authorization type for this build that overrides the one defined in
the build project. This override applies only if the build project's
source is BitBucket or GitHub.
$sel:gitSubmodulesConfigOverride:StartBuild', startBuild_gitSubmodulesConfigOverride - Information about the Git submodules configuration for this build of an
CodeBuild build project.
$sel:environmentTypeOverride:StartBuild', startBuild_environmentTypeOverride - A container type for this build that overrides the one specified in the
build project.
$sel:certificateOverride:StartBuild', startBuild_certificateOverride - The name of a certificate for this build that overrides the one
specified in the build project.
$sel:computeTypeOverride:StartBuild', startBuild_computeTypeOverride - The name of a compute type for this build that overrides the one
specified in the build project.
$sel:privilegedModeOverride:StartBuild', startBuild_privilegedModeOverride - Enable this flag to override privileged mode in the build project.
$sel:sourceVersion:StartBuild', startBuild_sourceVersion - The version of the build input to be built, for this build only. If not
specified, the latest version is used. If specified, the contents
depends on the source provider:
- CodeCommit
- The commit ID, branch, or Git tag to use.
- GitHub
- The commit ID, pull request ID, branch name, or tag name that
corresponds to the version of the source code you want to build. If
a pull request ID is specified, it must use the format
pr/pull-request-ID(for examplepr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. - Bitbucket
- The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
- Amazon S3
- The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the project level, then this
sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
$sel:buildspecOverride:StartBuild', startBuild_buildspecOverride - A buildspec file declaration that overrides, for this build only, the
latest one already defined in the build project.
If this value is set, it can be either an inline buildspec definition,
the path to an alternate buildspec file relative to the value of the
built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3
bucket. The bucket must be in the same Amazon Web Services Region as the
build project. Specify the buildspec file using its ARN (for example,
arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is
not provided or is set to an empty string, the source code must contain
a buildspec file in its root directory. For more information, see
Buildspec File Name and Storage Location.
$sel:secondarySourcesVersionOverride:StartBuild', startBuild_secondarySourcesVersionOverride - An array of ProjectSourceVersion objects that specify one or more
versions of the project's secondary sources to be used for this build
only.
$sel:reportBuildStatusOverride:StartBuild', startBuild_reportBuildStatusOverride - Set to true to report to your source provider the status of a build's
start and completion. If you use this option with a source provider
other than GitHub, GitHub Enterprise, or Bitbucket, an
invalidInputException is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
$sel:insecureSslOverride:StartBuild', startBuild_insecureSslOverride - Enable this flag to override the insecure SSL setting that is specified
in the build project. The insecure SSL setting determines whether to
ignore SSL warnings while connecting to the project source code. This
override applies only if the build's source is GitHub Enterprise.
$sel:imageOverride:StartBuild', startBuild_imageOverride - The name of an image for this build that overrides the one specified in
the build project.
$sel:secondaryArtifactsOverride:StartBuild', startBuild_secondaryArtifactsOverride - An array of ProjectArtifacts objects.
$sel:artifactsOverride:StartBuild', startBuild_artifactsOverride - Build output artifact settings that override, for this build only, the
latest ones already defined in the build project.
$sel:sourceTypeOverride:StartBuild', startBuild_sourceTypeOverride - A source input type, for this build, that overrides the source input
defined in the build project.
$sel:projectName:StartBuild', startBuild_projectName - The name of the CodeBuild build project to start running a build.
data StartBuildResponse Source #
See: newStartBuildResponse smart constructor.
Constructors
| StartBuildResponse' (Maybe Build) Int |
Instances
newStartBuildResponse Source #
Arguments
| :: Int | |
| -> StartBuildResponse |
Create a value of StartBuildResponse 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:build:StartBuildResponse', startBuildResponse_build - Information about the build to be run.
$sel:httpStatus:StartBuildResponse', startBuildResponse_httpStatus - The response's http status code.
BatchGetBuildBatches
data BatchGetBuildBatches Source #
See: newBatchGetBuildBatches smart constructor.
Constructors
| BatchGetBuildBatches' [Text] |
Instances
newBatchGetBuildBatches :: BatchGetBuildBatches Source #
Create a value of BatchGetBuildBatches 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:ids:BatchGetBuildBatches', batchGetBuildBatches_ids - An array that contains the batch build identifiers to retrieve.
data BatchGetBuildBatchesResponse Source #
See: newBatchGetBuildBatchesResponse smart constructor.
Constructors
| BatchGetBuildBatchesResponse' (Maybe [BuildBatch]) (Maybe [Text]) Int |
Instances
newBatchGetBuildBatchesResponse Source #
Create a value of BatchGetBuildBatchesResponse 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:buildBatches:BatchGetBuildBatchesResponse', batchGetBuildBatchesResponse_buildBatches - An array of BuildBatch objects that represent the retrieved batch
builds.
$sel:buildBatchesNotFound:BatchGetBuildBatchesResponse', batchGetBuildBatchesResponse_buildBatchesNotFound - An array that contains the identifiers of any batch builds that are not
found.
$sel:httpStatus:BatchGetBuildBatchesResponse', batchGetBuildBatchesResponse_httpStatus - The response's http status code.
RetryBuild
data RetryBuild Source #
See: newRetryBuild smart constructor.
Constructors
| RetryBuild' (Maybe Text) (Maybe Text) |
Instances
newRetryBuild :: RetryBuild Source #
Create a value of RetryBuild 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:idempotencyToken:RetryBuild', retryBuild_idempotencyToken - A unique, case sensitive identifier you provide to ensure the
idempotency of the RetryBuild request. The token is included in the
RetryBuild request and is valid for five minutes. If you repeat the
RetryBuild request with the same token, but change a parameter,
CodeBuild returns a parameter mismatch error.
$sel:id:RetryBuild', retryBuild_id - Specifies the identifier of the build to restart.
data RetryBuildResponse Source #
See: newRetryBuildResponse smart constructor.
Constructors
| RetryBuildResponse' (Maybe Build) Int |
Instances
newRetryBuildResponse Source #
Arguments
| :: Int | |
| -> RetryBuildResponse |
Create a value of RetryBuildResponse 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:build:RetryBuildResponse', retryBuildResponse_build - Undocumented member.
$sel:httpStatus:RetryBuildResponse', retryBuildResponse_httpStatus - The response's http status code.
ListBuildsForProject (Paginated)
data ListBuildsForProject Source #
See: newListBuildsForProject smart constructor.
Constructors
| ListBuildsForProject' (Maybe SortOrderType) (Maybe Text) Text |
Instances
newListBuildsForProject Source #
Create a value of ListBuildsForProject 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:sortOrder:ListBuildsForProject', listBuildsForProject_sortOrder - The order to sort the results in. The results are sorted by build
number, not the build identifier. If this is not specified, the results
are sorted in descending order.
Valid values include:
ASCENDING: List the build identifiers in ascending order, by build number.DESCENDING: List the build identifiers in descending order, by build number.
If the project has more than 100 builds, setting the sort order will result in an error.
$sel:nextToken:ListBuildsForProject', listBuildsForProject_nextToken - During a previous call, if there are more than 100 items in the list,
only the first 100 items are returned, along with a unique string called
a nextToken. To get the next batch of items in the list, call this
operation again, adding the next token to the call. To get all of the
items in the list, keep calling this operation with each subsequent next
token that is returned, until no more next tokens are returned.
$sel:projectName:ListBuildsForProject', listBuildsForProject_projectName - The name of the CodeBuild project.
data ListBuildsForProjectResponse Source #
See: newListBuildsForProjectResponse smart constructor.
Instances
newListBuildsForProjectResponse Source #
Create a value of ListBuildsForProjectResponse 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:ids:ListBuildsForProjectResponse', listBuildsForProjectResponse_ids - A list of build identifiers for the specified build project, with each
build ID representing a single build.
$sel:nextToken:ListBuildsForProject', listBuildsForProjectResponse_nextToken - If there are more than 100 items in the list, only the first 100 items
are returned, along with a unique string called a nextToken. To get
the next batch of items in the list, call this operation again, adding
the next token to the call.
$sel:httpStatus:ListBuildsForProjectResponse', listBuildsForProjectResponse_httpStatus - The response's http status code.
DescribeTestCases (Paginated)
data DescribeTestCases Source #
See: newDescribeTestCases smart constructor.
Constructors
| DescribeTestCases' (Maybe Text) (Maybe TestCaseFilter) (Maybe Natural) Text |
Instances
Arguments
| :: Text | |
| -> DescribeTestCases |
Create a value of DescribeTestCases 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:nextToken:DescribeTestCases', describeTestCases_nextToken - During a previous call, the maximum number of items that can be returned
is the value specified in maxResults. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
$sel:filter':DescribeTestCases', describeTestCases_filter - A TestCaseFilter object used to filter the returned reports.
$sel:maxResults:DescribeTestCases', describeTestCases_maxResults - The maximum number of paginated test cases returned per response. Use
nextToken to iterate pages in the list of returned TestCase objects.
The default value is 100.
$sel:reportArn:DescribeTestCases', describeTestCases_reportArn - The ARN of the report for which test cases are returned.
data DescribeTestCasesResponse Source #
See: newDescribeTestCasesResponse smart constructor.
Instances
newDescribeTestCasesResponse Source #
Create a value of DescribeTestCasesResponse 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:nextToken:DescribeTestCases', describeTestCasesResponse_nextToken - During a previous call, the maximum number of items that can be returned
is the value specified in maxResults. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
$sel:testCases:DescribeTestCasesResponse', describeTestCasesResponse_testCases - The returned list of test cases.
$sel:httpStatus:DescribeTestCasesResponse', describeTestCasesResponse_httpStatus - The response's http status code.
GetResourcePolicy
data GetResourcePolicy Source #
See: newGetResourcePolicy smart constructor.
Constructors
| GetResourcePolicy' Text |
Instances
Arguments
| :: Text | |
| -> GetResourcePolicy |
Create a value of GetResourcePolicy 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:resourceArn:GetResourcePolicy', getResourcePolicy_resourceArn - The ARN of the resource that is associated with the resource policy.
data GetResourcePolicyResponse Source #
See: newGetResourcePolicyResponse smart constructor.
Constructors
| GetResourcePolicyResponse' (Maybe Text) Int |
Instances
newGetResourcePolicyResponse Source #
Create a value of GetResourcePolicyResponse 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:policy:GetResourcePolicyResponse', getResourcePolicyResponse_policy - The resource policy for the resource identified by the input ARN
parameter.
$sel:httpStatus:GetResourcePolicyResponse', getResourcePolicyResponse_httpStatus - The response's http status code.
BatchGetProjects
data BatchGetProjects Source #
See: newBatchGetProjects smart constructor.
Constructors
| BatchGetProjects' (NonEmpty Text) |
Instances
Arguments
| :: NonEmpty Text | |
| -> BatchGetProjects |
Create a value of BatchGetProjects 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:names:BatchGetProjects', batchGetProjects_names - The names or ARNs of the build projects. To get information about a
project shared with your Amazon Web Services account, its ARN must be
specified. You cannot specify a shared project using its name.
data BatchGetProjectsResponse Source #
See: newBatchGetProjectsResponse smart constructor.
Instances
newBatchGetProjectsResponse Source #
Create a value of BatchGetProjectsResponse 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:projectsNotFound:BatchGetProjectsResponse', batchGetProjectsResponse_projectsNotFound - The names of build projects for which information could not be found.
$sel:projects:BatchGetProjectsResponse', batchGetProjectsResponse_projects - Information about the requested build projects.
$sel:httpStatus:BatchGetProjectsResponse', batchGetProjectsResponse_httpStatus - The response's http status code.
BatchGetBuilds
data BatchGetBuilds Source #
See: newBatchGetBuilds smart constructor.
Constructors
| BatchGetBuilds' (NonEmpty Text) |
Instances
Arguments
| :: NonEmpty Text | |
| -> BatchGetBuilds |
Create a value of BatchGetBuilds 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:ids:BatchGetBuilds', batchGetBuilds_ids - The IDs of the builds.
data BatchGetBuildsResponse Source #
See: newBatchGetBuildsResponse smart constructor.
Instances
newBatchGetBuildsResponse Source #
Create a value of BatchGetBuildsResponse 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:builds:BatchGetBuildsResponse', batchGetBuildsResponse_builds - Information about the requested builds.
$sel:buildsNotFound:BatchGetBuildsResponse', batchGetBuildsResponse_buildsNotFound - The IDs of builds for which information could not be found.
$sel:httpStatus:BatchGetBuildsResponse', batchGetBuildsResponse_httpStatus - The response's http status code.
BatchGetReports
data BatchGetReports Source #
See: newBatchGetReports smart constructor.
Constructors
| BatchGetReports' (NonEmpty Text) |
Instances
Arguments
| :: NonEmpty Text | |
| -> BatchGetReports |
Create a value of BatchGetReports 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:reportArns:BatchGetReports', batchGetReports_reportArns - An array of ARNs that identify the Report objects to return.
data BatchGetReportsResponse Source #
See: newBatchGetReportsResponse smart constructor.
Instances
newBatchGetReportsResponse Source #
Create a value of BatchGetReportsResponse 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:reports:BatchGetReportsResponse', batchGetReportsResponse_reports - The array of Report objects returned by BatchGetReports.
$sel:reportsNotFound:BatchGetReportsResponse', batchGetReportsResponse_reportsNotFound - An array of ARNs passed to BatchGetReportGroups that are not
associated with a Report.
$sel:httpStatus:BatchGetReportsResponse', batchGetReportsResponse_httpStatus - The response's http status code.
UpdateWebhook
data UpdateWebhook Source #
See: newUpdateWebhook smart constructor.
Constructors
| UpdateWebhook' (Maybe Text) (Maybe Bool) (Maybe [[WebhookFilter]]) (Maybe WebhookBuildType) Text |
Instances
Arguments
| :: Text | |
| -> UpdateWebhook |
Create a value of UpdateWebhook 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:branchFilter:UpdateWebhook', updateWebhook_branchFilter - A regular expression used to determine which repository branches are
built when a webhook is triggered. If the name of a branch matches the
regular expression, then it is built. If branchFilter is empty, then
all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
$sel:rotateSecret:UpdateWebhook', updateWebhook_rotateSecret - A boolean value that specifies whether the associated GitHub
repository's secret token should be updated. If you use Bitbucket for
your repository, rotateSecret is ignored.
$sel:filterGroups:UpdateWebhook', updateWebhook_filterGroups - An array of arrays of WebhookFilter objects used to determine if a
webhook event can trigger a build. A filter group must contain at least
one EVENT WebhookFilter.
$sel:buildType:UpdateWebhook', updateWebhook_buildType - Specifies the type of build this webhook will trigger.
$sel:projectName:UpdateWebhook', updateWebhook_projectName - The name of the CodeBuild project.
data UpdateWebhookResponse Source #
See: newUpdateWebhookResponse smart constructor.
Constructors
| UpdateWebhookResponse' (Maybe Webhook) Int |
Instances
newUpdateWebhookResponse Source #
Create a value of UpdateWebhookResponse 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:webhook:UpdateWebhookResponse', updateWebhookResponse_webhook - Information about a repository's webhook that is associated with a
project in CodeBuild.
$sel:httpStatus:UpdateWebhookResponse', updateWebhookResponse_httpStatus - The response's http status code.
DeleteWebhook
data DeleteWebhook Source #
See: newDeleteWebhook smart constructor.
Constructors
| DeleteWebhook' Text |
Instances
Arguments
| :: Text | |
| -> DeleteWebhook |
Create a value of DeleteWebhook 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:projectName:DeleteWebhook', deleteWebhook_projectName - The name of the CodeBuild project.
data DeleteWebhookResponse Source #
See: newDeleteWebhookResponse smart constructor.
Constructors
| DeleteWebhookResponse' Int |
Instances
newDeleteWebhookResponse Source #
Create a value of DeleteWebhookResponse 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:DeleteWebhookResponse', deleteWebhookResponse_httpStatus - The response's http status code.
StartBuildBatch
data StartBuildBatch Source #
See: newStartBuildBatch smart constructor.
Constructors
| StartBuildBatch' (Maybe Text) (Maybe Text) (Maybe ProjectBuildBatchConfig) (Maybe [EnvironmentVariable]) (Maybe Text) (Maybe Bool) (Maybe RegistryCredential) (Maybe Text) (Maybe ProjectCache) (Maybe Natural) (Maybe [ProjectSource]) (Maybe Natural) (Maybe ImagePullCredentialsType) (Maybe LogsConfig) (Maybe SourceAuth) (Maybe GitSubmodulesConfig) (Maybe EnvironmentType) (Maybe Text) (Maybe ComputeType) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [ProjectSourceVersion]) (Maybe Bool) (Maybe Text) (Maybe [ProjectArtifacts]) (Maybe Natural) (Maybe ProjectArtifacts) (Maybe SourceType) Text |
Instances
Arguments
| :: Text | |
| -> StartBuildBatch |
Create a value of StartBuildBatch 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:encryptionKeyOverride:StartBuildBatch', startBuildBatch_encryptionKeyOverride - The Key Management Service customer master key (CMK) that overrides the
one specified in the batch build project. The CMK key encrypts the build
output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if
available, the CMK's alias (using the format alias/<alias-name>).
$sel:sourceLocationOverride:StartBuildBatch', startBuildBatch_sourceLocationOverride - A location that overrides, for this batch build, the source location
defined in the batch build project.
$sel:buildBatchConfigOverride:StartBuildBatch', startBuildBatch_buildBatchConfigOverride - A BuildBatchConfigOverride object that contains batch build
configuration overrides.
$sel:environmentVariablesOverride:StartBuildBatch', startBuildBatch_environmentVariablesOverride - An array of EnvironmentVariable objects that override, or add to, the
environment variables defined in the batch build project.
$sel:idempotencyToken:StartBuildBatch', startBuildBatch_idempotencyToken - A unique, case sensitive identifier you provide to ensure the
idempotency of the StartBuildBatch request. The token is included in
the StartBuildBatch request and is valid for five minutes. If you
repeat the StartBuildBatch request with the same token, but change a
parameter, CodeBuild returns a parameter mismatch error.
$sel:debugSessionEnabled:StartBuildBatch', startBuildBatch_debugSessionEnabled - Specifies if session debugging is enabled for this batch build. For more
information, see
Viewing a running build in Session Manager.
Batch session debugging is not supported for matrix batch builds.
$sel:registryCredentialOverride:StartBuildBatch', startBuildBatch_registryCredentialOverride - A RegistryCredential object that overrides credentials for access to a
private registry.
$sel:serviceRoleOverride:StartBuildBatch', startBuildBatch_serviceRoleOverride - The name of a service role for this batch build that overrides the one
specified in the batch build project.
$sel:cacheOverride:StartBuildBatch', startBuildBatch_cacheOverride - A ProjectCache object that specifies cache overrides.
$sel:queuedTimeoutInMinutesOverride:StartBuildBatch', startBuildBatch_queuedTimeoutInMinutesOverride - The number of minutes a batch build is allowed to be queued before it
times out.
$sel:secondarySourcesOverride:StartBuildBatch', startBuildBatch_secondarySourcesOverride - An array of ProjectSource objects that override the secondary sources
defined in the batch build project.
$sel:gitCloneDepthOverride:StartBuildBatch', startBuildBatch_gitCloneDepthOverride - The user-defined depth of history, with a minimum value of 0, that
overrides, for this batch build only, any previous depth of history
defined in the batch build project.
$sel:imagePullCredentialsTypeOverride:StartBuildBatch', startBuildBatch_imagePullCredentialsTypeOverride - The type of credentials CodeBuild uses to pull images in your batch
build. There are two valid values:
- CODEBUILD
- Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
- SERVICE_ROLE
- Specifies that CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use
SERVICE_ROLE credentials. When using an CodeBuild curated image, you
must use CODEBUILD credentials.
$sel:logsConfigOverride:StartBuildBatch', startBuildBatch_logsConfigOverride - A LogsConfig object that override the log settings defined in the
batch build project.
$sel:sourceAuthOverride:StartBuildBatch', startBuildBatch_sourceAuthOverride - A SourceAuth object that overrides the one defined in the batch build
project. This override applies only if the build project's source is
BitBucket or GitHub.
$sel:gitSubmodulesConfigOverride:StartBuildBatch', startBuildBatch_gitSubmodulesConfigOverride - A GitSubmodulesConfig object that overrides the Git submodules
configuration for this batch build.
$sel:environmentTypeOverride:StartBuildBatch', startBuildBatch_environmentTypeOverride - A container type for this batch build that overrides the one specified
in the batch build project.
$sel:certificateOverride:StartBuildBatch', startBuildBatch_certificateOverride - The name of a certificate for this batch build that overrides the one
specified in the batch build project.
$sel:computeTypeOverride:StartBuildBatch', startBuildBatch_computeTypeOverride - The name of a compute type for this batch build that overrides the one
specified in the batch build project.
$sel:reportBuildBatchStatusOverride:StartBuildBatch', startBuildBatch_reportBuildBatchStatusOverride - Set to true to report to your source provider the status of a batch
build's start and completion. If you use this option with a source
provider other than GitHub, GitHub Enterprise, or Bitbucket, an
invalidInputException is thrown.
The status of a build triggered by a webhook is always reported to your source provider.
$sel:privilegedModeOverride:StartBuildBatch', startBuildBatch_privilegedModeOverride - Enable this flag to override privileged mode in the batch build project.
$sel:sourceVersion:StartBuildBatch', startBuildBatch_sourceVersion - The version of the batch build input to be built, for this build only.
If not specified, the latest version is used. If specified, the contents
depends on the source provider:
- CodeCommit
- The commit ID, branch, or Git tag to use.
- GitHub
- The commit ID, pull request ID, branch name, or tag name that
corresponds to the version of the source code you want to build. If
a pull request ID is specified, it must use the format
pr/pull-request-ID(for examplepr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. - Bitbucket
- The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
- Amazon S3
- The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the project level, then this
sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
$sel:buildspecOverride:StartBuildBatch', startBuildBatch_buildspecOverride - A buildspec file declaration that overrides, for this build only, the
latest one already defined in the build project.
If this value is set, it can be either an inline buildspec definition,
the path to an alternate buildspec file relative to the value of the
built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3
bucket. The bucket must be in the same Amazon Web Services Region as the
build project. Specify the buildspec file using its ARN (for example,
arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is
not provided or is set to an empty string, the source code must contain
a buildspec file in its root directory. For more information, see
Buildspec File Name and Storage Location.
$sel:secondarySourcesVersionOverride:StartBuildBatch', startBuildBatch_secondarySourcesVersionOverride - An array of ProjectSourceVersion objects that override the secondary
source versions in the batch build project.
$sel:insecureSslOverride:StartBuildBatch', startBuildBatch_insecureSslOverride - Enable this flag to override the insecure SSL setting that is specified
in the batch build project. The insecure SSL setting determines whether
to ignore SSL warnings while connecting to the project source code. This
override applies only if the build's source is GitHub Enterprise.
$sel:imageOverride:StartBuildBatch', startBuildBatch_imageOverride - The name of an image for this batch build that overrides the one
specified in the batch build project.
$sel:secondaryArtifactsOverride:StartBuildBatch', startBuildBatch_secondaryArtifactsOverride - An array of ProjectArtifacts objects that override the secondary
artifacts defined in the batch build project.
$sel:buildTimeoutInMinutesOverride:StartBuildBatch', startBuildBatch_buildTimeoutInMinutesOverride - Overrides the build timeout specified in the batch build project.
$sel:artifactsOverride:StartBuildBatch', startBuildBatch_artifactsOverride - An array of ProjectArtifacts objects that contains information about
the build output artifact overrides for the build project.
$sel:sourceTypeOverride:StartBuildBatch', startBuildBatch_sourceTypeOverride - The source input type that overrides the source input defined in the
batch build project.
$sel:projectName:StartBuildBatch', startBuildBatch_projectName - The name of the project.
data StartBuildBatchResponse Source #
See: newStartBuildBatchResponse smart constructor.
Constructors
| StartBuildBatchResponse' (Maybe BuildBatch) Int |
Instances
newStartBuildBatchResponse Source #
Create a value of StartBuildBatchResponse 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:buildBatch:StartBuildBatchResponse', startBuildBatchResponse_buildBatch - A BuildBatch object that contains information about the batch build.
$sel:httpStatus:StartBuildBatchResponse', startBuildBatchResponse_httpStatus - The response's http status code.
RetryBuildBatch
data RetryBuildBatch Source #
See: newRetryBuildBatch smart constructor.
Constructors
| RetryBuildBatch' (Maybe Text) (Maybe Text) (Maybe RetryBuildBatchType) |
Instances
newRetryBuildBatch :: RetryBuildBatch Source #
Create a value of RetryBuildBatch 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:idempotencyToken:RetryBuildBatch', retryBuildBatch_idempotencyToken - A unique, case sensitive identifier you provide to ensure the
idempotency of the RetryBuildBatch request. The token is included in
the RetryBuildBatch request and is valid for five minutes. If you
repeat the RetryBuildBatch request with the same token, but change a
parameter, CodeBuild returns a parameter mismatch error.
$sel:id:RetryBuildBatch', retryBuildBatch_id - Specifies the identifier of the batch build to restart.
$sel:retryType:RetryBuildBatch', retryBuildBatch_retryType - Specifies the type of retry to perform.
data RetryBuildBatchResponse Source #
See: newRetryBuildBatchResponse smart constructor.
Constructors
| RetryBuildBatchResponse' (Maybe BuildBatch) Int |
Instances
newRetryBuildBatchResponse Source #
Create a value of RetryBuildBatchResponse 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:buildBatch:RetryBuildBatchResponse', retryBuildBatchResponse_buildBatch - Undocumented member.
$sel:httpStatus:RetryBuildBatchResponse', retryBuildBatchResponse_httpStatus - The response's http status code.
UpdateProjectVisibility
data UpdateProjectVisibility Source #
See: newUpdateProjectVisibility smart constructor.
Constructors
| UpdateProjectVisibility' (Maybe Text) Text ProjectVisibilityType |
Instances
newUpdateProjectVisibility Source #
Arguments
| :: Text | |
| -> ProjectVisibilityType | |
| -> UpdateProjectVisibility |
Create a value of UpdateProjectVisibility 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:resourceAccessRole:UpdateProjectVisibility', updateProjectVisibility_resourceAccessRole - The ARN of the IAM role that enables CodeBuild to access the CloudWatch
Logs and Amazon S3 artifacts for the project's builds.
$sel:projectArn:UpdateProjectVisibility', updateProjectVisibility_projectArn - The Amazon Resource Name (ARN) of the build project.
$sel:projectVisibility:UpdateProjectVisibility', updateProjectVisibility_projectVisibility - Undocumented member.
data UpdateProjectVisibilityResponse Source #
See: newUpdateProjectVisibilityResponse smart constructor.
Constructors
| UpdateProjectVisibilityResponse' (Maybe Text) (Maybe Text) (Maybe ProjectVisibilityType) Int |
Instances
newUpdateProjectVisibilityResponse Source #
Create a value of UpdateProjectVisibilityResponse 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:publicProjectAlias:UpdateProjectVisibilityResponse', updateProjectVisibilityResponse_publicProjectAlias - Contains the project identifier used with the public build APIs.
$sel:projectArn:UpdateProjectVisibility', updateProjectVisibilityResponse_projectArn - The Amazon Resource Name (ARN) of the build project.
$sel:projectVisibility:UpdateProjectVisibility', updateProjectVisibilityResponse_projectVisibility - Undocumented member.
$sel:httpStatus:UpdateProjectVisibilityResponse', updateProjectVisibilityResponse_httpStatus - The response's http status code.
ListReportsForReportGroup (Paginated)
data ListReportsForReportGroup Source #
See: newListReportsForReportGroup smart constructor.
Constructors
| ListReportsForReportGroup' (Maybe SortOrderType) (Maybe Text) (Maybe ReportFilter) (Maybe Natural) Text |
Instances
newListReportsForReportGroup Source #
Create a value of ListReportsForReportGroup 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:sortOrder:ListReportsForReportGroup', listReportsForReportGroup_sortOrder - Use to specify whether the results are returned in ascending or
descending order.
$sel:nextToken:ListReportsForReportGroup', listReportsForReportGroup_nextToken - During a previous call, the maximum number of items that can be returned
is the value specified in maxResults. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
$sel:filter':ListReportsForReportGroup', listReportsForReportGroup_filter - A ReportFilter object used to filter the returned reports.
$sel:maxResults:ListReportsForReportGroup', listReportsForReportGroup_maxResults - The maximum number of paginated reports in this report group returned
per response. Use nextToken to iterate pages in the list of returned
Report objects. The default value is 100.
$sel:reportGroupArn:ListReportsForReportGroup', listReportsForReportGroup_reportGroupArn - The ARN of the report group for which you want to return report ARNs.
data ListReportsForReportGroupResponse Source #
See: newListReportsForReportGroupResponse smart constructor.
Instances
newListReportsForReportGroupResponse Source #
Arguments
| :: Int | |
| -> ListReportsForReportGroupResponse |
Create a value of ListReportsForReportGroupResponse 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:reports:ListReportsForReportGroupResponse', listReportsForReportGroupResponse_reports - The list of report ARNs.
$sel:nextToken:ListReportsForReportGroup', listReportsForReportGroupResponse_nextToken - During a previous call, the maximum number of items that can be returned
is the value specified in maxResults. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
$sel:httpStatus:ListReportsForReportGroupResponse', listReportsForReportGroupResponse_httpStatus - The response's http status code.
InvalidateProjectCache
data InvalidateProjectCache Source #
See: newInvalidateProjectCache smart constructor.
Constructors
| InvalidateProjectCache' Text |
Instances
newInvalidateProjectCache Source #
Create a value of InvalidateProjectCache 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:projectName:InvalidateProjectCache', invalidateProjectCache_projectName - The name of the CodeBuild build project that the cache is reset for.
data InvalidateProjectCacheResponse Source #
See: newInvalidateProjectCacheResponse smart constructor.
Constructors
| InvalidateProjectCacheResponse' Int |
Instances
newInvalidateProjectCacheResponse Source #
Create a value of InvalidateProjectCacheResponse 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:InvalidateProjectCacheResponse', invalidateProjectCacheResponse_httpStatus - The response's http status code.
UpdateReportGroup
data UpdateReportGroup Source #
See: newUpdateReportGroup smart constructor.
Constructors
| UpdateReportGroup' (Maybe ReportExportConfig) (Maybe [Tag]) Text |
Instances
Arguments
| :: Text | |
| -> UpdateReportGroup |
Create a value of UpdateReportGroup 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:exportConfig:UpdateReportGroup', updateReportGroup_exportConfig - Used to specify an updated export type. Valid values are:
S3: The report results are exported to an S3 bucket.NO_EXPORT: The report results are not exported.
$sel:tags:UpdateReportGroup', updateReportGroup_tags - An updated list of tag key and value pairs associated with this report
group.
These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
$sel:arn:UpdateReportGroup', updateReportGroup_arn - The ARN of the report group to update.
data UpdateReportGroupResponse Source #
See: newUpdateReportGroupResponse smart constructor.
Constructors
| UpdateReportGroupResponse' (Maybe ReportGroup) Int |
Instances
newUpdateReportGroupResponse Source #
Create a value of UpdateReportGroupResponse 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:reportGroup:UpdateReportGroupResponse', updateReportGroupResponse_reportGroup - Information about the updated report group.
$sel:httpStatus:UpdateReportGroupResponse', updateReportGroupResponse_httpStatus - The response's http status code.
DeleteReportGroup
data DeleteReportGroup Source #
See: newDeleteReportGroup smart constructor.
Constructors
| DeleteReportGroup' (Maybe Bool) Text |
Instances
Arguments
| :: Text | |
| -> DeleteReportGroup |
Create a value of DeleteReportGroup 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:deleteReports:DeleteReportGroup', deleteReportGroup_deleteReports - If true, deletes any reports that belong to a report group before
deleting the report group.
If false, you must delete any reports in the report group. Use
ListReportsForReportGroup
to get the reports in a report group. Use
DeleteReport
to delete the reports. If you call DeleteReportGroup for a report
group that contains one or more reports, an exception is thrown.
$sel:arn:DeleteReportGroup', deleteReportGroup_arn - The ARN of the report group to delete.
data DeleteReportGroupResponse Source #
See: newDeleteReportGroupResponse smart constructor.
Constructors
| DeleteReportGroupResponse' Int |
Instances
newDeleteReportGroupResponse Source #
Create a value of DeleteReportGroupResponse 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:DeleteReportGroupResponse', deleteReportGroupResponse_httpStatus - The response's http status code.
BatchDeleteBuilds
data BatchDeleteBuilds Source #
See: newBatchDeleteBuilds smart constructor.
Constructors
| BatchDeleteBuilds' (NonEmpty Text) |
Instances
Arguments
| :: NonEmpty Text | |
| -> BatchDeleteBuilds |
Create a value of BatchDeleteBuilds 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:ids:BatchDeleteBuilds', batchDeleteBuilds_ids - The IDs of the builds to delete.
data BatchDeleteBuildsResponse Source #
See: newBatchDeleteBuildsResponse smart constructor.
Constructors
| BatchDeleteBuildsResponse' (Maybe [BuildNotDeleted]) (Maybe (NonEmpty Text)) Int |
Instances
newBatchDeleteBuildsResponse Source #
Create a value of BatchDeleteBuildsResponse 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:buildsNotDeleted:BatchDeleteBuildsResponse', batchDeleteBuildsResponse_buildsNotDeleted - Information about any builds that could not be successfully deleted.
$sel:buildsDeleted:BatchDeleteBuildsResponse', batchDeleteBuildsResponse_buildsDeleted - The IDs of the builds that were successfully deleted.
$sel:httpStatus:BatchDeleteBuildsResponse', batchDeleteBuildsResponse_httpStatus - The response's http status code.
ListReportGroups (Paginated)
data ListReportGroups Source #
See: newListReportGroups smart constructor.
Constructors
| ListReportGroups' (Maybe SortOrderType) (Maybe Text) (Maybe Natural) (Maybe ReportGroupSortByType) |
Instances
newListReportGroups :: ListReportGroups Source #
Create a value of ListReportGroups 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:sortOrder:ListReportGroups', listReportGroups_sortOrder - Used to specify the order to sort the list of returned report groups.
Valid values are ASCENDING and DESCENDING.
$sel:nextToken:ListReportGroups', listReportGroups_nextToken - During a previous call, the maximum number of items that can be returned
is the value specified in maxResults. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
$sel:maxResults:ListReportGroups', listReportGroups_maxResults - The maximum number of paginated report groups returned per response. Use
nextToken to iterate pages in the list of returned ReportGroup
objects. The default value is 100.
$sel:sortBy:ListReportGroups', listReportGroups_sortBy - The criterion to be used to list build report groups. Valid values
include:
CREATED_TIME: List based on when each report group was created.LAST_MODIFIED_TIME: List based on when each report group was last changed.NAME: List based on each report group's name.
data ListReportGroupsResponse Source #
See: newListReportGroupsResponse smart constructor.
Instances
newListReportGroupsResponse Source #
Create a value of ListReportGroupsResponse 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:nextToken:ListReportGroups', listReportGroupsResponse_nextToken - During a previous call, the maximum number of items that can be returned
is the value specified in maxResults. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
$sel:reportGroups:ListReportGroupsResponse', listReportGroupsResponse_reportGroups - The list of ARNs for the report groups in the current Amazon Web
Services account.
$sel:httpStatus:ListReportGroupsResponse', listReportGroupsResponse_httpStatus - The response's http status code.
PutResourcePolicy
data PutResourcePolicy Source #
See: newPutResourcePolicy smart constructor.
Constructors
| PutResourcePolicy' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> PutResourcePolicy |
Create a value of PutResourcePolicy 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:policy:PutResourcePolicy', putResourcePolicy_policy - A JSON-formatted resource policy. For more information, see
Sharing a Project
and
Sharing a Report Group
in the CodeBuild User Guide.
$sel:resourceArn:PutResourcePolicy', putResourcePolicy_resourceArn - The ARN of the Project or ReportGroup resource you want to associate
with a resource policy.
data PutResourcePolicyResponse Source #
See: newPutResourcePolicyResponse smart constructor.
Constructors
| PutResourcePolicyResponse' (Maybe Text) Int |
Instances
newPutResourcePolicyResponse Source #
Create a value of PutResourcePolicyResponse 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:resourceArn:PutResourcePolicy', putResourcePolicyResponse_resourceArn - The ARN of the Project or ReportGroup resource that is associated
with a resource policy.
$sel:httpStatus:PutResourcePolicyResponse', putResourcePolicyResponse_httpStatus - The response's http status code.
DeleteResourcePolicy
data DeleteResourcePolicy Source #
See: newDeleteResourcePolicy smart constructor.
Constructors
| DeleteResourcePolicy' Text |
Instances
newDeleteResourcePolicy Source #
Create a value of DeleteResourcePolicy 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:resourceArn:DeleteResourcePolicy', deleteResourcePolicy_resourceArn - The ARN of the resource that is associated with the resource policy.
data DeleteResourcePolicyResponse Source #
See: newDeleteResourcePolicyResponse smart constructor.
Constructors
| DeleteResourcePolicyResponse' Int |
Instances
newDeleteResourcePolicyResponse Source #
Create a value of DeleteResourcePolicyResponse 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:DeleteResourcePolicyResponse', deleteResourcePolicyResponse_httpStatus - The response's http status code.
ListCuratedEnvironmentImages
data ListCuratedEnvironmentImages Source #
See: newListCuratedEnvironmentImages smart constructor.
Constructors
| ListCuratedEnvironmentImages' | |
Instances
newListCuratedEnvironmentImages :: ListCuratedEnvironmentImages Source #
Create a value of ListCuratedEnvironmentImages with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data ListCuratedEnvironmentImagesResponse Source #
See: newListCuratedEnvironmentImagesResponse smart constructor.
Constructors
| ListCuratedEnvironmentImagesResponse' (Maybe [EnvironmentPlatform]) Int |
Instances
newListCuratedEnvironmentImagesResponse Source #
Arguments
| :: Int | |
| -> ListCuratedEnvironmentImagesResponse |
Create a value of ListCuratedEnvironmentImagesResponse 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:platforms:ListCuratedEnvironmentImagesResponse', listCuratedEnvironmentImagesResponse_platforms - Information about supported platforms for Docker images that are managed
by CodeBuild.
$sel:httpStatus:ListCuratedEnvironmentImagesResponse', listCuratedEnvironmentImagesResponse_httpStatus - The response's http status code.
GetReportGroupTrend
data GetReportGroupTrend Source #
See: newGetReportGroupTrend smart constructor.
Constructors
| GetReportGroupTrend' (Maybe Natural) Text ReportGroupTrendFieldType |
Instances
newGetReportGroupTrend Source #
Arguments
| :: Text | |
| -> ReportGroupTrendFieldType | |
| -> GetReportGroupTrend |
Create a value of GetReportGroupTrend 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:numOfReports:GetReportGroupTrend', getReportGroupTrend_numOfReports - The number of reports to analyze. This operation always retrieves the
most recent reports.
If this parameter is omitted, the most recent 100 reports are analyzed.
$sel:reportGroupArn:GetReportGroupTrend', getReportGroupTrend_reportGroupArn - The ARN of the report group that contains the reports to analyze.
$sel:trendField:GetReportGroupTrend', getReportGroupTrend_trendField - The test report value to accumulate. This must be one of the following
values:
- Test reports:
- DURATION
- Accumulate the test run times for the specified reports.
- PASS_RATE
- Accumulate the percentage of tests that passed for the specified test reports.
- TOTAL
- Accumulate the total number of tests for the specified test reports.
- Code coverage reports:
- BRANCH_COVERAGE
- Accumulate the branch coverage percentages for the specified
test reports.
- BRANCHES_COVERED
- Accumulate the branches covered values for the specified test reports.
- BRANCHES_MISSED
- Accumulate the branches missed values for the specified test reports.
- LINE_COVERAGE
- Accumulate the line coverage percentages for the specified test reports.
- LINES_COVERED
- Accumulate the lines covered values for the specified test reports.
- LINES_MISSED
- Accumulate the lines not covered values for the specified test reports.
data GetReportGroupTrendResponse Source #
See: newGetReportGroupTrendResponse smart constructor.
Constructors
| GetReportGroupTrendResponse' (Maybe [ReportWithRawData]) (Maybe ReportGroupTrendStats) Int |
Instances
newGetReportGroupTrendResponse Source #
Create a value of GetReportGroupTrendResponse 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:rawData:GetReportGroupTrendResponse', getReportGroupTrendResponse_rawData - An array that contains the raw data for each report.
$sel:stats:GetReportGroupTrendResponse', getReportGroupTrendResponse_stats - Contains the accumulated trend data.
$sel:httpStatus:GetReportGroupTrendResponse', getReportGroupTrendResponse_httpStatus - The response's http status code.
StopBuild
See: newStopBuild smart constructor.
Constructors
| StopBuild' Text |
Instances
Create a value of StopBuild 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:StopBuild', stopBuild_id - The ID of the build.
data StopBuildResponse Source #
See: newStopBuildResponse smart constructor.
Constructors
| StopBuildResponse' (Maybe Build) Int |
Instances
Arguments
| :: Int | |
| -> StopBuildResponse |
Create a value of StopBuildResponse 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:build:StopBuildResponse', stopBuildResponse_build - Information about the build.
$sel:httpStatus:StopBuildResponse', stopBuildResponse_httpStatus - The response's http status code.
ListBuildBatches (Paginated)
data ListBuildBatches Source #
See: newListBuildBatches smart constructor.
Constructors
| ListBuildBatches' (Maybe SortOrderType) (Maybe Text) (Maybe BuildBatchFilter) (Maybe Natural) |
Instances
newListBuildBatches :: ListBuildBatches Source #
Create a value of ListBuildBatches 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:sortOrder:ListBuildBatches', listBuildBatches_sortOrder - Specifies the sort order of the returned items. Valid values include:
ASCENDING: List the batch build identifiers in ascending order by identifier.DESCENDING: List the batch build identifiers in descending order by identifier.
$sel:nextToken:ListBuildBatches', listBuildBatches_nextToken - The nextToken value returned from a previous call to
ListBuildBatches. This specifies the next item to return. To return
the beginning of the list, exclude this parameter.
$sel:filter':ListBuildBatches', listBuildBatches_filter - A BuildBatchFilter object that specifies the filters for the search.
$sel:maxResults:ListBuildBatches', listBuildBatches_maxResults - The maximum number of results to return.
data ListBuildBatchesResponse Source #
See: newListBuildBatchesResponse smart constructor.
Instances
newListBuildBatchesResponse Source #
Create a value of ListBuildBatchesResponse 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:ids:ListBuildBatchesResponse', listBuildBatchesResponse_ids - An array of strings that contains the batch build identifiers.
$sel:nextToken:ListBuildBatches', listBuildBatchesResponse_nextToken - If there are more items to return, this contains a token that is passed
to a subsequent call to ListBuildBatches to retrieve the next set of
items.
$sel:httpStatus:ListBuildBatchesResponse', listBuildBatchesResponse_httpStatus - The response's http status code.
CreateProject
data CreateProject Source #
See: newCreateProject smart constructor.
Constructors
| CreateProject' (Maybe [ProjectArtifacts]) (Maybe Int) (Maybe Bool) (Maybe [ProjectSourceVersion]) (Maybe Natural) (Maybe ProjectCache) (Maybe [ProjectSource]) (Maybe Text) (Maybe VpcConfig) (Maybe LogsConfig) (Maybe [ProjectFileSystemLocation]) (Maybe ProjectBuildBatchConfig) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Natural) Text ProjectSource ProjectArtifacts ProjectEnvironment Text |
Instances
Arguments
| :: Text | |
| -> ProjectSource | |
| -> ProjectArtifacts | |
| -> ProjectEnvironment | |
| -> 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:
$sel:secondaryArtifacts:CreateProject', createProject_secondaryArtifacts - An array of ProjectArtifacts objects.
$sel:concurrentBuildLimit:CreateProject', createProject_concurrentBuildLimit - The maximum number of concurrent builds that are allowed for this
project.
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
$sel:badgeEnabled:CreateProject', createProject_badgeEnabled - Set this to true to generate a publicly accessible URL for your
project's build badge.
$sel:secondarySourceVersions:CreateProject', createProject_secondarySourceVersions - An array of ProjectSourceVersion objects. If secondarySourceVersions
is specified at the build level, then they take precedence over these
secondarySourceVersions (at the project level).
$sel:queuedTimeoutInMinutes:CreateProject', createProject_queuedTimeoutInMinutes - The number of minutes a build is allowed to be queued before it times
out.
$sel:cache:CreateProject', createProject_cache - Stores recently used information so that it can be quickly accessed at a
later time.
$sel:secondarySources:CreateProject', createProject_secondarySources - An array of ProjectSource objects.
$sel:sourceVersion:CreateProject', createProject_sourceVersion - A version of the build input to be built for this project. If not
specified, the latest version is used. If specified, it must be one of:
- For CodeCommit: the commit ID, branch, or Git tag to use.
- For GitHub: the commit ID, pull request ID, branch name, or tag name
that corresponds to the version of the source code you want to
build. If a pull request ID is specified, it must use the format
pr/pull-request-ID(for examplepr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. - For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
- For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version
takes precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
$sel:vpcConfig:CreateProject', createProject_vpcConfig - VpcConfig enables CodeBuild to access resources in an Amazon VPC.
$sel:logsConfig:CreateProject', createProject_logsConfig - Information about logs for the build project. These can be logs in
CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.
$sel:fileSystemLocations:CreateProject', createProject_fileSystemLocations - An array of ProjectFileSystemLocation objects for a CodeBuild build
project. A ProjectFileSystemLocation object specifies the
identifier, location, mountOptions, mountPoint, and type of a
file system created using Amazon Elastic File System.
$sel:buildBatchConfig:CreateProject', createProject_buildBatchConfig - A ProjectBuildBatchConfig object that defines the batch build options
for the project.
$sel:encryptionKey:CreateProject', createProject_encryptionKey - The Key Management Service customer master key (CMK) to be used for
encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if
available, the CMK's alias (using the format alias/<alias-name>).
$sel:description:CreateProject', createProject_description - A description that makes the build project easy to identify.
$sel:tags:CreateProject', createProject_tags - A list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
$sel:timeoutInMinutes:CreateProject', createProject_timeoutInMinutes - How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait
before it times out any build that has not been marked as completed. The
default is 60 minutes.
$sel:name:CreateProject', createProject_name - The name of the build project.
$sel:source:CreateProject', createProject_source - Information about the build input source code for the build project.
$sel:artifacts:CreateProject', createProject_artifacts - Information about the build output artifacts for the build project.
$sel:environment:CreateProject', createProject_environment - Information about the build environment for the build project.
$sel:serviceRole:CreateProject', createProject_serviceRole - The ARN of the IAM role that enables CodeBuild to interact with
dependent Amazon Web Services services on behalf of the Amazon Web
Services account.
data CreateProjectResponse Source #
See: newCreateProjectResponse smart constructor.
Constructors
| CreateProjectResponse' (Maybe Project) Int |
Instances
newCreateProjectResponse Source #
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:
$sel:project:CreateProjectResponse', createProjectResponse_project - Information about the build project that was created.
$sel:httpStatus:CreateProjectResponse', createProjectResponse_httpStatus - The response's http status code.
ListSharedReportGroups (Paginated)
data ListSharedReportGroups Source #
See: newListSharedReportGroups smart constructor.
Constructors
| ListSharedReportGroups' (Maybe SortOrderType) (Maybe Text) (Maybe Natural) (Maybe SharedResourceSortByType) |
Instances
newListSharedReportGroups :: ListSharedReportGroups Source #
Create a value of ListSharedReportGroups 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:sortOrder:ListSharedReportGroups', listSharedReportGroups_sortOrder - The order in which to list shared report groups. Valid values include:
ASCENDING: List in ascending order.DESCENDING: List in descending order.
$sel:nextToken:ListSharedReportGroups', listSharedReportGroups_nextToken - During a previous call, the maximum number of items that can be returned
is the value specified in maxResults. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
$sel:maxResults:ListSharedReportGroups', listSharedReportGroups_maxResults - The maximum number of paginated shared report groups per response. Use
nextToken to iterate pages in the list of returned ReportGroup
objects. The default value is 100.
$sel:sortBy:ListSharedReportGroups', listSharedReportGroups_sortBy - The criterion to be used to list report groups shared with the current
Amazon Web Services account or user. Valid values include:
ARN: List based on the ARN.MODIFIED_TIME: List based on when information about the shared report group was last changed.
data ListSharedReportGroupsResponse Source #
See: newListSharedReportGroupsResponse smart constructor.
Instances
newListSharedReportGroupsResponse Source #
Create a value of ListSharedReportGroupsResponse 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:nextToken:ListSharedReportGroups', listSharedReportGroupsResponse_nextToken - During a previous call, the maximum number of items that can be returned
is the value specified in maxResults. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
$sel:reportGroups:ListSharedReportGroupsResponse', listSharedReportGroupsResponse_reportGroups - The list of ARNs for the report groups shared with the current Amazon
Web Services account or user.
$sel:httpStatus:ListSharedReportGroupsResponse', listSharedReportGroupsResponse_httpStatus - The response's http status code.
Types
ArtifactNamespace
newtype ArtifactNamespace Source #
Constructors
| ArtifactNamespace' | |
Fields | |
Bundled Patterns
| pattern ArtifactNamespace_BUILD_ID :: ArtifactNamespace | |
| pattern ArtifactNamespace_NONE :: ArtifactNamespace |
Instances
ArtifactPackaging
newtype ArtifactPackaging Source #
Constructors
| ArtifactPackaging' | |
Fields | |
Bundled Patterns
| pattern ArtifactPackaging_NONE :: ArtifactPackaging | |
| pattern ArtifactPackaging_ZIP :: ArtifactPackaging |
Instances
ArtifactsType
newtype ArtifactsType Source #
Constructors
| ArtifactsType' | |
Fields | |
Bundled Patterns
| pattern ArtifactsType_CODEPIPELINE :: ArtifactsType | |
| pattern ArtifactsType_NO_ARTIFACTS :: ArtifactsType | |
| pattern ArtifactsType_S3 :: ArtifactsType |
Instances
AuthType
Constructors
| AuthType' | |
Fields
| |
Bundled Patterns
| pattern AuthType_BASIC_AUTH :: AuthType | |
| pattern AuthType_OAUTH :: AuthType | |
| pattern AuthType_PERSONAL_ACCESS_TOKEN :: AuthType |
Instances
BatchReportModeType
newtype BatchReportModeType Source #
Constructors
| BatchReportModeType' | |
Fields | |
Bundled Patterns
| pattern BatchReportModeType_REPORT_AGGREGATED_BATCH :: BatchReportModeType | |
| pattern BatchReportModeType_REPORT_INDIVIDUAL_BUILDS :: BatchReportModeType |
Instances
BucketOwnerAccess
newtype BucketOwnerAccess Source #
Specifies the bucket owner's access for objects that another account uploads to their Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has access to these objects. This property allows you to give the bucket owner access to these objects.
To use this property, your CodeBuild service role must have the
s3:PutBucketAcl permission. This permission allows CodeBuild to modify
the access control list for the bucket.
This property can be one of the following values:
- NONE
- The bucket owner does not have access to the objects. This is the default.
- READ_ONLY
- The bucket owner has read-only access to the objects. The uploading account retains ownership of the objects.
- FULL
- The bucket owner has full access to the objects. Object ownership is
determined by the following criteria:
- If the bucket is configured with the Bucket owner preferred setting, the bucket owner owns the objects. The uploading account will have object access as specified by the bucket's policy.
- Otherwise, the uploading account retains ownership of the objects.
For more information about Amazon S3 object ownership, see Controlling ownership of uploaded objects using S3 Object Ownership in the Amazon Simple Storage Service User Guide.
Constructors
| BucketOwnerAccess' | |
Fields | |
Bundled Patterns
| pattern BucketOwnerAccess_FULL :: BucketOwnerAccess | |
| pattern BucketOwnerAccess_NONE :: BucketOwnerAccess | |
| pattern BucketOwnerAccess_READ_ONLY :: BucketOwnerAccess |
Instances
BuildBatchPhaseType
newtype BuildBatchPhaseType Source #
Constructors
| BuildBatchPhaseType' | |
Fields | |
Bundled Patterns
| pattern BuildBatchPhaseType_COMBINE_ARTIFACTS :: BuildBatchPhaseType | |
| pattern BuildBatchPhaseType_DOWNLOAD_BATCHSPEC :: BuildBatchPhaseType | |
| pattern BuildBatchPhaseType_FAILED :: BuildBatchPhaseType | |
| pattern BuildBatchPhaseType_IN_PROGRESS :: BuildBatchPhaseType | |
| pattern BuildBatchPhaseType_STOPPED :: BuildBatchPhaseType | |
| pattern BuildBatchPhaseType_SUBMITTED :: BuildBatchPhaseType | |
| pattern BuildBatchPhaseType_SUCCEEDED :: BuildBatchPhaseType |
Instances
BuildPhaseType
newtype BuildPhaseType Source #
Constructors
| BuildPhaseType' | |
Fields | |
Bundled Patterns
| pattern BuildPhaseType_BUILD :: BuildPhaseType | |
| pattern BuildPhaseType_COMPLETED :: BuildPhaseType | |
| pattern BuildPhaseType_DOWNLOAD_SOURCE :: BuildPhaseType | |
| pattern BuildPhaseType_FINALIZING :: BuildPhaseType | |
| pattern BuildPhaseType_INSTALL :: BuildPhaseType | |
| pattern BuildPhaseType_POST_BUILD :: BuildPhaseType | |
| pattern BuildPhaseType_PRE_BUILD :: BuildPhaseType | |
| pattern BuildPhaseType_PROVISIONING :: BuildPhaseType | |
| pattern BuildPhaseType_QUEUED :: BuildPhaseType | |
| pattern BuildPhaseType_SUBMITTED :: BuildPhaseType | |
| pattern BuildPhaseType_UPLOAD_ARTIFACTS :: BuildPhaseType |
Instances
CacheMode
Constructors
| CacheMode' | |
Fields | |
Bundled Patterns
| pattern CacheMode_LOCAL_CUSTOM_CACHE :: CacheMode | |
| pattern CacheMode_LOCAL_DOCKER_LAYER_CACHE :: CacheMode | |
| pattern CacheMode_LOCAL_SOURCE_CACHE :: CacheMode |
Instances
CacheType
Constructors
| CacheType' | |
Fields | |
Bundled Patterns
| pattern CacheType_LOCAL :: CacheType | |
| pattern CacheType_NO_CACHE :: CacheType | |
| pattern CacheType_S3 :: CacheType |
Instances
ComputeType
newtype ComputeType Source #
Constructors
| ComputeType' | |
Fields | |
Bundled Patterns
| pattern ComputeType_BUILD_GENERAL1_2XLARGE :: ComputeType | |
| pattern ComputeType_BUILD_GENERAL1_LARGE :: ComputeType | |
| pattern ComputeType_BUILD_GENERAL1_MEDIUM :: ComputeType | |
| pattern ComputeType_BUILD_GENERAL1_SMALL :: ComputeType |
Instances
CredentialProviderType
newtype CredentialProviderType Source #
Constructors
| CredentialProviderType' | |
Fields | |
Bundled Patterns
| pattern CredentialProviderType_SECRETS_MANAGER :: CredentialProviderType |
Instances
EnvironmentType
newtype EnvironmentType Source #
Constructors
| EnvironmentType' | |
Fields | |
Bundled Patterns
| pattern EnvironmentType_ARM_CONTAINER :: EnvironmentType | |
| pattern EnvironmentType_LINUX_CONTAINER :: EnvironmentType | |
| pattern EnvironmentType_LINUX_GPU_CONTAINER :: EnvironmentType | |
| pattern EnvironmentType_WINDOWS_CONTAINER :: EnvironmentType | |
| pattern EnvironmentType_WINDOWS_SERVER_2019_CONTAINER :: EnvironmentType |
Instances
EnvironmentVariableType
newtype EnvironmentVariableType Source #
Constructors
| EnvironmentVariableType' | |
Fields | |
Bundled Patterns
Instances
FileSystemType
newtype FileSystemType Source #
Constructors
| FileSystemType' | |
Fields | |
Bundled Patterns
| pattern FileSystemType_EFS :: FileSystemType |
Instances
ImagePullCredentialsType
newtype ImagePullCredentialsType Source #
Constructors
| ImagePullCredentialsType' | |
Fields | |
Bundled Patterns
| pattern ImagePullCredentialsType_CODEBUILD :: ImagePullCredentialsType | |
| pattern ImagePullCredentialsType_SERVICE_ROLE :: ImagePullCredentialsType |
Instances
LanguageType
newtype LanguageType Source #
Constructors
| LanguageType' | |
Fields | |
Bundled Patterns
| pattern LanguageType_ANDROID :: LanguageType | |
| pattern LanguageType_BASE :: LanguageType | |
| pattern LanguageType_DOCKER :: LanguageType | |
| pattern LanguageType_DOTNET :: LanguageType | |
| pattern LanguageType_GOLANG :: LanguageType | |
| pattern LanguageType_JAVA :: LanguageType | |
| pattern LanguageType_NODE_JS :: LanguageType | |
| pattern LanguageType_PHP :: LanguageType | |
| pattern LanguageType_PYTHON :: LanguageType | |
| pattern LanguageType_RUBY :: LanguageType |
Instances
LogsConfigStatusType
newtype LogsConfigStatusType Source #
Constructors
| LogsConfigStatusType' | |
Fields | |
Bundled Patterns
| pattern LogsConfigStatusType_DISABLED :: LogsConfigStatusType | |
| pattern LogsConfigStatusType_ENABLED :: LogsConfigStatusType |
Instances
PlatformType
newtype PlatformType Source #
Constructors
| PlatformType' | |
Fields | |
Bundled Patterns
| pattern PlatformType_AMAZON_LINUX :: PlatformType | |
| pattern PlatformType_DEBIAN :: PlatformType | |
| pattern PlatformType_UBUNTU :: PlatformType | |
| pattern PlatformType_WINDOWS_SERVER :: PlatformType |
Instances
ProjectSortByType
newtype ProjectSortByType Source #
Constructors
| ProjectSortByType' | |
Fields | |
Bundled Patterns
| pattern ProjectSortByType_CREATED_TIME :: ProjectSortByType | |
| pattern ProjectSortByType_LAST_MODIFIED_TIME :: ProjectSortByType | |
| pattern ProjectSortByType_NAME :: ProjectSortByType |
Instances
ProjectVisibilityType
newtype ProjectVisibilityType Source #
Specifies the visibility of the project's builds. Possible values are:
- PUBLIC_READ
- The project builds are visible to the public.
- PRIVATE
- The project builds are not visible to the public.
Constructors
| ProjectVisibilityType' | |
Fields | |
Bundled Patterns
| pattern ProjectVisibilityType_PRIVATE :: ProjectVisibilityType | |
| pattern ProjectVisibilityType_PUBLIC_READ :: ProjectVisibilityType |
Instances
ReportCodeCoverageSortByType
newtype ReportCodeCoverageSortByType Source #
Constructors
| ReportCodeCoverageSortByType' | |
Fields | |
Bundled Patterns
| pattern ReportCodeCoverageSortByType_FILE_PATH :: ReportCodeCoverageSortByType | |
| pattern ReportCodeCoverageSortByType_LINE_COVERAGE_PERCENTAGE :: ReportCodeCoverageSortByType |
Instances
ReportExportConfigType
newtype ReportExportConfigType Source #
Constructors
| ReportExportConfigType' | |
Fields | |
Bundled Patterns
| pattern ReportExportConfigType_NO_EXPORT :: ReportExportConfigType | |
| pattern ReportExportConfigType_S3 :: ReportExportConfigType |
Instances
ReportGroupSortByType
newtype ReportGroupSortByType Source #
Constructors
| ReportGroupSortByType' | |
Fields | |
Bundled Patterns
Instances
ReportGroupStatusType
newtype ReportGroupStatusType Source #
Constructors
| ReportGroupStatusType' | |
Fields | |
Bundled Patterns
| pattern ReportGroupStatusType_ACTIVE :: ReportGroupStatusType | |
| pattern ReportGroupStatusType_DELETING :: ReportGroupStatusType |
Instances
ReportGroupTrendFieldType
newtype ReportGroupTrendFieldType Source #
Constructors
| ReportGroupTrendFieldType' | |
Fields | |
Bundled Patterns
Instances
ReportPackagingType
newtype ReportPackagingType Source #
Constructors
| ReportPackagingType' | |
Fields | |
Bundled Patterns
| pattern ReportPackagingType_NONE :: ReportPackagingType | |
| pattern ReportPackagingType_ZIP :: ReportPackagingType |
Instances
ReportStatusType
newtype ReportStatusType Source #
Constructors
| ReportStatusType' | |
Fields | |
Bundled Patterns
| pattern ReportStatusType_DELETING :: ReportStatusType | |
| pattern ReportStatusType_FAILED :: ReportStatusType | |
| pattern ReportStatusType_GENERATING :: ReportStatusType | |
| pattern ReportStatusType_INCOMPLETE :: ReportStatusType | |
| pattern ReportStatusType_SUCCEEDED :: ReportStatusType |
Instances
ReportType
newtype ReportType Source #
Constructors
| ReportType' | |
Fields | |
Bundled Patterns
| pattern ReportType_CODE_COVERAGE :: ReportType | |
| pattern ReportType_TEST :: ReportType |
Instances
RetryBuildBatchType
newtype RetryBuildBatchType Source #
Constructors
| RetryBuildBatchType' | |
Fields | |
Bundled Patterns
| pattern RetryBuildBatchType_RETRY_ALL_BUILDS :: RetryBuildBatchType | |
| pattern RetryBuildBatchType_RETRY_FAILED_BUILDS :: RetryBuildBatchType |
Instances
ServerType
newtype ServerType Source #
Constructors
| ServerType' | |
Fields | |
Bundled Patterns
| pattern ServerType_BITBUCKET :: ServerType | |
| pattern ServerType_GITHUB :: ServerType | |
| pattern ServerType_GITHUB_ENTERPRISE :: ServerType |
Instances
SharedResourceSortByType
newtype SharedResourceSortByType Source #
Constructors
| SharedResourceSortByType' | |
Fields | |
Bundled Patterns
| pattern SharedResourceSortByType_ARN :: SharedResourceSortByType | |
| pattern SharedResourceSortByType_MODIFIED_TIME :: SharedResourceSortByType |
Instances
SortOrderType
newtype SortOrderType Source #
Constructors
| SortOrderType' | |
Fields | |
Bundled Patterns
| pattern SortOrderType_ASCENDING :: SortOrderType | |
| pattern SortOrderType_DESCENDING :: SortOrderType |
Instances
SourceAuthType
newtype SourceAuthType Source #
Constructors
| SourceAuthType' | |
Fields | |
Bundled Patterns
| pattern SourceAuthType_OAUTH :: SourceAuthType |
Instances
SourceType
newtype SourceType Source #
Constructors
| SourceType' | |
Fields | |
Bundled Patterns
| pattern SourceType_BITBUCKET :: SourceType | |
| pattern SourceType_CODECOMMIT :: SourceType | |
| pattern SourceType_CODEPIPELINE :: SourceType | |
| pattern SourceType_GITHUB :: SourceType | |
| pattern SourceType_GITHUB_ENTERPRISE :: SourceType | |
| pattern SourceType_NO_SOURCE :: SourceType | |
| pattern SourceType_S3 :: SourceType |
Instances
StatusType
newtype StatusType Source #
Constructors
| StatusType' | |
Fields | |
Bundled Patterns
| pattern StatusType_FAILED :: StatusType | |
| pattern StatusType_FAULT :: StatusType | |
| pattern StatusType_IN_PROGRESS :: StatusType | |
| pattern StatusType_STOPPED :: StatusType | |
| pattern StatusType_SUCCEEDED :: StatusType | |
| pattern StatusType_TIMED_OUT :: StatusType |
Instances
WebhookBuildType
newtype WebhookBuildType Source #
Constructors
| WebhookBuildType' | |
Fields | |
Bundled Patterns
| pattern WebhookBuildType_BUILD :: WebhookBuildType | |
| pattern WebhookBuildType_BUILD_BATCH :: WebhookBuildType |
Instances
WebhookFilterType
newtype WebhookFilterType Source #
Constructors
| WebhookFilterType' | |
Fields | |
Bundled Patterns
| pattern WebhookFilterType_ACTOR_ACCOUNT_ID :: WebhookFilterType | |
| pattern WebhookFilterType_BASE_REF :: WebhookFilterType | |
| pattern WebhookFilterType_COMMIT_MESSAGE :: WebhookFilterType | |
| pattern WebhookFilterType_EVENT :: WebhookFilterType | |
| pattern WebhookFilterType_FILE_PATH :: WebhookFilterType | |
| pattern WebhookFilterType_HEAD_REF :: WebhookFilterType |
Instances
BatchRestrictions
data BatchRestrictions Source #
Specifies restrictions for the batch build.
See: newBatchRestrictions smart constructor.
Constructors
| BatchRestrictions' (Maybe Int) (Maybe [Text]) |
Instances
newBatchRestrictions :: BatchRestrictions Source #
Create a value of BatchRestrictions 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:maximumBuildsAllowed:BatchRestrictions', batchRestrictions_maximumBuildsAllowed - Specifies the maximum number of builds allowed.
$sel:computeTypesAllowed:BatchRestrictions', batchRestrictions_computeTypesAllowed - An array of strings that specify the compute types that are allowed for
the batch build. See
Build environment compute types
in the CodeBuild User Guide for these values.
Build
Information about a build.
See: newBuild smart constructor.
Constructors
| Build' (Maybe [BuildPhase]) (Maybe Bool) (Maybe [BuildArtifacts]) (Maybe Text) (Maybe [ExportedEnvironmentVariable]) (Maybe Integer) (Maybe POSIX) (Maybe BuildArtifacts) (Maybe ProjectEnvironment) (Maybe Text) (Maybe NetworkInterface) (Maybe [ProjectSourceVersion]) (Maybe Text) (Maybe Int) (Maybe ProjectCache) (Maybe [ProjectSource]) (Maybe DebugSession) (Maybe Text) (Maybe Text) (Maybe LogsLocation) (Maybe Text) (Maybe VpcConfig) (Maybe POSIX) (Maybe Text) (Maybe StatusType) (Maybe ProjectSource) (Maybe Text) (Maybe [ProjectFileSystemLocation]) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Int) |
Instances
Create a value of Build 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:phases:Build', build_phases - Information about all previous build phases that are complete and
information about any current build phase that is not yet complete.
$sel:buildComplete:Build', build_buildComplete - Whether the build is complete. True if complete; otherwise, false.
$sel:secondaryArtifacts:Build', build_secondaryArtifacts - An array of ProjectArtifacts objects.
$sel:arn:Build', build_arn - The Amazon Resource Name (ARN) of the build.
$sel:exportedEnvironmentVariables:Build', build_exportedEnvironmentVariables - A list of exported environment variables for this build.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
$sel:buildNumber:Build', build_buildNumber - The number of the build. For each project, the buildNumber of its
first build is 1. The buildNumber of each subsequent build is
incremented by 1. If a build is deleted, the buildNumber of other
builds does not change.
$sel:startTime:Build', build_startTime - When the build process started, expressed in Unix time format.
$sel:artifacts:Build', build_artifacts - Information about the output artifacts for the build.
$sel:environment:Build', build_environment - Information about the build environment for this build.
$sel:initiator:Build', build_initiator - The entity that started the build. Valid values include:
- If CodePipeline started the build, the pipeline's name (for
example,
codepipeline/my-demo-pipeline). - If an IAM user started the build, the user's name (for example,
MyUserName). - If the Jenkins plugin for CodeBuild started the build, the string
CodeBuild-Jenkins-Plugin.
$sel:networkInterface:Build', build_networkInterface - Describes a network interface.
$sel:secondarySourceVersions:Build', build_secondarySourceVersions - An array of ProjectSourceVersion objects. Each ProjectSourceVersion
must be one of:
- For CodeCommit: the commit ID, branch, or Git tag to use.
- For GitHub: the commit ID, pull request ID, branch name, or tag name
that corresponds to the version of the source code you want to
build. If a pull request ID is specified, it must use the format
pr/pull-request-ID(for example,pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. - For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
- For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
$sel:currentPhase:Build', build_currentPhase - The current build phase.
$sel:queuedTimeoutInMinutes:Build', build_queuedTimeoutInMinutes - The number of minutes a build is allowed to be queued before it times
out.
$sel:cache:Build', build_cache - Information about the cache for the build.
$sel:secondarySources:Build', build_secondarySources - An array of ProjectSource objects.
$sel:debugSession:Build', build_debugSession - Contains information about the debug session for this build.
$sel:sourceVersion:Build', build_sourceVersion - Any version identifier for the version of the source code to be built.
If sourceVersion is specified at the project level, then this
sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
$sel:buildBatchArn:Build', build_buildBatchArn - The ARN of the batch build that this build is a member of, if
applicable.
$sel:logs:Build', build_logs - Information about the build's logs in CloudWatch Logs.
$sel:resolvedSourceVersion:Build', build_resolvedSourceVersion - An identifier for the version of this build's source code.
- For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
- For CodePipeline, the source revision provided by CodePipeline.
- For Amazon S3, this does not apply.
$sel:vpcConfig:Build', build_vpcConfig - If your CodeBuild project accesses resources in an Amazon VPC, you
provide this parameter that identifies the VPC ID and the list of
security group IDs and subnet IDs. The security groups and subnets must
belong to the same VPC. You must provide at least one security group and
one subnet ID.
$sel:endTime:Build', build_endTime - When the build process ended, expressed in Unix time format.
$sel:projectName:Build', build_projectName - The name of the CodeBuild project.
$sel:buildStatus:Build', build_buildStatus - The current status of the build. Valid values include:
FAILED: The build failed.FAULT: The build faulted.IN_PROGRESS: The build is still in progress.STOPPED: The build stopped.SUCCEEDED: The build succeeded.TIMED_OUT: The build timed out.
$sel:source:Build', build_source - Information about the source code to be built.
$sel:id:Build', build_id - The unique ID for the build.
$sel:fileSystemLocations:Build', build_fileSystemLocations - An array of ProjectFileSystemLocation objects for a CodeBuild build
project. A ProjectFileSystemLocation object specifies the
identifier, location, mountOptions, mountPoint, and type of a
file system created using Amazon Elastic File System.
$sel:reportArns:Build', build_reportArns - An array of the ARNs associated with this build's reports.
$sel:encryptionKey:Build', build_encryptionKey - The Key Management Service customer master key (CMK) to be used for
encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if
available, the CMK's alias (using the format alias/<alias-name>).
$sel:serviceRole:Build', build_serviceRole - The name of a service role used for this build.
$sel:timeoutInMinutes:Build', build_timeoutInMinutes - How long, in minutes, for CodeBuild to wait before timing out this build
if it does not get marked as completed.
BuildArtifacts
data BuildArtifacts Source #
Information about build output artifacts.
See: newBuildArtifacts smart constructor.
Constructors
| BuildArtifacts' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe BucketOwnerAccess) |
Instances
newBuildArtifacts :: BuildArtifacts Source #
Create a value of BuildArtifacts 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:location:BuildArtifacts', buildArtifacts_location - Information about the location of the build artifacts.
$sel:md5sum:BuildArtifacts', buildArtifacts_md5sum - The MD5 hash of the build artifact.
You can use this hash along with a checksum tool to confirm file integrity and authenticity.
This value is available only if the build project's packaging value
is set to ZIP.
$sel:encryptionDisabled:BuildArtifacts', buildArtifacts_encryptionDisabled - Information that tells you if encryption for build artifacts is
disabled.
$sel:overrideArtifactName:BuildArtifacts', buildArtifacts_overrideArtifactName - If this flag is set, a name specified in the buildspec file overrides
the artifact name. The name specified in a buildspec file is calculated
at build time and uses the Shell Command Language. For example, you can
append a date and time to your artifact name so that it is always
unique.
$sel:artifactIdentifier:BuildArtifacts', buildArtifacts_artifactIdentifier - An identifier for this artifact definition.
$sel:sha256sum:BuildArtifacts', buildArtifacts_sha256sum - The SHA-256 hash of the build artifact.
You can use this hash along with a checksum tool to confirm file integrity and authenticity.
This value is available only if the build project's packaging value
is set to ZIP.
$sel:bucketOwnerAccess:BuildArtifacts', buildArtifacts_bucketOwnerAccess - Undocumented member.
BuildBatch
data BuildBatch Source #
Contains information about a batch build.
See: newBuildBatch smart constructor.
Constructors
| BuildBatch' (Maybe [BuildBatchPhase]) (Maybe [BuildArtifacts]) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe BuildArtifacts) (Maybe ProjectEnvironment) (Maybe Text) (Maybe [ProjectSourceVersion]) (Maybe StatusType) (Maybe Text) (Maybe Integer) (Maybe Int) (Maybe ProjectCache) (Maybe [ProjectSource]) (Maybe Text) (Maybe Text) (Maybe VpcConfig) (Maybe POSIX) (Maybe Text) (Maybe [BuildGroup]) (Maybe ProjectSource) (Maybe Text) (Maybe [ProjectFileSystemLocation]) (Maybe ProjectBuildBatchConfig) (Maybe Text) (Maybe LogsConfig) (Maybe Text) (Maybe Bool) |
Instances
newBuildBatch :: BuildBatch Source #
Create a value of BuildBatch 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:phases:BuildBatch', buildBatch_phases - An array of BuildBatchPhase objects the specify the phases of the
batch build.
$sel:secondaryArtifacts:BuildBatch', buildBatch_secondaryArtifacts - An array of BuildArtifacts objects the define the build artifacts for
this batch build.
$sel:buildTimeoutInMinutes:BuildBatch', buildBatch_buildTimeoutInMinutes - Specifies the maximum amount of time, in minutes, that the build in a
batch must be completed in.
$sel:debugSessionEnabled:BuildBatch', buildBatch_debugSessionEnabled - Specifies if session debugging is enabled for this batch build. For more
information, see
Viewing a running build in Session Manager.
Batch session debugging is not supported for matrix batch builds.
$sel:arn:BuildBatch', buildBatch_arn - The ARN of the batch build.
$sel:startTime:BuildBatch', buildBatch_startTime - The date and time that the batch build started.
$sel:artifacts:BuildBatch', buildBatch_artifacts - A BuildArtifacts object the defines the build artifacts for this batch
build.
$sel:environment:BuildBatch', buildBatch_environment - Undocumented member.
$sel:initiator:BuildBatch', buildBatch_initiator - The entity that started the batch build. Valid values include:
- If CodePipeline started the build, the pipeline's name (for
example,
codepipeline/my-demo-pipeline). - If an IAM user started the build, the user's name.
- If the Jenkins plugin for CodeBuild started the build, the string
CodeBuild-Jenkins-Plugin.
$sel:secondarySourceVersions:BuildBatch', buildBatch_secondarySourceVersions - An array of ProjectSourceVersion objects. Each ProjectSourceVersion
must be one of:
- For CodeCommit: the commit ID, branch, or Git tag to use.
- For GitHub: the commit ID, pull request ID, branch name, or tag name
that corresponds to the version of the source code you want to
build. If a pull request ID is specified, it must use the format
pr/pull-request-ID(for example,pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. - For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
- For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
$sel:buildBatchStatus:BuildBatch', buildBatch_buildBatchStatus - The status of the batch build.
$sel:currentPhase:BuildBatch', buildBatch_currentPhase - The current phase of the batch build.
$sel:buildBatchNumber:BuildBatch', buildBatch_buildBatchNumber - The number of the batch build. For each project, the buildBatchNumber
of its first batch build is 1. The buildBatchNumber of each
subsequent batch build is incremented by 1. If a batch build is
deleted, the buildBatchNumber of other batch builds does not change.
$sel:queuedTimeoutInMinutes:BuildBatch', buildBatch_queuedTimeoutInMinutes - Specifies the amount of time, in minutes, that the batch build is
allowed to be queued before it times out.
$sel:cache:BuildBatch', buildBatch_cache - Undocumented member.
$sel:secondarySources:BuildBatch', buildBatch_secondarySources - An array of ProjectSource objects that define the sources for the
batch build.
$sel:sourceVersion:BuildBatch', buildBatch_sourceVersion - The identifier of the version of the source code to be built.
$sel:resolvedSourceVersion:BuildBatch', buildBatch_resolvedSourceVersion - The identifier of the resolved version of this batch build's source
code.
- For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
- For CodePipeline, the source revision provided by CodePipeline.
- For Amazon S3, this does not apply.
$sel:vpcConfig:BuildBatch', buildBatch_vpcConfig - Undocumented member.
$sel:endTime:BuildBatch', buildBatch_endTime - The date and time that the batch build ended.
$sel:projectName:BuildBatch', buildBatch_projectName - The name of the batch build project.
$sel:buildGroups:BuildBatch', buildBatch_buildGroups - An array of BuildGroup objects that define the build groups for the
batch build.
$sel:source:BuildBatch', buildBatch_source - Undocumented member.
$sel:id:BuildBatch', buildBatch_id - The identifier of the batch build.
$sel:fileSystemLocations:BuildBatch', buildBatch_fileSystemLocations - An array of ProjectFileSystemLocation objects for the batch build
project. A ProjectFileSystemLocation object specifies the
identifier, location, mountOptions, mountPoint, and type of a
file system created using Amazon Elastic File System.
$sel:buildBatchConfig:BuildBatch', buildBatch_buildBatchConfig - Undocumented member.
$sel:encryptionKey:BuildBatch', buildBatch_encryptionKey - The Key Management Service customer master key (CMK) to be used for
encrypting the batch build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if
available, the CMK's alias (using the format alias/<alias-name>).
$sel:logConfig:BuildBatch', buildBatch_logConfig - Undocumented member.
$sel:serviceRole:BuildBatch', buildBatch_serviceRole - The name of a service role used for builds in the batch.
$sel:complete:BuildBatch', buildBatch_complete - Indicates if the batch build is complete.
BuildBatchFilter
data BuildBatchFilter Source #
Specifies filters when retrieving batch builds.
See: newBuildBatchFilter smart constructor.
Constructors
| BuildBatchFilter' (Maybe StatusType) |
Instances
newBuildBatchFilter :: BuildBatchFilter Source #
Create a value of BuildBatchFilter 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:status:BuildBatchFilter', buildBatchFilter_status - The status of the batch builds to retrieve. Only batch builds that have
this status will be retrieved.
BuildBatchPhase
data BuildBatchPhase Source #
Contains information about a stage for a batch build.
See: newBuildBatchPhase smart constructor.
Constructors
| BuildBatchPhase' (Maybe [PhaseContext]) (Maybe POSIX) (Maybe StatusType) (Maybe BuildBatchPhaseType) (Maybe POSIX) (Maybe Integer) |
Instances
newBuildBatchPhase :: BuildBatchPhase Source #
Create a value of BuildBatchPhase 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:contexts:BuildBatchPhase', buildBatchPhase_contexts - Additional information about the batch build phase. Especially to help
troubleshoot a failed batch build.
$sel:startTime:BuildBatchPhase', buildBatchPhase_startTime - When the batch build phase started, expressed in Unix time format.
$sel:phaseStatus:BuildBatchPhase', buildBatchPhase_phaseStatus - The current status of the batch build phase. Valid values include:
- FAILED
- The build phase failed.
- FAULT
- The build phase faulted.
- IN_PROGRESS
- The build phase is still in progress.
- STOPPED
- The build phase stopped.
- SUCCEEDED
- The build phase succeeded.
- TIMED_OUT
- The build phase timed out.
$sel:phaseType:BuildBatchPhase', buildBatchPhase_phaseType - The name of the batch build phase. Valid values include:
- COMBINE_ARTIFACTS
- Build output artifacts are being combined and uploaded to the output location.
- DOWNLOAD_BATCHSPEC
- The batch build specification is being downloaded.
- FAILED
- One or more of the builds failed.
- IN_PROGRESS
- The batch build is in progress.
- STOPPED
- The batch build was stopped.
- SUBMITTED
- The btach build has been submitted.
- SUCCEEDED
- The batch build succeeded.
$sel:endTime:BuildBatchPhase', buildBatchPhase_endTime - When the batch build phase ended, expressed in Unix time format.
$sel:durationInSeconds:BuildBatchPhase', buildBatchPhase_durationInSeconds - How long, in seconds, between the starting and ending times of the batch
build's phase.
BuildGroup
data BuildGroup Source #
Contains information about a batch build build group. Build groups are used to combine builds that can run in parallel, while still being able to set dependencies on other build groups.
See: newBuildGroup smart constructor.
Constructors
| BuildGroup' (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe BuildSummary) (Maybe [BuildSummary]) |
Instances
newBuildGroup :: BuildGroup Source #
Create a value of BuildGroup 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:identifier:BuildGroup', buildGroup_identifier - Contains the identifier of the build group.
$sel:dependsOn:BuildGroup', buildGroup_dependsOn - An array of strings that contain the identifiers of the build groups
that this build group depends on.
$sel:ignoreFailure:BuildGroup', buildGroup_ignoreFailure - Specifies if failures in this build group can be ignored.
$sel:currentBuildSummary:BuildGroup', buildGroup_currentBuildSummary - A BuildSummary object that contains a summary of the current build
group.
$sel:priorBuildSummaryList:BuildGroup', buildGroup_priorBuildSummaryList - An array of BuildSummary objects that contain summaries of previous
build groups.
BuildNotDeleted
data BuildNotDeleted Source #
Information about a build that could not be successfully deleted.
See: newBuildNotDeleted smart constructor.
Constructors
| BuildNotDeleted' (Maybe Text) (Maybe Text) |
Instances
newBuildNotDeleted :: BuildNotDeleted Source #
Create a value of BuildNotDeleted 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:BuildNotDeleted', buildNotDeleted_id - The ID of the build that could not be successfully deleted.
$sel:statusCode:BuildNotDeleted', buildNotDeleted_statusCode - Additional information about the build that could not be successfully
deleted.
BuildPhase
data BuildPhase Source #
Information about a stage for a build.
See: newBuildPhase smart constructor.
Constructors
| BuildPhase' (Maybe [PhaseContext]) (Maybe POSIX) (Maybe StatusType) (Maybe BuildPhaseType) (Maybe POSIX) (Maybe Integer) |
Instances
newBuildPhase :: BuildPhase Source #
Create a value of BuildPhase 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:contexts:BuildPhase', buildPhase_contexts - Additional information about a build phase, especially to help
troubleshoot a failed build.
$sel:startTime:BuildPhase', buildPhase_startTime - When the build phase started, expressed in Unix time format.
$sel:phaseStatus:BuildPhase', buildPhase_phaseStatus - The current status of the build phase. Valid values include:
- FAILED
- The build phase failed.
- FAULT
- The build phase faulted.
- IN_PROGRESS
- The build phase is still in progress.
- STOPPED
- The build phase stopped.
- SUCCEEDED
- The build phase succeeded.
- TIMED_OUT
- The build phase timed out.
$sel:phaseType:BuildPhase', buildPhase_phaseType - The name of the build phase. Valid values include:
- BUILD
- Core build activities typically occur in this build phase.
- COMPLETED
- The build has been completed.
- DOWNLOAD_SOURCE
- Source code is being downloaded in this build phase.
- FINALIZING
- The build process is completing in this build phase.
- INSTALL
- Installation activities typically occur in this build phase.
- POST_BUILD
- Post-build activities typically occur in this build phase.
- PRE_BUILD
- Pre-build activities typically occur in this build phase.
- PROVISIONING
- The build environment is being set up.
- QUEUED
- The build has been submitted and is queued behind other submitted builds.
- SUBMITTED
- The build has been submitted.
- UPLOAD_ARTIFACTS
- Build output artifacts are being uploaded to the output location.
$sel:endTime:BuildPhase', buildPhase_endTime - When the build phase ended, expressed in Unix time format.
$sel:durationInSeconds:BuildPhase', buildPhase_durationInSeconds - How long, in seconds, between the starting and ending times of the
build's phase.
BuildStatusConfig
data BuildStatusConfig Source #
Contains information that defines how the CodeBuild build project reports the build status to the source provider.
See: newBuildStatusConfig smart constructor.
Constructors
| BuildStatusConfig' (Maybe Text) (Maybe Text) |
Instances
newBuildStatusConfig :: BuildStatusConfig Source #
Create a value of BuildStatusConfig 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:context:BuildStatusConfig', buildStatusConfig_context - Specifies the context of the build status CodeBuild sends to the source
provider. The usage of this parameter depends on the source provider.
- Bitbucket
- This parameter is used for the
nameparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server
- This parameter is used for the
contextparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
$sel:targetUrl:BuildStatusConfig', buildStatusConfig_targetUrl - Specifies the target url of the build status CodeBuild sends to the
source provider. The usage of this parameter depends on the source
provider.
- Bitbucket
- This parameter is used for the
urlparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server
- This parameter is used for the
target_urlparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
BuildSummary
data BuildSummary Source #
Contains summary information about a batch build group.
See: newBuildSummary smart constructor.
Constructors
| BuildSummary' (Maybe [ResolvedArtifact]) (Maybe ResolvedArtifact) (Maybe Text) (Maybe StatusType) (Maybe POSIX) |
Instances
newBuildSummary :: BuildSummary Source #
Create a value of BuildSummary 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:secondaryArtifacts:BuildSummary', buildSummary_secondaryArtifacts - An array of ResolvedArtifact objects that represents the secondary
build artifacts for the build group.
$sel:primaryArtifact:BuildSummary', buildSummary_primaryArtifact - A ResolvedArtifact object that represents the primary build artifacts
for the build group.
$sel:arn:BuildSummary', buildSummary_arn - The batch build ARN.
$sel:buildStatus:BuildSummary', buildSummary_buildStatus - The status of the build group.
- FAILED
- The build group failed.
- FAULT
- The build group faulted.
- IN_PROGRESS
- The build group is still in progress.
- STOPPED
- The build group stopped.
- SUCCEEDED
- The build group succeeded.
- TIMED_OUT
- The build group timed out.
$sel:requestedOn:BuildSummary', buildSummary_requestedOn - When the build was started, expressed in Unix time format.
CloudWatchLogsConfig
data CloudWatchLogsConfig Source #
Information about CloudWatch Logs for a build project.
See: newCloudWatchLogsConfig smart constructor.
Constructors
| CloudWatchLogsConfig' (Maybe Text) (Maybe Text) LogsConfigStatusType |
Instances
newCloudWatchLogsConfig Source #
Create a value of CloudWatchLogsConfig 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:groupName:CloudWatchLogsConfig', cloudWatchLogsConfig_groupName - The group name of the logs in CloudWatch Logs. For more information, see
Working with Log Groups and Log Streams.
$sel:streamName:CloudWatchLogsConfig', cloudWatchLogsConfig_streamName - The prefix of the stream name of the CloudWatch Logs. For more
information, see
Working with Log Groups and Log Streams.
$sel:status:CloudWatchLogsConfig', cloudWatchLogsConfig_status - The current status of the logs in CloudWatch Logs for a build project.
Valid values are:
ENABLED: CloudWatch Logs are enabled for this build project.DISABLED: CloudWatch Logs are not enabled for this build project.
CodeCoverage
data CodeCoverage Source #
Contains code coverage report information.
Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.
Branch coverage determines if your tests cover every possible branch of
a control structure, such as an if or case statement.
See: newCodeCoverage smart constructor.
Constructors
| CodeCoverage' (Maybe POSIX) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Double) (Maybe Text) (Maybe Double) (Maybe Text) |
Instances
newCodeCoverage :: CodeCoverage Source #
Create a value of CodeCoverage 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:expired:CodeCoverage', codeCoverage_expired - The date and time that the tests were run.
$sel:branchesMissed:CodeCoverage', codeCoverage_branchesMissed - The number of conditional branches that are not covered by your tests.
$sel:linesMissed:CodeCoverage', codeCoverage_linesMissed - The number of lines that are not covered by your tests.
$sel:filePath:CodeCoverage', codeCoverage_filePath - The path of the test report file.
$sel:branchesCovered:CodeCoverage', codeCoverage_branchesCovered - The number of conditional branches that are covered by your tests.
$sel:linesCovered:CodeCoverage', codeCoverage_linesCovered - The number of lines that are covered by your tests.
$sel:branchCoveragePercentage:CodeCoverage', codeCoverage_branchCoveragePercentage - The percentage of branches that are covered by your tests.
$sel:id:CodeCoverage', codeCoverage_id - The identifier of the code coverage report.
$sel:lineCoveragePercentage:CodeCoverage', codeCoverage_lineCoveragePercentage - The percentage of lines that are covered by your tests.
$sel:reportARN:CodeCoverage', codeCoverage_reportARN - The ARN of the report.
CodeCoverageReportSummary
data CodeCoverageReportSummary Source #
Contains a summary of a code coverage report.
Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.
Branch coverage determines if your tests cover every possible branch of
a control structure, such as an if or case statement.
See: newCodeCoverageReportSummary smart constructor.
Constructors
| CodeCoverageReportSummary' (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Double) (Maybe Double) |
Instances
newCodeCoverageReportSummary :: CodeCoverageReportSummary Source #
Create a value of CodeCoverageReportSummary 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:branchesMissed:CodeCoverageReportSummary', codeCoverageReportSummary_branchesMissed - The number of conditional branches that are not covered by your tests.
$sel:linesMissed:CodeCoverageReportSummary', codeCoverageReportSummary_linesMissed - The number of lines that are not covered by your tests.
$sel:branchesCovered:CodeCoverageReportSummary', codeCoverageReportSummary_branchesCovered - The number of conditional branches that are covered by your tests.
$sel:linesCovered:CodeCoverageReportSummary', codeCoverageReportSummary_linesCovered - The number of lines that are covered by your tests.
$sel:branchCoveragePercentage:CodeCoverageReportSummary', codeCoverageReportSummary_branchCoveragePercentage - The percentage of branches that are covered by your tests.
$sel:lineCoveragePercentage:CodeCoverageReportSummary', codeCoverageReportSummary_lineCoveragePercentage - The percentage of lines that are covered by your tests.
DebugSession
data DebugSession Source #
Contains information about the debug session for a build. For more information, see Viewing a running build in Session Manager.
See: newDebugSession smart constructor.
Constructors
| DebugSession' (Maybe Bool) (Maybe Text) |
Instances
newDebugSession :: DebugSession Source #
Create a value of DebugSession 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:sessionEnabled:DebugSession', debugSession_sessionEnabled - Specifies if session debugging is enabled for this build.
$sel:sessionTarget:DebugSession', debugSession_sessionTarget - Contains the identifier of the Session Manager session used for the
build. To work with the paused build, you open this session to examine,
control, and resume the build.
EnvironmentImage
data EnvironmentImage Source #
Information about a Docker image that is managed by CodeBuild.
See: newEnvironmentImage smart constructor.
Instances
newEnvironmentImage :: EnvironmentImage Source #
Create a value of EnvironmentImage 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:versions:EnvironmentImage', environmentImage_versions - A list of environment image versions.
$sel:name:EnvironmentImage', environmentImage_name - The name of the Docker image.
$sel:description:EnvironmentImage', environmentImage_description - The description of the Docker image.
EnvironmentLanguage
data EnvironmentLanguage Source #
A set of Docker images that are related by programming language and are managed by CodeBuild.
See: newEnvironmentLanguage smart constructor.
Constructors
| EnvironmentLanguage' (Maybe [EnvironmentImage]) (Maybe LanguageType) |
Instances
newEnvironmentLanguage :: EnvironmentLanguage Source #
Create a value of EnvironmentLanguage 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:images:EnvironmentLanguage', environmentLanguage_images - The list of Docker images that are related by the specified programming
language.
$sel:language:EnvironmentLanguage', environmentLanguage_language - The programming language for the Docker images.
EnvironmentPlatform
data EnvironmentPlatform Source #
A set of Docker images that are related by platform and are managed by CodeBuild.
See: newEnvironmentPlatform smart constructor.
Constructors
| EnvironmentPlatform' (Maybe PlatformType) (Maybe [EnvironmentLanguage]) |
Instances
newEnvironmentPlatform :: EnvironmentPlatform Source #
Create a value of EnvironmentPlatform 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:platform:EnvironmentPlatform', environmentPlatform_platform - The platform's name.
$sel:languages:EnvironmentPlatform', environmentPlatform_languages - The list of programming languages that are available for the specified
platform.
EnvironmentVariable
data EnvironmentVariable Source #
Information about an environment variable for a build project or a build.
See: newEnvironmentVariable smart constructor.
Constructors
| EnvironmentVariable' (Maybe EnvironmentVariableType) Text Text |
Instances
newEnvironmentVariable Source #
Arguments
| :: Text | |
| -> Text | |
| -> EnvironmentVariable |
Create a value of EnvironmentVariable 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:type':EnvironmentVariable', environmentVariable_type - The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the CodeBuild User Guide.PLAINTEXT: An environment variable in plain text format. This is the default value.SECRETS_MANAGER: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the CodeBuild User Guide.
$sel:name:EnvironmentVariable', environmentVariable_name - The name or key of the environment variable.
$sel:value:EnvironmentVariable', environmentVariable_value - The value of the environment variable.
We strongly discourage the use of PLAINTEXT environment variables to
store sensitive values, especially Amazon Web Services secret key IDs
and secret access keys. PLAINTEXT environment variables can be
displayed in plain text using the CodeBuild console and the CLI. For
sensitive values, we recommend you use an environment variable of type
PARAMETER_STORE or SECRETS_MANAGER.
ExportedEnvironmentVariable
data ExportedEnvironmentVariable Source #
Contains information about an exported environment variable.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
During a build, the value of a variable is available starting with the
install phase. It can be updated between the start of the install
phase and the end of the post_build phase. After the post_build
phase ends, the value of exported variables cannot change.
See: newExportedEnvironmentVariable smart constructor.
Constructors
| ExportedEnvironmentVariable' (Maybe Text) (Maybe Text) |
Instances
newExportedEnvironmentVariable :: ExportedEnvironmentVariable Source #
Create a value of ExportedEnvironmentVariable 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:value:ExportedEnvironmentVariable', exportedEnvironmentVariable_value - The value assigned to the exported environment variable.
$sel:name:ExportedEnvironmentVariable', exportedEnvironmentVariable_name - The name of the exported environment variable.
GitSubmodulesConfig
data GitSubmodulesConfig Source #
Information about the Git submodules configuration for an CodeBuild build project.
See: newGitSubmodulesConfig smart constructor.
Constructors
| GitSubmodulesConfig' Bool |
Instances
newGitSubmodulesConfig Source #
Create a value of GitSubmodulesConfig 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:fetchSubmodules:GitSubmodulesConfig', gitSubmodulesConfig_fetchSubmodules - Set to true to fetch Git submodules for your CodeBuild build project.
LogsConfig
data LogsConfig Source #
Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both.
See: newLogsConfig smart constructor.
Constructors
| LogsConfig' (Maybe S3LogsConfig) (Maybe CloudWatchLogsConfig) |
Instances
newLogsConfig :: LogsConfig Source #
Create a value of LogsConfig 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:s3Logs:LogsConfig', logsConfig_s3Logs - Information about logs built to an S3 bucket for a build project. S3
logs are not enabled by default.
$sel:cloudWatchLogs:LogsConfig', logsConfig_cloudWatchLogs - Information about CloudWatch Logs for a build project. CloudWatch Logs
are enabled by default.
LogsLocation
data LogsLocation Source #
Information about build logs in CloudWatch Logs.
See: newLogsLocation smart constructor.
Constructors
| LogsLocation' (Maybe Text) (Maybe S3LogsConfig) (Maybe CloudWatchLogsConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newLogsLocation :: LogsLocation Source #
Create a value of LogsLocation 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:deepLink:LogsLocation', logsLocation_deepLink - The URL to an individual build log in CloudWatch Logs.
$sel:s3Logs:LogsLocation', logsLocation_s3Logs - Information about S3 logs for a build project.
$sel:cloudWatchLogs:LogsLocation', logsLocation_cloudWatchLogs - Information about CloudWatch Logs for a build project.
$sel:s3DeepLink:LogsLocation', logsLocation_s3DeepLink - The URL to a build log in an S3 bucket.
$sel:s3LogsArn:LogsLocation', logsLocation_s3LogsArn - The ARN of S3 logs for a build project. Its format is
arn:${Partition}:s3:::${BucketName}/${ObjectName}. For more
information, see
Resources Defined by Amazon S3.
$sel:cloudWatchLogsArn:LogsLocation', logsLocation_cloudWatchLogsArn - The ARN of CloudWatch Logs for a build project. Its format is
arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}.
For more information, see
Resources Defined by CloudWatch Logs.
$sel:groupName:LogsLocation', logsLocation_groupName - The name of the CloudWatch Logs group for the build logs.
$sel:streamName:LogsLocation', logsLocation_streamName - The name of the CloudWatch Logs stream for the build logs.
NetworkInterface
data NetworkInterface Source #
Describes a network interface.
See: newNetworkInterface smart constructor.
Constructors
| NetworkInterface' (Maybe Text) (Maybe Text) |
Instances
newNetworkInterface :: NetworkInterface Source #
Create a value of NetworkInterface 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:subnetId:NetworkInterface', networkInterface_subnetId - The ID of the subnet.
$sel:networkInterfaceId:NetworkInterface', networkInterface_networkInterfaceId - The ID of the network interface.
PhaseContext
data PhaseContext Source #
Additional information about a build phase that has an error. You can use this information for troubleshooting.
See: newPhaseContext smart constructor.
Constructors
| PhaseContext' (Maybe Text) (Maybe Text) |
Instances
newPhaseContext :: PhaseContext Source #
Create a value of PhaseContext 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:message:PhaseContext', phaseContext_message - An explanation of the build phase's context. This might include a
command ID and an exit code.
$sel:statusCode:PhaseContext', phaseContext_statusCode - The status code for the context of the build phase.
Project
Information about a build project.
See: newProject smart constructor.
Constructors
| Project' (Maybe [ProjectArtifacts]) (Maybe Text) (Maybe Text) (Maybe ProjectArtifacts) (Maybe ProjectEnvironment) (Maybe POSIX) (Maybe Int) (Maybe [ProjectSourceVersion]) (Maybe Natural) (Maybe ProjectCache) (Maybe [ProjectSource]) (Maybe Text) (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe ProjectSource) (Maybe ProjectBadge) (Maybe LogsConfig) (Maybe [ProjectFileSystemLocation]) (Maybe ProjectBuildBatchConfig) (Maybe Text) (Maybe POSIX) (Maybe ProjectVisibilityType) (Maybe Webhook) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Natural) |
Instances
newProject :: Project Source #
Create a value of Project 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:secondaryArtifacts:Project', project_secondaryArtifacts - An array of ProjectArtifacts objects.
$sel:resourceAccessRole:Project', project_resourceAccessRole - The ARN of the IAM role that enables CodeBuild to access the CloudWatch
Logs and Amazon S3 artifacts for the project's builds.
$sel:arn:Project', project_arn - The Amazon Resource Name (ARN) of the build project.
$sel:artifacts:Project', project_artifacts - Information about the build output artifacts for the build project.
$sel:environment:Project', project_environment - Information about the build environment for this build project.
$sel:created:Project', project_created - When the build project was created, expressed in Unix time format.
$sel:concurrentBuildLimit:Project', project_concurrentBuildLimit - The maximum number of concurrent builds that are allowed for this
project.
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
$sel:secondarySourceVersions:Project', project_secondarySourceVersions - An array of ProjectSourceVersion objects. If secondarySourceVersions
is specified at the build level, then they take over these
secondarySourceVersions (at the project level).
$sel:queuedTimeoutInMinutes:Project', project_queuedTimeoutInMinutes - The number of minutes a build is allowed to be queued before it times
out.
$sel:cache:Project', project_cache - Information about the cache for the build project.
$sel:secondarySources:Project', project_secondarySources - An array of ProjectSource objects.
$sel:sourceVersion:Project', project_sourceVersion - A version of the build input to be built for this project. If not
specified, the latest version is used. If specified, it must be one of:
- For CodeCommit: the commit ID, branch, or Git tag to use.
- For GitHub: the commit ID, pull request ID, branch name, or tag name
that corresponds to the version of the source code you want to
build. If a pull request ID is specified, it must use the format
pr/pull-request-ID(for examplepr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. - For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
- For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version
takes precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
$sel:name:Project', project_name - The name of the build project.
$sel:vpcConfig:Project', project_vpcConfig - Information about the VPC configuration that CodeBuild accesses.
$sel:publicProjectAlias:Project', project_publicProjectAlias - Contains the project identifier used with the public build APIs.
$sel:source:Project', project_source - Information about the build input source code for this build project.
$sel:badge:Project', project_badge - Information about the build badge for the build project.
$sel:logsConfig:Project', project_logsConfig - Information about logs for the build project. A project can create logs
in CloudWatch Logs, an S3 bucket, or both.
$sel:fileSystemLocations:Project', project_fileSystemLocations - An array of ProjectFileSystemLocation objects for a CodeBuild build
project. A ProjectFileSystemLocation object specifies the
identifier, location, mountOptions, mountPoint, and type of a
file system created using Amazon Elastic File System.
$sel:buildBatchConfig:Project', project_buildBatchConfig - A ProjectBuildBatchConfig object that defines the batch build options
for the project.
$sel:encryptionKey:Project', project_encryptionKey - The Key Management Service customer master key (CMK) to be used for
encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if
available, the CMK's alias (using the format alias/<alias-name>).
If you don't specify a value, CodeBuild uses the managed CMK for Amazon
Simple Storage Service (Amazon S3).
$sel:lastModified:Project', project_lastModified - When the build project's settings were last modified, expressed in Unix
time format.
$sel:projectVisibility:Project', project_projectVisibility - Undocumented member.
$sel:webhook:Project', project_webhook - Information about a webhook that connects repository events to a build
project in CodeBuild.
$sel:description:Project', project_description - A description that makes the build project easy to identify.
$sel:serviceRole:Project', project_serviceRole - The ARN of the IAM role that enables CodeBuild to interact with
dependent Amazon Web Services services on behalf of the Amazon Web
Services account.
$sel:tags:Project', project_tags - A list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
$sel:timeoutInMinutes:Project', project_timeoutInMinutes - How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait
before timing out any related build that did not get marked as
completed. The default is 60 minutes.
ProjectArtifacts
data ProjectArtifacts Source #
Information about the build output artifacts for the build project.
See: newProjectArtifacts smart constructor.
Constructors
| ProjectArtifacts' (Maybe ArtifactPackaging) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe BucketOwnerAccess) (Maybe ArtifactNamespace) ArtifactsType |
Instances
Arguments
| :: ArtifactsType | |
| -> ProjectArtifacts |
Create a value of ProjectArtifacts 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:packaging:ProjectArtifacts', projectArtifacts_packaging - The type of build output artifact to create:
- If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild. - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If
typeis set toS3, valid values include:NONE: CodeBuild creates in the output bucket a folder that contains the build output. This is the default ifpackagingis not specified.ZIP: CodeBuild creates in the output bucket a ZIP file that contains the build output.
$sel:path:ProjectArtifacts', projectArtifacts_path - Along with namespaceType and name, the pattern that CodeBuild uses
to name and store the output artifact:
- If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild. - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the path to the output artifact. Ifpathis not specified,pathis not used.
For example, if path is set to MyArtifacts, namespaceType is set
to NONE, and name is set to MyArtifact.zip, the output artifact is
stored in the output bucket at MyArtifacts/MyArtifact.zip.
$sel:location:ProjectArtifacts', projectArtifacts_location - Information about the build output artifact location:
- If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild. - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output bucket.
$sel:name:ProjectArtifacts', projectArtifacts_name - Along with path and namespaceType, the pattern that CodeBuild uses
to name and store the output artifact:
- If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild. - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.
For example:
- If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, then the output artifact is stored inMyArtifacts/<build-ID>/MyArtifact.zip. - If
pathis empty,namespaceTypeis set toNONE, andnameis set to "/", the output artifact is stored in the root of the output bucket. - If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set to "/", the output artifact is stored inMyArtifacts/<build-ID>.
$sel:encryptionDisabled:ProjectArtifacts', projectArtifacts_encryptionDisabled - Set to true if you do not want your output artifacts encrypted. This
option is valid only if your artifacts type is Amazon S3. If this is set
with another artifacts type, an invalidInputException is thrown.
$sel:overrideArtifactName:ProjectArtifacts', projectArtifacts_overrideArtifactName - If this flag is set, a name specified in the buildspec file overrides
the artifact name. The name specified in a buildspec file is calculated
at build time and uses the Shell Command Language. For example, you can
append a date and time to your artifact name so that it is always
unique.
$sel:artifactIdentifier:ProjectArtifacts', projectArtifacts_artifactIdentifier - An identifier for this artifact definition.
$sel:bucketOwnerAccess:ProjectArtifacts', projectArtifacts_bucketOwnerAccess - Undocumented member.
$sel:namespaceType:ProjectArtifacts', projectArtifacts_namespaceType - Along with path and name, the pattern that CodeBuild uses to
determine the name and location to store the output artifact:
- If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild. - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If
typeis set toS3, valid values include:BUILD_ID: Include the build ID in the location of the build output artifact.NONE: Do not include the build ID. This is the default ifnamespaceTypeis not specified.
For example, if path is set to MyArtifacts, namespaceType is set
to BUILD_ID, and name is set to MyArtifact.zip, the output
artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
$sel:type':ProjectArtifacts', projectArtifacts_type - The type of build output artifact. Valid values include:
CODEPIPELINE: The build project has build output generated through CodePipeline.The
CODEPIPELINEtype is not supported forsecondaryArtifacts.NO_ARTIFACTS: The build project does not produce any build output.S3: The build project stores build output in Amazon S3.
ProjectBadge
data ProjectBadge Source #
Information about the build badge for the build project.
See: newProjectBadge smart constructor.
Constructors
| ProjectBadge' (Maybe Bool) (Maybe Text) |
Instances
newProjectBadge :: ProjectBadge Source #
Create a value of ProjectBadge 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:badgeEnabled:ProjectBadge', projectBadge_badgeEnabled - Set this to true to generate a publicly accessible URL for your
project's build badge.
$sel:badgeRequestUrl:ProjectBadge', projectBadge_badgeRequestUrl - The publicly-accessible URL through which you can access the build badge
for your project.
ProjectBuildBatchConfig
data ProjectBuildBatchConfig Source #
Contains configuration information about a batch build project.
See: newProjectBuildBatchConfig smart constructor.
Constructors
| ProjectBuildBatchConfig' (Maybe Bool) (Maybe Int) (Maybe BatchRestrictions) (Maybe BatchReportModeType) (Maybe Text) |
Instances
newProjectBuildBatchConfig :: ProjectBuildBatchConfig Source #
Create a value of ProjectBuildBatchConfig 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:combineArtifacts:ProjectBuildBatchConfig', projectBuildBatchConfig_combineArtifacts - Specifies if the build artifacts for the batch build should be combined
into a single artifact location.
$sel:timeoutInMins:ProjectBuildBatchConfig', projectBuildBatchConfig_timeoutInMins - Specifies the maximum amount of time, in minutes, that the batch build
must be completed in.
$sel:restrictions:ProjectBuildBatchConfig', projectBuildBatchConfig_restrictions - A BatchRestrictions object that specifies the restrictions for the
batch build.
$sel:batchReportMode:ProjectBuildBatchConfig', projectBuildBatchConfig_batchReportMode - Specifies how build status reports are sent to the source provider for
the batch build. This property is only used when the source provider for
your project is Bitbucket, GitHub, or GitHub Enterprise, and your
project is configured to report build statuses to the source provider.
REPORT_AGGREGATED_BATCH Aggregate all of the build statuses into a single status report.
- REPORT_INDIVIDUAL_BUILDS
- Send a separate status report for each individual build.
$sel:serviceRole:ProjectBuildBatchConfig', projectBuildBatchConfig_serviceRole - Specifies the service role ARN for the batch build project.
ProjectCache
data ProjectCache Source #
Information about the cache for the build project.
See: newProjectCache smart constructor.
Instances
Arguments
| :: CacheType | |
| -> ProjectCache |
Create a value of ProjectCache 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:location:ProjectCache', projectCache_location - Information about the cache location:
NO_CACHEorLOCAL: This value is ignored.S3: This is the S3 bucket name/prefix.
$sel:modes:ProjectCache', projectCache_modes - An array of strings that specify the local cache modes. You can use one
or more local cache modes at the same time. This is only used for
LOCAL cache types.
Possible values are:
- LOCAL_SOURCE_CACHE
- Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
- LOCAL_DOCKER_LAYER_CACHE
- Caches existing Docker layers. This mode is a good choice for
projects that build or pull large Docker images. It can prevent the
performance issues caused by pulling large Docker images down from
the network.
- You can use a Docker layer cache in the Linux environment only.
- The
privilegedflag must be set so that your project has the required Docker permissions. - You should consider the security implications before you use a Docker layer cache.
- LOCAL_CUSTOM_CACHE
- Caches directories you specify in the buildspec file. This mode is a
good choice if your build scenario is not suited to one of the other
three local cache modes. If you use a custom cache:
- Only directories can be specified for caching. You cannot specify individual files.
- Symlinks are used to reference cached directories.
- Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
$sel:type':ProjectCache', projectCache_type - The type of cache used by the build project. Valid values include:
NO_CACHE: The build project does not use any cache.S3: The build project reads and writes from and to S3.LOCAL: The build project stores a cache locally on a build host that is only available to that build host.
ProjectEnvironment
data ProjectEnvironment Source #
Information about the build environment of the build project.
See: newProjectEnvironment smart constructor.
Constructors
| ProjectEnvironment' (Maybe ImagePullCredentialsType) (Maybe Bool) (Maybe RegistryCredential) (Maybe Text) (Maybe [EnvironmentVariable]) EnvironmentType Text ComputeType |
Instances
newProjectEnvironment Source #
Arguments
| :: EnvironmentType | |
| -> Text | |
| -> ComputeType | |
| -> ProjectEnvironment |
Create a value of ProjectEnvironment 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:imagePullCredentialsType:ProjectEnvironment', projectEnvironment_imagePullCredentialsType - The type of credentials CodeBuild uses to pull images in your build.
There are two valid values:
CODEBUILDspecifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal.SERVICE_ROLEspecifies that CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.
$sel:privilegedMode:ProjectEnvironment', projectEnvironment_privilegedMode - Enables running the Docker daemon inside a Docker container. Set to true
only if the build project is used to build Docker images. Otherwise, a
build that attempts to interact with the Docker daemon fails. The
default setting is false.
You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:
If the operating system's base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"
If the operating system's base image is Alpine Linux and the previous
command does not work, add the -t argument to timeout:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"
$sel:registryCredential:ProjectEnvironment', projectEnvironment_registryCredential - The credentials for access to a private registry.
$sel:certificate:ProjectEnvironment', projectEnvironment_certificate - The ARN of the Amazon S3 bucket, path prefix, and object key that
contains the PEM-encoded certificate for the build project. For more
information, see
certificate
in the CodeBuild User Guide.
$sel:environmentVariables:ProjectEnvironment', projectEnvironment_environmentVariables - A set of environment variables to make available to builds for this
build project.
$sel:type':ProjectEnvironment', projectEnvironment_type - The type of build environment to use for related builds.
- The environment type
ARM_CONTAINERis available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt). - The environment type
LINUX_CONTAINERwith compute typebuild.general1.2xlargeis available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia). - The environment type
LINUX_GPU_CONTAINERis available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia). - The environment types
WINDOWS_CONTAINERandWINDOWS_SERVER_2019_CONTAINERare available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).
For more information, see Build environment compute types in the CodeBuild user guide.
$sel:image:ProjectEnvironment', projectEnvironment_image - The image tag or image digest that identifies the Docker image to use
for this build project. Use the following formats:
- For an image tag:
<registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would beaws/codebuild/standard:4.0. - For an image digest:
<registry>/<repository>@<digest>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use<registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
For more information, see Docker images provided by CodeBuild in the CodeBuild user guide.
$sel:computeType:ProjectEnvironment', projectEnvironment_computeType - Information about the compute resources the build project uses.
Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
If you use BUILD_GENERAL1_LARGE:
- For environment type
LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. - For environment type
ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build Environment Compute Types in the CodeBuild User Guide.
ProjectFileSystemLocation
data ProjectFileSystemLocation Source #
Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?
See: newProjectFileSystemLocation smart constructor.
Constructors
| ProjectFileSystemLocation' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe FileSystemType) (Maybe Text) |
Instances
newProjectFileSystemLocation :: ProjectFileSystemLocation Source #
Create a value of ProjectFileSystemLocation 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:location:ProjectFileSystemLocation', projectFileSystemLocation_location - A string that specifies the location of the file system created by
Amazon EFS. Its format is efs-dns-name:/directory-path. You can find
the DNS name of file system when you view it in the Amazon EFS console.
The directory path is a path to a directory in the file system that
CodeBuild mounts. For example, if the DNS name of a file system is
fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is
my-efs-mount-directory, then the location is
fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.
The directory path in the format efs-dns-name:/directory-path is
optional. If you do not specify a directory path, the location is only
the DNS name and CodeBuild mounts the entire file system.
$sel:identifier:ProjectFileSystemLocation', projectFileSystemLocation_identifier - The name used to access a file system created by Amazon EFS. CodeBuild
creates an environment variable by appending the identifier in all
capital letters to CODEBUILD_. For example, if you specify my_efs
for identifier, a new environment variable is create named
CODEBUILD_MY_EFS.
The identifier is used to mount your file system.
$sel:mountOptions:ProjectFileSystemLocation', projectFileSystemLocation_mountOptions - The mount options for a file system created by Amazon EFS. The default
mount options used by CodeBuild are
nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For
more information, see
Recommended NFS Mount Options.
$sel:type':ProjectFileSystemLocation', projectFileSystemLocation_type - The type of the file system. The one supported type is EFS.
$sel:mountPoint:ProjectFileSystemLocation', projectFileSystemLocation_mountPoint - The location in the container where you mount the file system.
ProjectSource
data ProjectSource Source #
Information about the build input source code for the build project.
See: newProjectSource smart constructor.
Constructors
| ProjectSource' (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe SourceAuth) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe GitSubmodulesConfig) (Maybe BuildStatusConfig) SourceType |
Instances
Arguments
| :: SourceType | |
| -> ProjectSource |
Create a value of ProjectSource 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:reportBuildStatus:ProjectSource', projectSource_reportBuildStatus - Set to true to report the status of a build's start and finish to your
source provider. This option is valid only when your source provider is
GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a
different source provider, an invalidInputException is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
If your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.
$sel:insecureSsl:ProjectSource', projectSource_insecureSsl - Enable this flag to ignore SSL warnings while connecting to the project
source code.
$sel:location:ProjectSource', projectSource_location - Information about the location of the source code to be built. Valid
values include:
- For source code settings that are specified in the source action of
a pipeline in CodePipeline,
locationshould not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value. - For source code in an CodeCommit repository, the HTTPS clone URL to
the repository that contains the source code and the buildspec file
(for example,
https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>). For source code in an Amazon S3 input bucket, one of the following.
- The path to the ZIP file that contains the source code (for
example,
<bucket-name>/<path>/<object-name>.zip). - The path to the folder that contains the source code (for
example,
<bucket-name>/<path-to-source-code>/<folder>/).
- The path to the ZIP file that contains the source code (for
example,
- For source code in a GitHub repository, the HTTPS clone URL to the
repository that contains the source and the buildspec file. You must
connect your Amazon Web Services account to your GitHub account. Use
the CodeBuild console to start creating a build project. When you
use the console to connect (or reconnect) with GitHub, on the GitHub
Authorize application page, for Organization access, choose
Request access next to each repository you want to allow
CodeBuild to have access to, and then choose __Authorize
application__. (After you have connected to your GitHub account, you
do not need to finish creating the build project. You can leave the
CodeBuild console.) To instruct CodeBuild to use this connection, in
the
sourceobject, set theauthobject'stypevalue toOAUTH. - For source code in a Bitbucket repository, the HTTPS clone URL to
the repository that contains the source and the buildspec file. You
must connect your Amazon Web Services account to your Bitbucket
account. Use the CodeBuild console to start creating a build
project. When you use the console to connect (or reconnect) with
Bitbucket, on the Bitbucket Confirm access to your account page,
choose Grant access. (After you have connected to your Bitbucket
account, you do not need to finish creating the build project. You
can leave the CodeBuild console.) To instruct CodeBuild to use this
connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.
If you specify CODEPIPELINE for the Type property, don't specify
this property. For all of the other types, you must specify Location.
$sel:auth:ProjectSource', projectSource_auth - Information about the authorization settings for CodeBuild to access the
source code to be built.
This information is for the CodeBuild console's use only. Your code should not get or set this information directly.
$sel:buildspec:ProjectSource', projectSource_buildspec - The buildspec file declaration to use for the builds in this build
project.
If this value is set, it can be either an inline buildspec definition,
the path to an alternate buildspec file relative to the value of the
built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3
bucket. The bucket must be in the same Amazon Web Services Region as the
build project. Specify the buildspec file using its ARN (for example,
arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is
not provided or is set to an empty string, the source code must contain
a buildspec file in its root directory. For more information, see
Buildspec File Name and Storage Location.
$sel:sourceIdentifier:ProjectSource', projectSource_sourceIdentifier - An identifier for this project source. The identifier can only contain
alphanumeric characters and underscores, and must be less than 128
characters in length.
$sel:gitCloneDepth:ProjectSource', projectSource_gitCloneDepth - Information about the Git clone depth for the build project.
$sel:gitSubmodulesConfig:ProjectSource', projectSource_gitSubmodulesConfig - Information about the Git submodules configuration for the build
project.
$sel:buildStatusConfig:ProjectSource', projectSource_buildStatusConfig - Contains information that defines how the build project reports the
build status to the source provider. This option is only used when the
source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
$sel:type':ProjectSource', projectSource_type - The type of repository that contains the source code to be built. Valid
values include:
BITBUCKET: The source code is in a Bitbucket repository.CODECOMMIT: The source code is in an CodeCommit repository.CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.GITHUB: The source code is in a GitHub or GitHub Enterprise Cloud repository.GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.NO_SOURCE: The project does not have input source code.S3: The source code is in an Amazon S3 bucket.
ProjectSourceVersion
data ProjectSourceVersion Source #
A source identifier and its corresponding version.
See: newProjectSourceVersion smart constructor.
Constructors
| ProjectSourceVersion' Text Text |
Instances
newProjectSourceVersion Source #
Arguments
| :: Text | |
| -> Text | |
| -> ProjectSourceVersion |
Create a value of ProjectSourceVersion 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:sourceIdentifier:ProjectSourceVersion', projectSourceVersion_sourceIdentifier - An identifier for a source in the build project. The identifier can only
contain alphanumeric characters and underscores, and must be less than
128 characters in length.
$sel:sourceVersion:ProjectSourceVersion', projectSourceVersion_sourceVersion - The source version for the corresponding source identifier. If
specified, must be one of:
- For CodeCommit: the commit ID, branch, or Git tag to use.
- For GitHub: the commit ID, pull request ID, branch name, or tag name
that corresponds to the version of the source code you want to
build. If a pull request ID is specified, it must use the format
pr/pull-request-ID(for example,pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. - For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
- For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
RegistryCredential
data RegistryCredential Source #
Information about credentials that provide access to a private Docker registry. When this is set:
imagePullCredentialsTypemust be set toSERVICE_ROLE.- images cannot be curated or an Amazon ECR image.
For more information, see Private Registry with Secrets Manager Sample for CodeBuild.
See: newRegistryCredential smart constructor.
Constructors
| RegistryCredential' Text CredentialProviderType |
Instances
newRegistryCredential Source #
Arguments
| :: Text | |
| -> CredentialProviderType | |
| -> RegistryCredential |
Create a value of RegistryCredential 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:credential:RegistryCredential', registryCredential_credential - The Amazon Resource Name (ARN) or name of credentials created using
Secrets Manager.
The credential can use the name of the credentials only if they exist
in your current Amazon Web Services Region.
$sel:credentialProvider:RegistryCredential', registryCredential_credentialProvider - The service that created the credentials to access a private Docker
registry. The valid value, SECRETS_MANAGER, is for Secrets Manager.
Report
Information about the results from running a series of test cases during the run of a build project. The test cases are specified in the buildspec for the build project using one or more paths to the test case files. You can specify any type of tests you want, such as unit tests, integration tests, and functional tests.
See: newReport smart constructor.
Constructors
| Report' (Maybe Text) (Maybe ReportStatusType) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe CodeCoverageReportSummary) (Maybe TestReportSummary) (Maybe ReportType) (Maybe ReportExportConfig) |
Instances
Create a value of Report 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:reportGroupArn:Report', report_reportGroupArn - The ARN of the report group associated with this report.
$sel:status:Report', report_status - The status of this report.
$sel:expired:Report', report_expired - The date and time a report expires. A report expires 30 days after it is
created. An expired report is not available to view in CodeBuild.
$sel:executionId:Report', report_executionId - The ARN of the build run that generated this report.
$sel:truncated:Report', report_truncated - A boolean that specifies if this report run is truncated. The list of
test cases is truncated after the maximum number of test cases is
reached.
$sel:arn:Report', report_arn - The ARN of the report run.
$sel:created:Report', report_created - The date and time this report run occurred.
$sel:name:Report', report_name - The name of the report that was run.
$sel:codeCoverageSummary:Report', report_codeCoverageSummary - A CodeCoverageReportSummary object that contains a code coverage
summary for this report.
$sel:testSummary:Report', report_testSummary - A TestReportSummary object that contains information about this test
report.
$sel:type':Report', report_type - The type of the report that was run.
- CODE_COVERAGE
- A code coverage report.
- TEST
- A test report.
$sel:exportConfig:Report', report_exportConfig - Information about where the raw data used to generate this report was
exported.
ReportExportConfig
data ReportExportConfig Source #
Information about the location where the run of a report is exported.
See: newReportExportConfig smart constructor.
Constructors
| ReportExportConfig' (Maybe ReportExportConfigType) (Maybe S3ReportExportConfig) |
Instances
newReportExportConfig :: ReportExportConfig Source #
Create a value of ReportExportConfig 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:exportConfigType:ReportExportConfig', reportExportConfig_exportConfigType - The export configuration type. Valid values are:
S3: The report results are exported to an S3 bucket.NO_EXPORT: The report results are not exported.
$sel:s3Destination:ReportExportConfig', reportExportConfig_s3Destination - A S3ReportExportConfig object that contains information about the S3
bucket where the run of a report is exported.
ReportFilter
data ReportFilter Source #
A filter used to return reports with the status specified by the input
status parameter.
See: newReportFilter smart constructor.
Constructors
| ReportFilter' (Maybe ReportStatusType) |
Instances
newReportFilter :: ReportFilter Source #
Create a value of ReportFilter 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:status:ReportFilter', reportFilter_status - The status used to filter reports. You can filter using one status only.
ReportGroup
data ReportGroup Source #
A series of reports. Each report contains information about the results from running a series of test cases. You specify the test cases for a report group in the buildspec for a build project using one or more paths to the test case files.
See: newReportGroup smart constructor.
Constructors
| ReportGroup' (Maybe ReportGroupStatusType) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ReportType) (Maybe POSIX) (Maybe ReportExportConfig) (Maybe [Tag]) |
Instances
newReportGroup :: ReportGroup Source #
Create a value of ReportGroup 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:status:ReportGroup', reportGroup_status - The status of the report group. This property is read-only.
This can be one of the following values:
- ACTIVE
- The report group is active.
- DELETING
- The report group is in the process of being deleted.
$sel:arn:ReportGroup', reportGroup_arn - The ARN of the ReportGroup.
$sel:created:ReportGroup', reportGroup_created - The date and time this ReportGroup was created.
$sel:name:ReportGroup', reportGroup_name - The name of the ReportGroup.
$sel:type':ReportGroup', reportGroup_type - The type of the ReportGroup. This can be one of the following values:
- CODE_COVERAGE
- The report group contains code coverage reports.
- TEST
- The report group contains test reports.
$sel:lastModified:ReportGroup', reportGroup_lastModified - The date and time this ReportGroup was last modified.
$sel:exportConfig:ReportGroup', reportGroup_exportConfig - Information about the destination where the raw data of this
ReportGroup is exported.
$sel:tags:ReportGroup', reportGroup_tags - A list of tag key and value pairs associated with this report group.
These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
ReportGroupTrendStats
data ReportGroupTrendStats Source #
Contains trend statistics for a set of reports. The actual values depend on the type of trend being collected. For more information, see .
See: newReportGroupTrendStats smart constructor.
Instances
newReportGroupTrendStats :: ReportGroupTrendStats Source #
Create a value of ReportGroupTrendStats 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:max:ReportGroupTrendStats', reportGroupTrendStats_max - Contains the maximum value analyzed.
$sel:average:ReportGroupTrendStats', reportGroupTrendStats_average - Contains the average of all values analyzed.
$sel:min:ReportGroupTrendStats', reportGroupTrendStats_min - Contains the minimum value analyzed.
ReportWithRawData
data ReportWithRawData Source #
Contains the unmodified data for the report. For more information, see .
See: newReportWithRawData smart constructor.
Constructors
| ReportWithRawData' (Maybe Text) (Maybe Text) |
Instances
newReportWithRawData :: ReportWithRawData Source #
Create a value of ReportWithRawData 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:data':ReportWithRawData', reportWithRawData_data - The value of the requested data field from the report.
$sel:reportArn:ReportWithRawData', reportWithRawData_reportArn - The ARN of the report.
ResolvedArtifact
data ResolvedArtifact Source #
Represents a resolved build artifact. A resolved artifact is an artifact that is built and deployed to the destination, such as Amazon S3.
See: newResolvedArtifact smart constructor.
Constructors
| ResolvedArtifact' (Maybe Text) (Maybe Text) (Maybe ArtifactsType) |
Instances
newResolvedArtifact :: ResolvedArtifact Source #
Create a value of ResolvedArtifact 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:location:ResolvedArtifact', resolvedArtifact_location - The location of the artifact.
$sel:identifier:ResolvedArtifact', resolvedArtifact_identifier - The identifier of the artifact.
$sel:type':ResolvedArtifact', resolvedArtifact_type - Specifies the type of artifact.
S3LogsConfig
data S3LogsConfig Source #
Information about S3 logs for a build project.
See: newS3LogsConfig smart constructor.
Constructors
| S3LogsConfig' (Maybe Text) (Maybe Bool) (Maybe BucketOwnerAccess) LogsConfigStatusType |
Instances
Arguments
| :: LogsConfigStatusType | |
| -> S3LogsConfig |
Create a value of S3LogsConfig 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:location:S3LogsConfig', s3LogsConfig_location - The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon
S3 bucket name is my-bucket, and your path prefix is build-log, then
acceptable formats are my-bucket/build-log or
arn:aws:s3:::my-bucket/build-log.
$sel:encryptionDisabled:S3LogsConfig', s3LogsConfig_encryptionDisabled - Set to true if you do not want your S3 build log output encrypted. By
default S3 build logs are encrypted.
$sel:bucketOwnerAccess:S3LogsConfig', s3LogsConfig_bucketOwnerAccess - Undocumented member.
$sel:status:S3LogsConfig', s3LogsConfig_status - The current status of the S3 build logs. Valid values are:
ENABLED: S3 build logs are enabled for this build project.DISABLED: S3 build logs are not enabled for this build project.
S3ReportExportConfig
data S3ReportExportConfig Source #
Information about the S3 bucket where the raw data of a report are exported.
See: newS3ReportExportConfig smart constructor.
Constructors
| S3ReportExportConfig' (Maybe ReportPackagingType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) |
Instances
newS3ReportExportConfig :: S3ReportExportConfig Source #
Create a value of S3ReportExportConfig 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:packaging:S3ReportExportConfig', s3ReportExportConfig_packaging - The type of build output artifact to create. Valid values include:
NONE: CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.ZIP: CodeBuild creates a ZIP file with the raw data in the output bucket.
$sel:path:S3ReportExportConfig', s3ReportExportConfig_path - The path to the exported report's raw data results.
$sel:bucket:S3ReportExportConfig', s3ReportExportConfig_bucket - The name of the S3 bucket where the raw data of a report are exported.
$sel:bucketOwner:S3ReportExportConfig', s3ReportExportConfig_bucketOwner - The Amazon Web Services account identifier of the owner of the Amazon S3
bucket. This allows report data to be exported to an Amazon S3 bucket
that is owned by an account other than the account running the build.
$sel:encryptionDisabled:S3ReportExportConfig', s3ReportExportConfig_encryptionDisabled - A boolean value that specifies if the results of a report are encrypted.
$sel:encryptionKey:S3ReportExportConfig', s3ReportExportConfig_encryptionKey - The encryption key for the report's encrypted raw data.
SourceAuth
data SourceAuth Source #
Information about the authorization settings for CodeBuild to access the source code to be built.
This information is for the CodeBuild console's use only. Your code should not get or set this information directly.
See: newSourceAuth smart constructor.
Constructors
| SourceAuth' (Maybe Text) SourceAuthType |
Instances
Arguments
| :: SourceAuthType | |
| -> SourceAuth |
Create a value of SourceAuth 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:resource:SourceAuth', sourceAuth_resource - The resource value that applies to the specified authorization type.
$sel:type':SourceAuth', sourceAuth_type - This data type is deprecated and is no longer accurate or used.
The authorization type to use. The only valid value is OAUTH, which
represents the OAuth authorization type.
SourceCredentialsInfo
data SourceCredentialsInfo Source #
Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository.
See: newSourceCredentialsInfo smart constructor.
Constructors
| SourceCredentialsInfo' (Maybe Text) (Maybe ServerType) (Maybe AuthType) |
Instances
newSourceCredentialsInfo :: SourceCredentialsInfo Source #
Create a value of SourceCredentialsInfo 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:SourceCredentialsInfo', sourceCredentialsInfo_arn - The Amazon Resource Name (ARN) of the token.
$sel:serverType:SourceCredentialsInfo', sourceCredentialsInfo_serverType - The type of source provider. The valid options are GITHUB,
GITHUB_ENTERPRISE, or BITBUCKET.
$sel:authType:SourceCredentialsInfo', sourceCredentialsInfo_authType - The type of authentication used by the credentials. Valid options are
OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.
Tag
A tag, consisting of a key and a value.
This tag is available for use by Amazon Web Services services that support tags in CodeBuild.
See: newTag smart constructor.
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.CodeBuild.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.CodeBuild.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.CodeBuild.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.CodeBuild.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CodeBuild.Types.Tag" "libZSservicesZSamazonka-codebuildZSamazonka-codebuild" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Tag 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:value:Tag', tag_value - The tag's value.
$sel:key:Tag', tag_key - The tag's key.
TestCase
Information about a test case created using a framework such as NUnit or Cucumber. A test case might be a unit test or a configuration test.
See: newTestCase smart constructor.
Constructors
| TestCase' (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newTestCase :: TestCase Source #
Create a value of TestCase 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:durationInNanoSeconds:TestCase', testCase_durationInNanoSeconds - The number of nanoseconds it took to run this test case.
$sel:status:TestCase', testCase_status - The status returned by the test case after it was run. Valid statuses
are SUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN.
$sel:expired:TestCase', testCase_expired - The date and time a test case expires. A test case expires 30 days after
it is created. An expired test case is not available to view in
CodeBuild.
$sel:prefix:TestCase', testCase_prefix - A string that is applied to a series of related test cases. CodeBuild
generates the prefix. The prefix depends on the framework used to
generate the tests.
$sel:name:TestCase', testCase_name - The name of the test case.
$sel:testRawDataPath:TestCase', testCase_testRawDataPath - The path to the raw data file that contains the test result.
$sel:message:TestCase', testCase_message - A message associated with a test case. For example, an error message or
stack trace.
$sel:reportArn:TestCase', testCase_reportArn - The ARN of the report to which the test case belongs.
TestCaseFilter
data TestCaseFilter Source #
A filter used to return specific types of test cases. In order to pass the filter, the report must meet all of the filter properties.
See: newTestCaseFilter smart constructor.
Constructors
| TestCaseFilter' (Maybe Text) (Maybe Text) |
Instances
newTestCaseFilter :: TestCaseFilter Source #
Create a value of TestCaseFilter 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:status:TestCaseFilter', testCaseFilter_status - The status used to filter test cases. A TestCaseFilter can have one
status. Valid values are:
SUCCEEDED
FAILED
ERROR
SKIPPED
UNKNOWN
$sel:keyword:TestCaseFilter', testCaseFilter_keyword - A keyword that is used to filter on the name or the prefix of the
test cases. Only test cases where the keyword is a substring of the
name or the prefix will be returned.
TestReportSummary
data TestReportSummary Source #
Information about a test report.
See: newTestReportSummary smart constructor.
Instances
Arguments
| :: Int | |
| -> Integer | |
| -> TestReportSummary |
Create a value of TestReportSummary 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:total:TestReportSummary', testReportSummary_total - The number of test cases in this TestReportSummary. The total includes
truncated test cases.
$sel:statusCounts:TestReportSummary', testReportSummary_statusCounts - A map that contains the number of each type of status returned by the
test results in this TestReportSummary.
$sel:durationInNanoSeconds:TestReportSummary', testReportSummary_durationInNanoSeconds - The number of nanoseconds it took to run all of the test cases in this
report.
VpcConfig
Information about the VPC configuration that CodeBuild accesses.
See: newVpcConfig smart constructor.
Instances
| Eq VpcConfig Source # | |
| Read VpcConfig Source # | |
| Show VpcConfig Source # | |
| Generic VpcConfig Source # | |
| NFData VpcConfig Source # | |
Defined in Amazonka.CodeBuild.Types.VpcConfig | |
| Hashable VpcConfig Source # | |
Defined in Amazonka.CodeBuild.Types.VpcConfig | |
| ToJSON VpcConfig Source # | |
Defined in Amazonka.CodeBuild.Types.VpcConfig | |
| FromJSON VpcConfig Source # | |
| type Rep VpcConfig Source # | |
Defined in Amazonka.CodeBuild.Types.VpcConfig type Rep VpcConfig = D1 ('MetaData "VpcConfig" "Amazonka.CodeBuild.Types.VpcConfig" "libZSservicesZSamazonka-codebuildZSamazonka-codebuild" 'False) (C1 ('MetaCons "VpcConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) | |
newVpcConfig :: VpcConfig Source #
Create a value of VpcConfig 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:securityGroupIds:VpcConfig', vpcConfig_securityGroupIds - A list of one or more security groups IDs in your Amazon VPC.
$sel:vpcId:VpcConfig', vpcConfig_vpcId - The ID of the Amazon VPC.
$sel:subnets:VpcConfig', vpcConfig_subnets - A list of one or more subnet IDs in your Amazon VPC.
Webhook
Information about a webhook that connects repository events to a build project in CodeBuild.
See: newWebhook smart constructor.
Constructors
| Webhook' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [[WebhookFilter]]) (Maybe Text) (Maybe WebhookBuildType) |
Instances
newWebhook :: Webhook Source #
Create a value of Webhook 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:branchFilter:Webhook', webhook_branchFilter - A regular expression used to determine which repository branches are
built when a webhook is triggered. If the name of a branch matches the
regular expression, then it is built. If branchFilter is empty, then
all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
$sel:lastModifiedSecret:Webhook', webhook_lastModifiedSecret - A timestamp that indicates the last time a repository's secret token
was modified.
$sel:url:Webhook', webhook_url - The URL to the webhook.
$sel:secret:Webhook', webhook_secret - The secret token of the associated repository.
A Bitbucket webhook does not support secret.
$sel:filterGroups:Webhook', webhook_filterGroups - An array of arrays of WebhookFilter objects used to determine which
webhooks are triggered. At least one WebhookFilter in the array must
specify EVENT as its type.
For a build to be triggered, at least one filter group in the
filterGroups array must pass. For a filter group to pass, each of its
filters must pass.
$sel:payloadUrl:Webhook', webhook_payloadUrl - The CodeBuild endpoint where webhook events are sent.
$sel:buildType:Webhook', webhook_buildType - Specifies the type of build this webhook will trigger.
WebhookFilter
data WebhookFilter Source #
A filter used to determine which webhooks trigger a build.
See: newWebhookFilter smart constructor.
Constructors
| WebhookFilter' (Maybe Bool) WebhookFilterType Text |
Instances
Arguments
| :: WebhookFilterType | |
| -> Text | |
| -> WebhookFilter |
Create a value of WebhookFilter 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:excludeMatchedPattern:WebhookFilter', webhookFilter_excludeMatchedPattern - Used to indicate that the pattern determines which webhook events do
not trigger a build. If true, then a webhook event that does not match
the pattern triggers a build. If false, then a webhook event that
matches the pattern triggers a build.
$sel:type':WebhookFilter', webhookFilter_type - The type of webhook filter. There are six webhook filter types: EVENT,
ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, and
COMMIT_MESSAGE.
- EVENT
- A webhook event triggers a build when the provided
patternmatches one of five event types:PUSH,PULL_REQUEST_CREATED,PULL_REQUEST_UPDATED,PULL_REQUEST_REOPENED, andPULL_REQUEST_MERGED. TheEVENTpatterns are specified as a comma-separated string. For example,PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATEDfilters all push, pull request created, and pull request updated events.The
PULL_REQUEST_REOPENEDworks with GitHub and GitHub Enterprise only. - ACTOR_ACCOUNT_ID
- A webhook event triggers a build when a GitHub, GitHub Enterprise,
or Bitbucket account ID matches the regular expression
pattern. - HEAD_REF
- A webhook event triggers a build when the head reference matches the
regular expression
pattern. For example,refs/heads/branch-nameandrefs/tags/tag-name.Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
- BASE_REF
- A webhook event triggers a build when the base reference matches the
regular expression
pattern. For example,refs/heads/branch-name.Works with pull request events only.
- FILE_PATH
- A webhook triggers a build when the path of a changed file matches
the regular expression
pattern.Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.
- COMMIT_MESSAGE
- A webhook triggers a build when the head commit message matches the
regular expression
pattern.Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.
$sel:pattern':WebhookFilter', webhookFilter_pattern - For a WebHookFilter that uses EVENT type, a comma-separated string
that specifies one or more events. For example, the webhook filter
PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull
request created, and pull request updated events to trigger a build.
For a WebHookFilter that uses any of the other filter types, a regular
expression pattern. For example, a WebHookFilter that uses HEAD_REF
for its type and the pattern ^refs/heads/ triggers a build when
the head reference is a branch with a reference name
refs/heads/branch-name.