@datafire/amazonaws_codebuild
v5.0.0
Published
DataFire integration for AWS CodeBuild
Downloads
25
Readme
@datafire/amazonaws_codebuild
Client library for AWS CodeBuild
Installation and Usage
npm install --save @datafire/amazonaws_codebuild
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
BatchDeleteBuilds
amazonaws_codebuild.BatchDeleteBuilds({
"ids": []
}, context)
Input
- input
object
- ids required BuildIds
Output
- output BatchDeleteBuildsOutput
BatchGetBuilds
amazonaws_codebuild.BatchGetBuilds({
"ids": []
}, context)
Input
- input
object
- ids required BuildIds
Output
- output BatchGetBuildsOutput
BatchGetProjects
amazonaws_codebuild.BatchGetProjects({
"names": []
}, context)
Input
- input
object
- names required ProjectNames
Output
- output BatchGetProjectsOutput
CreateProject
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
CreateWebhook
amazonaws_codebuild.CreateWebhook({
"projectName": ""
}, context)
Input
- input
object
- projectName required ProjectName
Output
- output CreateWebhookOutput
DeleteProject
amazonaws_codebuild.DeleteProject({
"name": ""
}, context)
Input
- input
object
- name required NonEmptyString
Output
- output DeleteProjectOutput
DeleteWebhook
amazonaws_codebuild.DeleteWebhook({
"projectName": ""
}, context)
Input
- input
object
- projectName required ProjectName
Output
- output DeleteWebhookOutput
InvalidateProjectCache
amazonaws_codebuild.InvalidateProjectCache({
"projectName": ""
}, context)
Input
- input
object
- projectName required NonEmptyString
Output
- output InvalidateProjectCacheOutput
ListBuilds
amazonaws_codebuild.ListBuilds({}, context)
Input
- input
object
- nextToken String
- sortOrder SortOrderType
Output
- output ListBuildsOutput
ListBuildsForProject
amazonaws_codebuild.ListBuildsForProject({
"projectName": ""
}, context)
Input
- input
object
- nextToken String
- projectName required NonEmptyString
- sortOrder SortOrderType
Output
- output ListBuildsForProjectOutput
ListCuratedEnvironmentImages
amazonaws_codebuild.ListCuratedEnvironmentImages({}, context)
Input
- input
object
Output
ListProjects
amazonaws_codebuild.ListProjects({}, context)
Input
- input
object
- nextToken NonEmptyString
- sortBy ProjectSortByType
- sortOrder SortOrderType
Output
- output ListProjectsOutput
StartBuild
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
StopBuild
amazonaws_codebuild.StopBuild({
"id": ""
}, context)
Input
- input
object
- id required NonEmptyString
Output
- output StopBuildOutput
UpdateProject
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
AccountLimitExceededException
- AccountLimitExceededException
object
: An AWS service limit was exceeded for the calling AWS account.
ArtifactNamespace
- ArtifactNamespace
string
(values: NONE, BUILD_ID)
ArtifactPackaging
- ArtifactPackaging
string
(values: NONE, ZIP)
ArtifactsType
- ArtifactsType
string
(values: CODEPIPELINE, S3, NO_ARTIFACTS)
BatchDeleteBuildsInput
- BatchDeleteBuildsInput
object
- ids required BuildIds
BatchDeleteBuildsOutput
- BatchDeleteBuildsOutput
object
- buildsDeleted BuildIds
- buildsNotDeleted BuildsNotDeleted
BatchGetBuildsInput
- BatchGetBuildsInput
object
- ids required BuildIds
BatchGetBuildsOutput
BatchGetProjectsInput
- BatchGetProjectsInput
object
- names required ProjectNames
BatchGetProjectsOutput
- BatchGetProjectsOutput
object
- projects Projects
- projectsNotFound ProjectNames
Boolean
- Boolean
boolean
Build
- 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
BuildArtifacts
- BuildArtifacts
object
: Information about build output artifacts.
BuildIds
- BuildIds
array
- items NonEmptyString
BuildNotDeleted
- BuildNotDeleted
object
: Information about a build that could not be successfully deleted.- id NonEmptyString
- statusCode String
BuildPhase
- BuildPhase
object
: Information about a stage for a build.- contexts PhaseContexts
- durationInSeconds WrapperLong
- endTime Timestamp
- phaseStatus StatusType
- phaseType BuildPhaseType
- startTime Timestamp
BuildPhaseType
- BuildPhaseType
string
(values: SUBMITTED, PROVISIONING, DOWNLOAD_SOURCE, INSTALL, PRE_BUILD, BUILD, POST_BUILD, UPLOAD_ARTIFACTS, FINALIZING, COMPLETED)
BuildPhases
- BuildPhases
array
- items BuildPhase
Builds
- Builds
array
- items Build
BuildsNotDeleted
- BuildsNotDeleted
array
- items BuildNotDeleted
CacheType
- CacheType
string
(values: NO_CACHE, S3)
ComputeType
- ComputeType
string
(values: BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE)
CreateProjectInput
- 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
CreateProjectOutput
- CreateProjectOutput
object
- project Project
CreateWebhookInput
- CreateWebhookInput
object
- projectName required ProjectName
CreateWebhookOutput
- CreateWebhookOutput
object
- webhook Webhook
DeleteProjectInput
- DeleteProjectInput
object
- name required NonEmptyString
DeleteProjectOutput
- DeleteProjectOutput
object
DeleteWebhookInput
- DeleteWebhookInput
object
- projectName required ProjectName
DeleteWebhookOutput
- DeleteWebhookOutput
object
EnvironmentImage
- EnvironmentImage
object
: Information about a Docker image that is managed by AWS CodeBuild.- description String
- name String
- versions ImageVersions
EnvironmentImages
- EnvironmentImages
array
- items EnvironmentImage
EnvironmentLanguage
- EnvironmentLanguage
object
: A set of Docker images that are related by programming language and are managed by AWS CodeBuild.- images EnvironmentImages
- language LanguageType
EnvironmentLanguages
- EnvironmentLanguages
array
- items EnvironmentLanguage
EnvironmentPlatform
- EnvironmentPlatform
object
: A set of Docker images that are related by platform and are managed by AWS CodeBuild.- languages EnvironmentLanguages
- platform PlatformType
EnvironmentPlatforms
- EnvironmentPlatforms
array
- items EnvironmentPlatform
EnvironmentType
- EnvironmentType
string
(values: LINUX_CONTAINER)
EnvironmentVariable
- EnvironmentVariable
object
: Information about an environment variable for a build project or a build.- name required NonEmptyString
- type EnvironmentVariableType
- value required String
EnvironmentVariableType
- EnvironmentVariableType
string
(values: PLAINTEXT, PARAMETER_STORE)
EnvironmentVariables
- EnvironmentVariables
array
- items EnvironmentVariable
GitCloneDepth
- GitCloneDepth
integer
ImageVersions
- ImageVersions
array
- items String
InvalidInputException
- InvalidInputException
object
: The input value that was provided is not valid.
InvalidateProjectCacheInput
- InvalidateProjectCacheInput
object
- projectName required NonEmptyString
InvalidateProjectCacheOutput
- InvalidateProjectCacheOutput
object
KeyInput
- KeyInput
string
LanguageType
- LanguageType
string
(values: JAVA, PYTHON, NODE_JS, RUBY, GOLANG, DOCKER, ANDROID, DOTNET, BASE)
ListBuildsForProjectInput
- ListBuildsForProjectInput
object
- nextToken String
- projectName required NonEmptyString
- sortOrder SortOrderType
ListBuildsForProjectOutput
ListBuildsInput
- ListBuildsInput
object
- nextToken String
- sortOrder SortOrderType
ListBuildsOutput
ListCuratedEnvironmentImagesInput
- ListCuratedEnvironmentImagesInput
object
ListCuratedEnvironmentImagesOutput
- ListCuratedEnvironmentImagesOutput
object
- platforms EnvironmentPlatforms
ListProjectsInput
- ListProjectsInput
object
- nextToken NonEmptyString
- sortBy ProjectSortByType
- sortOrder SortOrderType
ListProjectsOutput
- ListProjectsOutput
object
- nextToken String
- projects ProjectNames
LogsLocation
- LogsLocation
object
: Information about build logs in Amazon CloudWatch Logs.
NetworkInterface
- NetworkInterface
object
: Describes a network interface.- networkInterfaceId NonEmptyString
- subnetId NonEmptyString
NonEmptyString
- NonEmptyString
string
OAuthProviderException
- OAuthProviderException
object
: There was a problem with the underlying OAuth provider.
PhaseContext
- PhaseContext
object
: Additional information about a build phase that has an error. You can use this information to help troubleshoot a failed build.
PhaseContexts
- PhaseContexts
array
- items PhaseContext
PlatformType
- PlatformType
string
(values: DEBIAN, AMAZON_LINUX, UBUNTU)
Project
- 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
ProjectArtifacts
- 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
ProjectBadge
- ProjectBadge
object
: Information about the build badge for the build project.
ProjectCache
- ProjectCache
object
: Information about the cache for the build project.
ProjectDescription
- ProjectDescription
string
ProjectEnvironment
- 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
ProjectName
- ProjectName
string
ProjectNames
- ProjectNames
array
- items NonEmptyString
ProjectSortByType
- ProjectSortByType
string
(values: NAME, CREATED_TIME, LAST_MODIFIED_TIME)
ProjectSource
- 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
Projects
- Projects
array
- items Project
ResourceAlreadyExistsException
- ResourceAlreadyExistsException
object
: The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.
ResourceNotFoundException
- ResourceNotFoundException
object
: The specified AWS resource cannot be found.
SecurityGroupIds
- SecurityGroupIds
array
- items NonEmptyString
SortOrderType
- SortOrderType
string
(values: ASCENDING, DESCENDING)
SourceAuth
- 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
SourceAuthType
- SourceAuthType
string
(values: OAUTH)
SourceType
- SourceType
string
(values: CODECOMMIT, CODEPIPELINE, GITHUB, S3, BITBUCKET, GITHUB_ENTERPRISE)
StartBuildInput
- StartBuildInput
object
- artifactsOverride ProjectArtifacts
- buildspecOverride String
- environmentVariablesOverride EnvironmentVariables
- gitCloneDepthOverride GitCloneDepth
- projectName required NonEmptyString
- sourceVersion String
- timeoutInMinutesOverride TimeOut
StartBuildOutput
- StartBuildOutput
object
- build Build
StatusType
- StatusType
string
(values: SUCCEEDED, FAILED, FAULT, TIMED_OUT, IN_PROGRESS, STOPPED)
StopBuildInput
- StopBuildInput
object
- id required NonEmptyString
StopBuildOutput
- StopBuildOutput
object
- build Build
String
- String
string
Subnets
- Subnets
array
- items NonEmptyString
Tag
- 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
TagList
- TagList
array
- items Tag
TimeOut
- TimeOut
integer
Timestamp
- Timestamp
string
UpdateProjectInput
- 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
UpdateProjectOutput
- UpdateProjectOutput
object
- project Project
ValueInput
- ValueInput
string
VpcConfig
- VpcConfig
object
: Information about the VPC configuration that AWS CodeBuild will access.- securityGroupIds SecurityGroupIds
- subnets Subnets
- vpcId NonEmptyString
Webhook
- 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
WrapperBoolean
- WrapperBoolean
boolean
WrapperInt
- WrapperInt
integer
WrapperLong
- WrapperLong
integer