133 lines
5.7 KiB
Go
133 lines
5.7 KiB
Go
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
|
|
|
|
// Package codedeploy provides the client and types for making API
|
|
// requests to AWS CodeDeploy.
|
|
//
|
|
// Overview
|
|
//
|
|
// This reference guide provides descriptions of the AWS CodeDeploy APIs. For
|
|
// more information about AWS CodeDeploy, see the AWS CodeDeploy User Guide
|
|
// (http://docs.aws.amazon.com/codedeploy/latest/userguide).
|
|
//
|
|
// Using the APIs
|
|
//
|
|
// You can use the AWS CodeDeploy APIs to work with the following:
|
|
//
|
|
// * Applications are unique identifiers used by AWS CodeDeploy to ensure
|
|
// the correct combinations of revisions, deployment configurations, and
|
|
// deployment groups are being referenced during deployments.
|
|
//
|
|
// You can use the AWS CodeDeploy APIs to create, delete, get, list, and update
|
|
// applications.
|
|
//
|
|
// * Deployment configurations are sets of deployment rules and success and
|
|
// failure conditions used by AWS CodeDeploy during deployments.
|
|
//
|
|
// You can use the AWS CodeDeploy APIs to create, delete, get, and list deployment
|
|
// configurations.
|
|
//
|
|
// * Deployment groups are groups of instances to which application revisions
|
|
// can be deployed.
|
|
//
|
|
// You can use the AWS CodeDeploy APIs to create, delete, get, list, and update
|
|
// deployment groups.
|
|
//
|
|
// * Instances represent Amazon EC2 instances to which application revisions
|
|
// are deployed. Instances are identified by their Amazon EC2 tags or Auto
|
|
// Scaling group names. Instances belong to deployment groups.
|
|
//
|
|
// You can use the AWS CodeDeploy APIs to get and list instance.
|
|
//
|
|
// * Deployments represent the process of deploying revisions to instances.
|
|
//
|
|
// You can use the AWS CodeDeploy APIs to create, get, list, and stop deployments.
|
|
//
|
|
// * Application revisions are archive files stored in Amazon S3 buckets
|
|
// or GitHub repositories. These revisions contain source content (such as
|
|
// source code, web pages, executable files, and deployment scripts) along
|
|
// with an application specification (AppSpec) file. (The AppSpec file is
|
|
// unique to AWS CodeDeploy; it defines the deployment actions you want AWS
|
|
// CodeDeploy to execute.) For application revisions stored in Amazon S3
|
|
// buckets, an application revision is uniquely identified by its Amazon
|
|
// S3 object key and its ETag, version, or both. For application revisions
|
|
// stored in GitHub repositories, an application revision is uniquely identified
|
|
// by its repository name and commit ID. Application revisions are deployed
|
|
// through deployment groups.
|
|
//
|
|
// You can use the AWS CodeDeploy APIs to get, list, and register application
|
|
// revisions.
|
|
//
|
|
// See https://docs.aws.amazon.com/goto/WebAPI/codedeploy-2014-10-06 for more information on this service.
|
|
//
|
|
// See codedeploy package documentation for more information.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/service/codedeploy/
|
|
//
|
|
// Using the Client
|
|
//
|
|
// To use the client for AWS CodeDeploy 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 := codedeploy.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 CodeDeploy client CodeDeploy for more
|
|
// information on creating the service's client.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/service/codedeploy/#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.AddTagsToOnPremisesInstances(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("AddTagsToOnPremisesInstances 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.AddTagsToOnPremisesInstancesWithContext(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 codedeploy
|