The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Paws-0.42
River stage two • 9 direct dependents • 11 total dependents
57 ++
/ Paws::CodeBuild

NAME

Paws::CodeBuild - Perl Interface to AWS AWS CodeBuild

SYNOPSIS

  use Paws;

  my $obj = Paws->service('CodeBuild');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

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. You pay only for the build time you consume. For more information about AWS CodeBuild, see the AWS CodeBuild User Guide (https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html).

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.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06

METHODS

BatchDeleteBuilds

Ids => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeBuild::BatchDeleteBuilds

Returns: a Paws::CodeBuild::BatchDeleteBuildsOutput instance

Deletes one or more builds.

BatchGetBuilds

Ids => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeBuild::BatchGetBuilds

Returns: a Paws::CodeBuild::BatchGetBuildsOutput instance

Gets information about one or more builds.

BatchGetProjects

Names => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeBuild::BatchGetProjects

Returns: a Paws::CodeBuild::BatchGetProjectsOutput instance

Gets information about one or more build projects.

BatchGetReportGroups

ReportGroupArns => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeBuild::BatchGetReportGroups

Returns: a Paws::CodeBuild::BatchGetReportGroupsOutput instance

Returns an array of report groups.

BatchGetReports

ReportArns => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeBuild::BatchGetReports

Returns: a Paws::CodeBuild::BatchGetReportsOutput instance

Returns an array of reports.

CreateProject

Artifacts => Paws::CodeBuild::ProjectArtifacts
Environment => Paws::CodeBuild::ProjectEnvironment
Name => Str
ServiceRole => Str
Source => Paws::CodeBuild::ProjectSource
[BadgeEnabled => Bool]
[Cache => Paws::CodeBuild::ProjectCache]
[Description => Str]
[EncryptionKey => Str]
[FileSystemLocations => ArrayRef[Paws::CodeBuild::ProjectFileSystemLocation]]
[LogsConfig => Paws::CodeBuild::LogsConfig]
[QueuedTimeoutInMinutes => Int]
[SecondaryArtifacts => ArrayRef[Paws::CodeBuild::ProjectArtifacts]]
[SecondarySources => ArrayRef[Paws::CodeBuild::ProjectSource]]
[SecondarySourceVersions => ArrayRef[Paws::CodeBuild::ProjectSourceVersion]]
[SourceVersion => Str]
[Tags => ArrayRef[Paws::CodeBuild::Tag]]
[TimeoutInMinutes => Int]
[VpcConfig => Paws::CodeBuild::VpcConfig]

Each argument is described in detail in: Paws::CodeBuild::CreateProject

Returns: a Paws::CodeBuild::CreateProjectOutput instance

Creates a build project.

CreateReportGroup

ExportConfig => Paws::CodeBuild::ReportExportConfig
Name => Str
Type => Str

Each argument is described in detail in: Paws::CodeBuild::CreateReportGroup

Returns: a Paws::CodeBuild::CreateReportGroupOutput instance

Creates a report group. A report group contains a collection of reports.

CreateWebhook

ProjectName => Str
[BranchFilter => Str]
[FilterGroups => ArrayRef[ArrayRef[Paws::CodeBuild::WebhookFilter]]]

Each argument is described in detail in: Paws::CodeBuild::CreateWebhook

Returns: a Paws::CodeBuild::CreateWebhookOutput instance

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 (https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console).

DeleteProject

Name => Str

Each argument is described in detail in: Paws::CodeBuild::DeleteProject

Returns: a Paws::CodeBuild::DeleteProjectOutput instance

Deletes a build project. When you delete a project, its builds are not deleted.

DeleteReport

Arn => Str

Each argument is described in detail in: Paws::CodeBuild::DeleteReport

Returns: a Paws::CodeBuild::DeleteReportOutput instance

Deletes a report.

DeleteReportGroup

Arn => Str

Each argument is described in detail in: Paws::CodeBuild::DeleteReportGroup

Returns: a Paws::CodeBuild::DeleteReportGroupOutput instance

DeleteReportGroup: Deletes a report group. Before you delete a report group, you must delete its reports. Use ListReportsForReportGroup (https://docs.aws.amazon.com/codebuild/latest/APIReference/API_ListReportsForReportGroup.html) to get the reports in a report group. Use DeleteReport (https://docs.aws.amazon.com/codebuild/latest/APIReference/API_DeleteReport.html) to delete the reports. If you call DeleteReportGroup for a report group that contains one or more reports, an exception is thrown.

DeleteResourcePolicy

ResourceArn => Str

Each argument is described in detail in: Paws::CodeBuild::DeleteResourcePolicy

Returns: a Paws::CodeBuild::DeleteResourcePolicyOutput instance

Deletes a resource policy that is identified by its resource ARN.

DeleteSourceCredentials

Arn => Str

Each argument is described in detail in: Paws::CodeBuild::DeleteSourceCredentials

Returns: a Paws::CodeBuild::DeleteSourceCredentialsOutput instance

Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

DeleteWebhook

ProjectName => Str

Each argument is described in detail in: Paws::CodeBuild::DeleteWebhook

Returns: a Paws::CodeBuild::DeleteWebhookOutput instance

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

ReportArn => Str
[Filter => Paws::CodeBuild::TestCaseFilter]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CodeBuild::DescribeTestCases

Returns: a Paws::CodeBuild::DescribeTestCasesOutput instance

Returns a list of details about test cases for a report.

GetResourcePolicy

ResourceArn => Str

Each argument is described in detail in: Paws::CodeBuild::GetResourcePolicy

Returns: a Paws::CodeBuild::GetResourcePolicyOutput instance

Gets a resource policy that is identified by its resource ARN.

ImportSourceCredentials

AuthType => Str
ServerType => Str
Token => Str
[ShouldOverwrite => Bool]
[Username => Str]

Each argument is described in detail in: Paws::CodeBuild::ImportSourceCredentials

Returns: a Paws::CodeBuild::ImportSourceCredentialsOutput instance

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

ProjectName => Str

Each argument is described in detail in: Paws::CodeBuild::InvalidateProjectCache

Returns: a Paws::CodeBuild::InvalidateProjectCacheOutput instance

Resets the cache for a project.

ListBuilds

[NextToken => Str]
[SortOrder => Str]

Each argument is described in detail in: Paws::CodeBuild::ListBuilds

Returns: a Paws::CodeBuild::ListBuildsOutput instance

Gets a list of build IDs, with each build ID representing a single build.

ListBuildsForProject

ProjectName => Str
[NextToken => Str]
[SortOrder => Str]

Each argument is described in detail in: Paws::CodeBuild::ListBuildsForProject

Returns: a Paws::CodeBuild::ListBuildsForProjectOutput instance

Gets a list of build IDs for the specified build project, with each build ID representing a single build.

ListCuratedEnvironmentImages

Each argument is described in detail in: Paws::CodeBuild::ListCuratedEnvironmentImages

Returns: a Paws::CodeBuild::ListCuratedEnvironmentImagesOutput instance

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

ListProjects

[NextToken => Str]
[SortBy => Str]
[SortOrder => Str]

Each argument is described in detail in: Paws::CodeBuild::ListProjects

Returns: a Paws::CodeBuild::ListProjectsOutput instance

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

ListReportGroups

[MaxResults => Int]
[NextToken => Str]
[SortBy => Str]
[SortOrder => Str]

Each argument is described in detail in: Paws::CodeBuild::ListReportGroups

Returns: a Paws::CodeBuild::ListReportGroupsOutput instance

Gets a list ARNs for the report groups in the current AWS account.

ListReports

[Filter => Paws::CodeBuild::ReportFilter]
[MaxResults => Int]
[NextToken => Str]
[SortOrder => Str]

Each argument is described in detail in: Paws::CodeBuild::ListReports

Returns: a Paws::CodeBuild::ListReportsOutput instance

Returns a list of ARNs for the reports in the current AWS account.

ListReportsForReportGroup

ReportGroupArn => Str
[Filter => Paws::CodeBuild::ReportFilter]
[MaxResults => Int]
[NextToken => Str]
[SortOrder => Str]

Each argument is described in detail in: Paws::CodeBuild::ListReportsForReportGroup

Returns: a Paws::CodeBuild::ListReportsForReportGroupOutput instance

Returns a list of ARNs for the reports that belong to a ReportGroup.

ListSharedProjects

[MaxResults => Int]
[NextToken => Str]
[SortBy => Str]
[SortOrder => Str]

Each argument is described in detail in: Paws::CodeBuild::ListSharedProjects

Returns: a Paws::CodeBuild::ListSharedProjectsOutput instance

Gets a list of projects that are shared with other AWS accounts or users.

ListSharedReportGroups

[MaxResults => Int]
[NextToken => Str]
[SortBy => Str]
[SortOrder => Str]

Each argument is described in detail in: Paws::CodeBuild::ListSharedReportGroups

Returns: a Paws::CodeBuild::ListSharedReportGroupsOutput instance

Gets a list of report groups that are shared with other AWS accounts or users.

ListSourceCredentials

Each argument is described in detail in: Paws::CodeBuild::ListSourceCredentials

Returns: a Paws::CodeBuild::ListSourceCredentialsOutput instance

Returns a list of SourceCredentialsInfo objects.

PutResourcePolicy

Policy => Str
ResourceArn => Str

Each argument is described in detail in: Paws::CodeBuild::PutResourcePolicy

Returns: a Paws::CodeBuild::PutResourcePolicyOutput instance

Stores a resource policy for the ARN of a Project or ReportGroup object.

StartBuild

ProjectName => Str
[ArtifactsOverride => Paws::CodeBuild::ProjectArtifacts]
[BuildspecOverride => Str]
[CacheOverride => Paws::CodeBuild::ProjectCache]
[CertificateOverride => Str]
[ComputeTypeOverride => Str]
[EncryptionKeyOverride => Str]
[EnvironmentTypeOverride => Str]
[EnvironmentVariablesOverride => ArrayRef[Paws::CodeBuild::EnvironmentVariable]]
[GitCloneDepthOverride => Int]
[GitSubmodulesConfigOverride => Paws::CodeBuild::GitSubmodulesConfig]
[IdempotencyToken => Str]
[ImageOverride => Str]
[ImagePullCredentialsTypeOverride => Str]
[InsecureSslOverride => Bool]
[LogsConfigOverride => Paws::CodeBuild::LogsConfig]
[PrivilegedModeOverride => Bool]
[QueuedTimeoutInMinutesOverride => Int]
[RegistryCredentialOverride => Paws::CodeBuild::RegistryCredential]
[ReportBuildStatusOverride => Bool]
[SecondaryArtifactsOverride => ArrayRef[Paws::CodeBuild::ProjectArtifacts]]
[SecondarySourcesOverride => ArrayRef[Paws::CodeBuild::ProjectSource]]
[SecondarySourcesVersionOverride => ArrayRef[Paws::CodeBuild::ProjectSourceVersion]]
[ServiceRoleOverride => Str]
[SourceAuthOverride => Paws::CodeBuild::SourceAuth]
[SourceLocationOverride => Str]
[SourceTypeOverride => Str]
[SourceVersion => Str]
[TimeoutInMinutesOverride => Int]

Each argument is described in detail in: Paws::CodeBuild::StartBuild

Returns: a Paws::CodeBuild::StartBuildOutput instance

Starts running a build.

StopBuild

Id => Str

Each argument is described in detail in: Paws::CodeBuild::StopBuild

Returns: a Paws::CodeBuild::StopBuildOutput instance

Attempts to stop running a build.

UpdateProject

Name => Str
[Artifacts => Paws::CodeBuild::ProjectArtifacts]
[BadgeEnabled => Bool]
[Cache => Paws::CodeBuild::ProjectCache]
[Description => Str]
[EncryptionKey => Str]
[Environment => Paws::CodeBuild::ProjectEnvironment]
[FileSystemLocations => ArrayRef[Paws::CodeBuild::ProjectFileSystemLocation]]
[LogsConfig => Paws::CodeBuild::LogsConfig]
[QueuedTimeoutInMinutes => Int]
[SecondaryArtifacts => ArrayRef[Paws::CodeBuild::ProjectArtifacts]]
[SecondarySources => ArrayRef[Paws::CodeBuild::ProjectSource]]
[SecondarySourceVersions => ArrayRef[Paws::CodeBuild::ProjectSourceVersion]]
[ServiceRole => Str]
[Source => Paws::CodeBuild::ProjectSource]
[SourceVersion => Str]
[Tags => ArrayRef[Paws::CodeBuild::Tag]]
[TimeoutInMinutes => Int]
[VpcConfig => Paws::CodeBuild::VpcConfig]

Each argument is described in detail in: Paws::CodeBuild::UpdateProject

Returns: a Paws::CodeBuild::UpdateProjectOutput instance

Changes the settings of a build project.

UpdateReportGroup

Arn => Str
[ExportConfig => Paws::CodeBuild::ReportExportConfig]

Each argument is described in detail in: Paws::CodeBuild::UpdateReportGroup

Returns: a Paws::CodeBuild::UpdateReportGroupOutput instance

Updates a report group.

UpdateWebhook

ProjectName => Str
[BranchFilter => Str]
[FilterGroups => ArrayRef[ArrayRef[Paws::CodeBuild::WebhookFilter]]]
[RotateSecret => Bool]

Each argument is described in detail in: Paws::CodeBuild::UpdateWebhook

Returns: a Paws::CodeBuild::UpdateWebhookOutput instance

Updates the webhook associated with an AWS CodeBuild build project.

If you use Bitbucket for your repository, rotateSecret is ignored.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllBuilds(sub { },[NextToken => Str, SortOrder => Str])

ListAllBuilds([NextToken => Str, SortOrder => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ids, passing the object as the first parameter, and the string 'ids' as the second parameter

If not, it will return a a Paws::CodeBuild::ListBuildsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllBuildsForProject(sub { },ProjectName => Str, [NextToken => Str, SortOrder => Str])

ListAllBuildsForProject(ProjectName => Str, [NextToken => Str, SortOrder => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ids, passing the object as the first parameter, and the string 'ids' as the second parameter

If not, it will return a a Paws::CodeBuild::ListBuildsForProjectOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllProjects(sub { },[NextToken => Str, SortBy => Str, SortOrder => Str])

ListAllProjects([NextToken => Str, SortBy => Str, SortOrder => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - projects, passing the object as the first parameter, and the string 'projects' as the second parameter

If not, it will return a a Paws::CodeBuild::ListProjectsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues