123 lines
5.4 KiB
Go
123 lines
5.4 KiB
Go
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
|
|
|
|
// Package codebuild provides the client and types for making API
|
|
// requests to 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 Apach
|
|
// 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:
|
|
//
|
|
// * 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.
|
|
//
|
|
// * DeleteProject: Deletes a build project.
|
|
//
|
|
// * 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.
|
|
//
|
|
// See https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06 for more information on this service.
|
|
//
|
|
// See codebuild package documentation for more information.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/service/codebuild/
|
|
//
|
|
// Using the Client
|
|
//
|
|
// To use the client for AWS CodeBuild you will first need
|
|
// to create a new instance of it.
|
|
//
|
|
// When creating a client for an AWS service you'll first need to have a Session
|
|
// already created. The Session provides configuration that can be shared
|
|
// between multiple service clients. Additional configuration can be applied to
|
|
// the Session and service's client when they are constructed. The aws package's
|
|
// Config type contains several fields such as Region for the AWS Region the
|
|
// client should make API requests too. The optional Config value can be provided
|
|
// as the variadic argument for Sessions and client creation.
|
|
//
|
|
// Once the service's client is created you can use it to make API requests the
|
|
// AWS service. These clients are safe to use concurrently.
|
|
//
|
|
// // Create a session to share configuration, and load external configuration.
|
|
// sess := session.Must(session.NewSession())
|
|
//
|
|
// // Create the service's client with the session.
|
|
// svc := codebuild.New(sess)
|
|
//
|
|
// See the SDK's documentation for more information on how to use service clients.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/
|
|
//
|
|
// See aws package's Config type for more information on configuration options.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
|
|
//
|
|
// See the AWS CodeBuild client CodeBuild for more
|
|
// information on creating the service's client.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/service/codebuild/#New
|
|
//
|
|
// Once the client is created you can make an API request to the service.
|
|
// Each API method takes a input parameter, and returns the service response
|
|
// and an error.
|
|
//
|
|
// The API method will document which error codes the service can be returned
|
|
// by the operation if the service models the API operation's errors. These
|
|
// errors will also be available as const strings prefixed with "ErrCode".
|
|
//
|
|
// result, err := svc.BatchGetBuilds(params)
|
|
// if err != nil {
|
|
// // Cast err to awserr.Error to handle specific error codes.
|
|
// aerr, ok := err.(awserr.Error)
|
|
// if ok && aerr.Code() == <error code to check for> {
|
|
// // Specific error code handling
|
|
// }
|
|
// return err
|
|
// }
|
|
//
|
|
// fmt.Println("BatchGetBuilds result:")
|
|
// fmt.Println(result)
|
|
//
|
|
// Using the Client with Context
|
|
//
|
|
// The service's client also provides methods to make API requests with a Context
|
|
// value. This allows you to control the timeout, and cancellation of pending
|
|
// requests. These methods also take request Option as variadic parameter to apply
|
|
// additional configuration to the API request.
|
|
//
|
|
// ctx := context.Background()
|
|
//
|
|
// result, err := svc.BatchGetBuildsWithContext(ctx, params)
|
|
//
|
|
// See the request package documentation for more information on using Context pattern
|
|
// with the SDK.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/aws/request/
|
|
package codebuild
|