@datafire/amazonaws_codebuild

Client library for AWS CodeBuild

Installation and Usage

``bash
npm install --save @datafire/amazonaws_codebuild
`
`js
let amazonaws_codebuild = require('@datafire/amazonaws_codebuild').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});

amazonaws_codebuild.BatchDeleteBuilds({
"ids": []
}).then(data => {
console.log(data);
});
`

Description

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, and 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.

• BatchGetProjects: Gets information about one or more build projects. A build project defines how AWS CodeBuild will run 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 represents a combination of operating system, programming language runtime, and tools that AWS CodeBuild will use to run a build. Also, you can add tags to build projects to help manage your resources and costs.

• CreateProject: Creates a build project.

• CreateWebhook: For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.

• DeleteProject: Deletes a build project.

• DeleteWebhook: For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.

• ListProjects: Gets a list of build project names, with each build project name representing a single build project.

• UpdateProject: Changes the settings of an existing build project.

• BatchGetBuilds: Gets information about one or more builds.

• 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.

• StartBuild: Starts running a build.

• StopBuild: Attempts to stop running a build.

• ListCuratedEnvironmentImages: Gets information about Docker images that are managed by AWS CodeBuild.

Actions

$3

`js
amazonaws_codebuild.BatchDeleteBuilds({
"ids": []
}, context)
`

#### Input
* input object
* ids required BuildIds

#### Output
* output BatchDeleteBuildsOutput

$3

`js
amazonaws_codebuild.BatchGetBuilds({
"ids": []
}, context)
`

#### Input
* input object
* ids required BuildIds

#### Output
* output BatchGetBuildsOutput

$3

`js
amazonaws_codebuild.BatchGetProjects({
"names": []
}, context)
`

#### Input
* input object
* names required ProjectNames

#### Output
* output BatchGetProjectsOutput

$3

`js
amazonaws_codebuild.CreateProject({
"name": "",
"source": {
"type": ""
},
"artifacts": {
"type": ""
},
"environment": {
"type": "",
"image": "",
"computeType": ""
}
}, context)
`

#### Input
* input object
* artifacts required ProjectArtifacts
* badgeEnabled WrapperBoolean
* cache ProjectCache
* description ProjectDescription
* encryptionKey NonEmptyString
* environment required ProjectEnvironment
* name required ProjectName
* serviceRole NonEmptyString
* source required ProjectSource
* tags TagList
* timeoutInMinutes TimeOut
* vpcConfig VpcConfig

#### Output
* output CreateProjectOutput

$3

`js
amazonaws_codebuild.CreateWebhook({
"projectName": ""
}, context)
`

#### Input
* input object
* projectName required ProjectName

#### Output
* output CreateWebhookOutput

$3

`js
amazonaws_codebuild.DeleteProject({
"name": ""
}, context)
`

#### Input
* input object
* name required NonEmptyString

#### Output
* output DeleteProjectOutput

$3

`js
amazonaws_codebuild.DeleteWebhook({
"projectName": ""
}, context)
`

#### Input
* input object
* projectName required ProjectName

#### Output
* output DeleteWebhookOutput

$3

`js
amazonaws_codebuild.InvalidateProjectCache({
"projectName": ""
}, context)
`

#### Input
* input object
* projectName required NonEmptyString

#### Output
* output InvalidateProjectCacheOutput

$3

`js
amazonaws_codebuild.ListBuilds({}, context)
`

#### Input
* input object
* nextToken String
* sortOrder SortOrderType

#### Output
* output ListBuildsOutput

$3

`js
amazonaws_codebuild.ListBuildsForProject({
"projectName": ""
}, context)
`

#### Input
* input object
* nextToken String
* projectName required NonEmptyString
* sortOrder SortOrderType

#### Output
* output ListBuildsForProjectOutput

$3

`js
amazonaws_codebuild.ListCuratedEnvironmentImages({}, context)
`

#### Input
* input object

#### Output
* output ListCuratedEnvironmentImagesOutput

$3

`js
amazonaws_codebuild.ListProjects({}, context)
`

#### Input
* input object
* nextToken NonEmptyString
* sortBy ProjectSortByType
* sortOrder SortOrderType

#### Output
* output ListProjectsOutput

$3

`js
amazonaws_codebuild.StartBuild({
"projectName": ""
}, context)
`

#### Input
* input object
* artifactsOverride ProjectArtifacts
* buildspecOverride String
* environmentVariablesOverride EnvironmentVariables
* gitCloneDepthOverride GitCloneDepth
* projectName required NonEmptyString
* sourceVersion String
* timeoutInMinutesOverride TimeOut

#### Output
* output StartBuildOutput

$3

`js
amazonaws_codebuild.StopBuild({
"id": ""
}, context)
`

#### Input
* input object
* id required NonEmptyString

#### Output
* output StopBuildOutput

$3

`js
amazonaws_codebuild.UpdateProject({
"name": ""
}, context)
`

#### Input
* input object
* artifacts ProjectArtifacts
* badgeEnabled WrapperBoolean
* cache ProjectCache
* description ProjectDescription
* encryptionKey NonEmptyString
* environment ProjectEnvironment
* name required NonEmptyString
* serviceRole NonEmptyString
* source ProjectSource
* tags TagList
* timeoutInMinutes TimeOut
* vpcConfig VpcConfig

#### Output
* output UpdateProjectOutput

Definitions

$3


* AccountLimitExceededException object: An AWS service limit was exceeded for the calling AWS account.

$3

* ArtifactNamespace string (values: NONE, BUILD_ID)

$3

* ArtifactPackaging string (values: NONE, ZIP)

$3

* ArtifactsType string (values: CODEPIPELINE, S3, NO_ARTIFACTS)

$3

* BatchDeleteBuildsInput object
* ids required BuildIds

$3

* BatchDeleteBuildsOutput object
* buildsDeleted BuildIds
* buildsNotDeleted BuildsNotDeleted

$3

* BatchGetBuildsInput object
* ids required BuildIds

$3

* BatchGetBuildsOutput object
* builds Builds
* buildsNotFound BuildIds

$3

* BatchGetProjectsInput object
* names required ProjectNames

$3

* BatchGetProjectsOutput object
* projects Projects
* projectsNotFound ProjectNames

$3

* Boolean boolean

$3

* Build object: Information about a build.
* arn NonEmptyString
* artifacts BuildArtifacts
* buildComplete Boolean
* buildStatus StatusType
* cache ProjectCache
* currentPhase String
* endTime Timestamp
* environment ProjectEnvironment
* id NonEmptyString
* initiator String
* logs LogsLocation
* networkInterface NetworkInterface
* phases BuildPhases
* projectName NonEmptyString
* source ProjectSource
* sourceVersion NonEmptyString
* startTime Timestamp
* timeoutInMinutes WrapperInt
* vpcConfig VpcConfig

$3

* BuildArtifacts object: Information about build output artifacts.
* location String
* md5sum String
* sha256sum String

$3

* BuildIds array
* items NonEmptyString

$3

* BuildNotDeleted object: Information about a build that could not be successfully deleted.
* id NonEmptyString
* statusCode String

$3

* BuildPhase object: Information about a stage for a build.
* contexts PhaseContexts
* durationInSeconds WrapperLong
* endTime Timestamp
* phaseStatus StatusType
* phaseType BuildPhaseType
* startTime Timestamp

$3

* BuildPhaseType string (values: SUBMITTED, PROVISIONING, DOWNLOAD_SOURCE, INSTALL, PRE_BUILD, BUILD, POST_BUILD, UPLOAD_ARTIFACTS, FINALIZING, COMPLETED)

$3

* BuildPhases array
* items BuildPhase

$3

* Builds array
* items Build

$3

* BuildsNotDeleted array
* items BuildNotDeleted

$3

* CacheType string (values: NO_CACHE, S3)

$3

* ComputeType string (values: BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE)

$3

* CreateProjectInput object
* artifacts required ProjectArtifacts
* badgeEnabled WrapperBoolean
* cache ProjectCache
* description ProjectDescription
* encryptionKey NonEmptyString
* environment required ProjectEnvironment
* name required ProjectName
* serviceRole NonEmptyString
* source required ProjectSource
* tags TagList
* timeoutInMinutes TimeOut
* vpcConfig VpcConfig

$3

* CreateProjectOutput object
* project Project

$3

* CreateWebhookInput object
* projectName required ProjectName

$3

* CreateWebhookOutput object
* webhook Webhook

$3

* DeleteProjectInput object
* name required NonEmptyString

$3

* DeleteProjectOutput object

$3

* DeleteWebhookInput object
* projectName required ProjectName

$3

* DeleteWebhookOutput object

$3

* EnvironmentImage object: Information about a Docker image that is managed by AWS CodeBuild.
* description String
* name String
* versions ImageVersions

$3

* EnvironmentImages array
* items EnvironmentImage

$3

* EnvironmentLanguage object: A set of Docker images that are related by programming language and are managed by AWS CodeBuild.
* images EnvironmentImages
* language LanguageType

$3

* EnvironmentLanguages array
* items EnvironmentLanguage

$3

* EnvironmentPlatform object: A set of Docker images that are related by platform and are managed by AWS CodeBuild.
* languages EnvironmentLanguages
* platform PlatformType

$3

* EnvironmentPlatforms array
* items EnvironmentPlatform

$3

* EnvironmentType string (values: LINUX_CONTAINER)

$3

* EnvironmentVariable object: Information about an environment variable for a build project or a build.
* name required NonEmptyString
* type EnvironmentVariableType
* value required String

$3

* EnvironmentVariableType string (values: PLAINTEXT, PARAMETER_STORE)

$3

* EnvironmentVariables array
* items EnvironmentVariable

$3

* GitCloneDepth integer

$3

* ImageVersions array
* items String

$3

* InvalidInputException object: The input value that was provided is not valid.

$3

* InvalidateProjectCacheInput object
* projectName required NonEmptyString

$3

* InvalidateProjectCacheOutput object

$3

* KeyInput string

$3

* LanguageType string (values: JAVA, PYTHON, NODE_JS, RUBY, GOLANG, DOCKER, ANDROID, DOTNET, BASE)

$3

* ListBuildsForProjectInput object
* nextToken String
* projectName required NonEmptyString
* sortOrder SortOrderType

$3

* ListBuildsForProjectOutput object
* ids BuildIds
* nextToken String

$3

* ListBuildsInput object
* nextToken String
* sortOrder SortOrderType

$3

* ListBuildsOutput object
* ids BuildIds
* nextToken String

$3

* ListCuratedEnvironmentImagesInput object

$3

* ListCuratedEnvironmentImagesOutput object
* platforms EnvironmentPlatforms

$3

* ListProjectsInput object
* nextToken NonEmptyString
* sortBy ProjectSortByType
* sortOrder SortOrderType

$3

* ListProjectsOutput object
* nextToken String
* projects ProjectNames

$3

* LogsLocation object: Information about build logs in Amazon CloudWatch Logs.
* deepLink String
* groupName String
* streamName String

$3

* NetworkInterface object: Describes a network interface.
* networkInterfaceId NonEmptyString
* subnetId NonEmptyString

$3

* NonEmptyString string

$3

* OAuthProviderException object: There was a problem with the underlying OAuth provider.

$3

* PhaseContext object: Additional information about a build phase that has an error. You can use this information to help troubleshoot a failed build.
* message String
* statusCode String

$3

* PhaseContexts array
* items PhaseContext

$3

* PlatformType string (values: DEBIAN, AMAZON_LINUX, UBUNTU)

$3

* Project object: Information about a build project.
* arn String
* artifacts ProjectArtifacts
* badge ProjectBadge
* cache ProjectCache
* created Timestamp
* description ProjectDescription
* encryptionKey NonEmptyString
* environment ProjectEnvironment
* lastModified Timestamp
* name ProjectName
* serviceRole NonEmptyString
* source ProjectSource
* tags TagList
* timeoutInMinutes TimeOut
* vpcConfig VpcConfig
* webhook Webhook

$3

* ProjectArtifacts object: Information about the build output artifacts for the build project.
* location String
* name String
* namespaceType ArtifactNamespace
* packaging ArtifactPackaging
* path String
* type required ArtifactsType

$3

* ProjectBadge object: Information about the build badge for the build project.
* badgeEnabled Boolean
* badgeRequestUrl String

$3

* ProjectCache object: Information about the cache for the build project.
* location String
* type required CacheType

$3

* ProjectDescription string

$3

* ProjectEnvironment object: Information about the build environment of the build project.
* certificate String
* computeType required ComputeType
* environmentVariables EnvironmentVariables
* image required NonEmptyString
* privilegedMode WrapperBoolean
* type required EnvironmentType

$3

* ProjectName string

$3

* ProjectNames array
* items NonEmptyString

$3

* ProjectSortByType string (values: NAME, CREATED_TIME, LAST_MODIFIED_TIME)

$3

* ProjectSource object: Information about the build input source code for the build project.
* auth SourceAuth
* buildspec String
* gitCloneDepth GitCloneDepth
* insecureSsl WrapperBoolean
* location String
* type required SourceType

$3

* Projects array
* items Project

$3

* ResourceAlreadyExistsException object: The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.

$3

* ResourceNotFoundException object: The specified AWS resource cannot be found.

$3

* SecurityGroupIds array
* items NonEmptyString

$3

* SortOrderType string (values: ASCENDING, DESCENDING)

$3

* SourceAuth object:

Information about the authorization settings for AWS CodeBuild to access the source code to be built.

This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source type value is BITBUCKET or GITHUB).

* resource String
* type required SourceAuthType

$3

* SourceAuthType string (values: OAUTH)

$3

* SourceType string (values: CODECOMMIT, CODEPIPELINE, GITHUB, S3, BITBUCKET, GITHUB_ENTERPRISE)

$3

* StartBuildInput object
* artifactsOverride ProjectArtifacts
* buildspecOverride String
* environmentVariablesOverride EnvironmentVariables
* gitCloneDepthOverride GitCloneDepth
* projectName required NonEmptyString
* sourceVersion String
* timeoutInMinutesOverride TimeOut

$3

* StartBuildOutput object
* build Build

$3

* StatusType string (values: SUCCEEDED, FAILED, FAULT, TIMED_OUT, IN_PROGRESS, STOPPED)

$3

* StopBuildInput object
* id required NonEmptyString

$3

* StopBuildOutput object
* build Build

$3

* String string

$3

* Subnets array
* items NonEmptyString

$3

* Tag object:

A tag, consisting of a key and a value.

This tag is available for use by AWS services that support tags in AWS CodeBuild.

* key KeyInput
* value ValueInput

$3

* TagList array
* items Tag

$3

* TimeOut integer

$3

* Timestamp string

$3

* UpdateProjectInput object
* artifacts ProjectArtifacts
* badgeEnabled WrapperBoolean
* cache ProjectCache
* description ProjectDescription
* encryptionKey NonEmptyString
* environment ProjectEnvironment
* name required NonEmptyString
* serviceRole NonEmptyString
* source ProjectSource
* tags TagList
* timeoutInMinutes TimeOut
* vpcConfig VpcConfig

$3

* UpdateProjectOutput object
* project Project

$3

* ValueInput string

$3

* VpcConfig object: Information about the VPC configuration that AWS CodeBuild will access.
* securityGroupIds SecurityGroupIds
* subnets Subnets
* vpcId NonEmptyString

$3

* Webhook object: Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.
* payloadUrl NonEmptyString
* secret NonEmptyString
* url NonEmptyString

$3

* WrapperBoolean boolean

$3

* WrapperInt integer

$3

* WrapperLong integer`