CodeBuild
public struct CodeBuild
Client object for interacting with AWS CodeBuild service.
AWS CodeBuild AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS 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 AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about AWS CodeBuild, see the AWS CodeBuild User Guide. AWS CodeBuild supports these operations: BatchDeleteBuilds: Deletes one or more builds. BatchGetBuilds: Gets information about one or more builds. BatchGetProjects: Gets information about one or more build projects. A build project defines how AWS CodeBuild runs a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A build environment is a representation of operating system, programming language runtime, and tools that AWS CodeBuild uses to run a build. You can add tags to build projects to help manage your resources and costs. BatchGetReportGroups: Returns an array of report groups. BatchGetReports: Returns an array of reports. CreateProject: Creates a build project. CreateReportGroup: Creates a report group. A report group contains a collection of reports. CreateWebhook: For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. DeleteProject: Deletes a build project. DeleteReport: Deletes a report. DeleteReportGroup: Deletes a report group. DeleteResourcePolicy: Deletes a resource policy that is identified by its resource ARN. DeleteSourceCredentials: Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials. DeleteWebhook: For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository. DescribeTestCases: Returns a list of details about test cases for a report. GetResourcePolicy: Gets a resource policy that is identified by its resource ARN. ImportSourceCredentials: Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository. InvalidateProjectCache: Resets the cache for a project. ListBuilds: Gets a list of build IDs, with each build ID representing a single build. ListBuildsForProject: Gets a list of build IDs for the specified build project, with each build ID representing a single build. ListCuratedEnvironmentImages: Gets information about Docker images that are managed by AWS CodeBuild. ListProjects: Gets a list of build project names, with each build project name representing a single build project. ListReportGroups: Gets a list ARNs for the report groups in the current AWS account. ListReports: Gets a list ARNs for the reports in the current AWS account. ListReportsForReportGroup: Returns a list of ARNs for the reports that belong to a ReportGroup. ListSharedProjects: Gets a list of ARNs associated with projects shared with the current AWS account or user. ListSharedReportGroups: Gets a list of ARNs associated with report groups shared with the current AWS account or user ListSourceCredentials: Returns a list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials. PutResourcePolicy: Stores a resource policy for the ARN of a Project or ReportGroup object. StartBuild: Starts running a build. StopBuild: Attempts to stop running a build. UpdateProject: Changes the settings of an existing build project. UpdateReportGroup: Changes a report group. UpdateWebhook: Changes the settings of an existing webhook.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the CodeBuild client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)
Parameters
accessKeyId
Public access key provided by AWS
secretAccessKey
Private access key provided by AWS
sessionToken
Token provided by STS.AssumeRole() which allows access to another AWS account
region
Region of server you want to communicate with
endpoint
Custom endpoint URL to use instead of standard AWS servers
middlewares
Array of middlewares to apply to requests and responses
eventLoopGroupProvider
EventLoopGroup to use. Use
useAWSClientShared
if the client shall manage its own EventLoopGroup.
-
Deletes one or more builds.
Declaration
Swift
public func batchDeleteBuilds(_ input: BatchDeleteBuildsInput) -> EventLoopFuture<BatchDeleteBuildsOutput>
-
Retrieves information about one or more batch builds.
Declaration
Swift
public func batchGetBuildBatches(_ input: BatchGetBuildBatchesInput) -> EventLoopFuture<BatchGetBuildBatchesOutput>
-
Gets information about one or more builds.
Declaration
Swift
public func batchGetBuilds(_ input: BatchGetBuildsInput) -> EventLoopFuture<BatchGetBuildsOutput>
-
Gets information about one or more build projects.
Declaration
Swift
public func batchGetProjects(_ input: BatchGetProjectsInput) -> EventLoopFuture<BatchGetProjectsOutput>
-
Returns an array of report groups.
Declaration
Swift
public func batchGetReportGroups(_ input: BatchGetReportGroupsInput) -> EventLoopFuture<BatchGetReportGroupsOutput>
-
Returns an array of reports.
Declaration
Swift
public func batchGetReports(_ input: BatchGetReportsInput) -> EventLoopFuture<BatchGetReportsOutput>
-
Creates a build project.
Declaration
Swift
public func createProject(_ input: CreateProjectInput) -> EventLoopFuture<CreateProjectOutput>
-
Creates a report group. A report group contains a collection of reports.
Declaration
Swift
public func createReportGroup(_ input: CreateReportGroupInput) -> EventLoopFuture<CreateReportGroupOutput>
-
For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project’s Settings.
Declaration
Swift
public func createWebhook(_ input: CreateWebhookInput) -> EventLoopFuture<CreateWebhookOutput>
-
Deletes a batch build.
Declaration
Swift
public func deleteBuildBatch(_ input: DeleteBuildBatchInput) -> EventLoopFuture<DeleteBuildBatchOutput>
-
Deletes a build project. When you delete a project, its builds are not deleted.
Declaration
Swift
public func deleteProject(_ input: DeleteProjectInput) -> EventLoopFuture<DeleteProjectOutput>
-
Deletes a report.
Declaration
Swift
public func deleteReport(_ input: DeleteReportInput) -> EventLoopFuture<DeleteReportOutput>
-
Deletes a report group. Before you delete a report group, you must delete its reports.
Declaration
Swift
public func deleteReportGroup(_ input: DeleteReportGroupInput) -> EventLoopFuture<DeleteReportGroupOutput>
-
Deletes a resource policy that is identified by its resource ARN.
Declaration
Swift
public func deleteResourcePolicy(_ input: DeleteResourcePolicyInput) -> EventLoopFuture<DeleteResourcePolicyOutput>
-
Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
Declaration
Swift
public func deleteSourceCredentials(_ input: DeleteSourceCredentialsInput) -> EventLoopFuture<DeleteSourceCredentialsOutput>
-
For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
Declaration
Swift
public func deleteWebhook(_ input: DeleteWebhookInput) -> EventLoopFuture<DeleteWebhookOutput>
-
Retrieves one or more code coverage reports.
Declaration
Swift
public func describeCodeCoverages(_ input: DescribeCodeCoveragesInput) -> EventLoopFuture<DescribeCodeCoveragesOutput>
-
Returns a list of details about test cases for a report.
Declaration
Swift
public func describeTestCases(_ input: DescribeTestCasesInput) -> EventLoopFuture<DescribeTestCasesOutput>
-
Gets a resource policy that is identified by its resource ARN.
Declaration
Swift
public func getResourcePolicy(_ input: GetResourcePolicyInput) -> EventLoopFuture<GetResourcePolicyOutput>
-
Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
Declaration
Swift
public func importSourceCredentials(_ input: ImportSourceCredentialsInput) -> EventLoopFuture<ImportSourceCredentialsOutput>
-
Resets the cache for a project.
Declaration
Swift
public func invalidateProjectCache(_ input: InvalidateProjectCacheInput) -> EventLoopFuture<InvalidateProjectCacheOutput>
-
Retrieves the identifiers of your build batches in the current region.
Declaration
Swift
public func listBuildBatches(_ input: ListBuildBatchesInput) -> EventLoopFuture<ListBuildBatchesOutput>
-
Retrieves the identifiers of the build batches for a specific project.
Declaration
Swift
public func listBuildBatchesForProject(_ input: ListBuildBatchesForProjectInput) -> EventLoopFuture<ListBuildBatchesForProjectOutput>
-
Gets a list of build IDs, with each build ID representing a single build.
Declaration
Swift
public func listBuilds(_ input: ListBuildsInput) -> EventLoopFuture<ListBuildsOutput>
-
Gets a list of build IDs for the specified build project, with each build ID representing a single build.
Declaration
Swift
public func listBuildsForProject(_ input: ListBuildsForProjectInput) -> EventLoopFuture<ListBuildsForProjectOutput>
-
Gets information about Docker images that are managed by AWS CodeBuild.
Declaration
Swift
public func listCuratedEnvironmentImages(_ input: ListCuratedEnvironmentImagesInput) -> EventLoopFuture<ListCuratedEnvironmentImagesOutput>
-
Gets a list of build project names, with each build project name representing a single build project.
Declaration
Swift
public func listProjects(_ input: ListProjectsInput) -> EventLoopFuture<ListProjectsOutput>
-
Gets a list ARNs for the report groups in the current AWS account.
Declaration
Swift
public func listReportGroups(_ input: ListReportGroupsInput) -> EventLoopFuture<ListReportGroupsOutput>
-
Returns a list of ARNs for the reports in the current AWS account.
Declaration
Swift
public func listReports(_ input: ListReportsInput) -> EventLoopFuture<ListReportsOutput>
-
Returns a list of ARNs for the reports that belong to a ReportGroup.
Declaration
Swift
public func listReportsForReportGroup(_ input: ListReportsForReportGroupInput) -> EventLoopFuture<ListReportsForReportGroupOutput>
-
Gets a list of projects that are shared with other AWS accounts or users.
Declaration
Swift
public func listSharedProjects(_ input: ListSharedProjectsInput) -> EventLoopFuture<ListSharedProjectsOutput>
-
Gets a list of report groups that are shared with other AWS accounts or users.
Declaration
Swift
public func listSharedReportGroups(_ input: ListSharedReportGroupsInput) -> EventLoopFuture<ListSharedReportGroupsOutput>
-
Returns a list of SourceCredentialsInfo objects.
Declaration
Swift
public func listSourceCredentials(_ input: ListSourceCredentialsInput) -> EventLoopFuture<ListSourceCredentialsOutput>
-
Stores a resource policy for the ARN of a Project or ReportGroup object.
Declaration
Swift
public func putResourcePolicy(_ input: PutResourcePolicyInput) -> EventLoopFuture<PutResourcePolicyOutput>
-
Restarts a build.
Declaration
Swift
public func retryBuild(_ input: RetryBuildInput) -> EventLoopFuture<RetryBuildOutput>
-
Restarts a batch build.
Declaration
Swift
public func retryBuildBatch(_ input: RetryBuildBatchInput) -> EventLoopFuture<RetryBuildBatchOutput>
-
Starts running a build.
Declaration
Swift
public func startBuild(_ input: StartBuildInput) -> EventLoopFuture<StartBuildOutput>
-
Starts a batch build for a project.
Declaration
Swift
public func startBuildBatch(_ input: StartBuildBatchInput) -> EventLoopFuture<StartBuildBatchOutput>
-
Attempts to stop running a build.
Declaration
Swift
public func stopBuild(_ input: StopBuildInput) -> EventLoopFuture<StopBuildOutput>
-
Stops a running batch build.
Declaration
Swift
public func stopBuildBatch(_ input: StopBuildBatchInput) -> EventLoopFuture<StopBuildBatchOutput>
-
Changes the settings of a build project.
Declaration
Swift
public func updateProject(_ input: UpdateProjectInput) -> EventLoopFuture<UpdateProjectOutput>
-
Updates a report group.
Declaration
Swift
public func updateReportGroup(_ input: UpdateReportGroupInput) -> EventLoopFuture<UpdateReportGroupOutput>
-
Updates the webhook associated with an AWS CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored.
Declaration
Swift
public func updateWebhook(_ input: UpdateWebhookInput) -> EventLoopFuture<UpdateWebhookOutput>
-
Retrieves one or more code coverage reports.
Declaration
Swift
public func describeCodeCoveragesPaginator(_ input: DescribeCodeCoveragesInput, onPage: @escaping (DescribeCodeCoveragesOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of details about test cases for a report.
Declaration
Swift
public func describeTestCasesPaginator(_ input: DescribeTestCasesInput, onPage: @escaping (DescribeTestCasesOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Retrieves the identifiers of your build batches in the current region.
Declaration
Swift
public func listBuildBatchesPaginator(_ input: ListBuildBatchesInput, onPage: @escaping (ListBuildBatchesOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Retrieves the identifiers of the build batches for a specific project.
Declaration
Swift
public func listBuildBatchesForProjectPaginator(_ input: ListBuildBatchesForProjectInput, onPage: @escaping (ListBuildBatchesForProjectOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets a list of build IDs, with each build ID representing a single build.
Declaration
Swift
public func listBuildsPaginator(_ input: ListBuildsInput, onPage: @escaping (ListBuildsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets a list of build IDs for the specified build project, with each build ID representing a single build.
Declaration
Swift
public func listBuildsForProjectPaginator(_ input: ListBuildsForProjectInput, onPage: @escaping (ListBuildsForProjectOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets a list of build project names, with each build project name representing a single build project.
Declaration
Swift
public func listProjectsPaginator(_ input: ListProjectsInput, onPage: @escaping (ListProjectsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets a list ARNs for the report groups in the current AWS account.
Declaration
Swift
public func listReportGroupsPaginator(_ input: ListReportGroupsInput, onPage: @escaping (ListReportGroupsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of ARNs for the reports in the current AWS account.
Declaration
Swift
public func listReportsPaginator(_ input: ListReportsInput, onPage: @escaping (ListReportsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of ARNs for the reports that belong to a ReportGroup.
Declaration
Swift
public func listReportsForReportGroupPaginator(_ input: ListReportsForReportGroupInput, onPage: @escaping (ListReportsForReportGroupOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets a list of projects that are shared with other AWS accounts or users.
Declaration
Swift
public func listSharedProjectsPaginator(_ input: ListSharedProjectsInput, onPage: @escaping (ListSharedProjectsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets a list of report groups that are shared with other AWS accounts or users.
Declaration
Swift
public func listSharedReportGroupsPaginator(_ input: ListSharedReportGroupsInput, onPage: @escaping (ListSharedReportGroupsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct DescribeCodeCoveragesInput : AWSShape
extension CodeBuild.DescribeCodeCoveragesInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct DescribeTestCasesInput : AWSShape
extension CodeBuild.DescribeTestCasesInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListBuildBatchesInput : AWSShape
extension CodeBuild.ListBuildBatchesInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListBuildBatchesForProjectInput : AWSShape
extension CodeBuild.ListBuildBatchesForProjectInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListBuildsInput : AWSShape
extension CodeBuild.ListBuildsInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListBuildsForProjectInput : AWSShape
extension CodeBuild.ListBuildsForProjectInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListProjectsInput : AWSShape
extension CodeBuild.ListProjectsInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListReportGroupsInput : AWSShape
extension CodeBuild.ListReportGroupsInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListReportsInput : AWSShape
extension CodeBuild.ListReportsInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListReportsForReportGroupInput : AWSShape
extension CodeBuild.ListReportsForReportGroupInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListSharedProjectsInput : AWSShape
extension CodeBuild.ListSharedProjectsInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListSharedReportGroupsInput : AWSShape
extension CodeBuild.ListSharedReportGroupsInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum ArtifactNamespace : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ArtifactPackaging : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ArtifactsType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum AuthType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum BuildBatchPhaseType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum BuildPhaseType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum CacheMode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum CacheType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ComputeType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum CredentialProviderType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum EnvironmentType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum EnvironmentVariableType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum FileSystemType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ImagePullCredentialsType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum LanguageType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum LogsConfigStatusType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum PlatformType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ProjectSortByType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReportCodeCoverageSortByType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReportExportConfigType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReportGroupSortByType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReportPackagingType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReportStatusType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReportType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum RetryBuildBatchType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ServerType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SharedResourceSortByType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SortOrderType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SourceAuthType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SourceType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum StatusType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum WebhookBuildType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum WebhookFilterType : String, CustomStringConvertible, Codable