codepipeline

package
v1.1.24-0...-4367278 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 3, 2016 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package codepipeline provides a client for AWS CodePipeline.

Index

Examples

Constants

View Source 
const (
	// @enum ActionCategory
	ActionCategorySource = "Source"
	// @enum ActionCategory
	ActionCategoryBuild = "Build"
	// @enum ActionCategory
	ActionCategoryDeploy = "Deploy"
	// @enum ActionCategory
	ActionCategoryTest = "Test"
	// @enum ActionCategory
	ActionCategoryInvoke = "Invoke"
)
View Source 
const (
	// @enum ActionConfigurationPropertyType
	ActionConfigurationPropertyTypeString = "String"
	// @enum ActionConfigurationPropertyType
	ActionConfigurationPropertyTypeNumber = "Number"
	// @enum ActionConfigurationPropertyType
	ActionConfigurationPropertyTypeBoolean = "Boolean"
)
View Source 
const (
	// @enum ActionExecutionStatus
	ActionExecutionStatusInProgress = "InProgress"
	// @enum ActionExecutionStatus
	ActionExecutionStatusSucceeded = "Succeeded"
	// @enum ActionExecutionStatus
	ActionExecutionStatusFailed = "Failed"
)
View Source 
const (
	// @enum ActionOwner
	ActionOwnerAws = "AWS"
	// @enum ActionOwner
	ActionOwnerThirdParty = "ThirdParty"
	// @enum ActionOwner
	ActionOwnerCustom = "Custom"
)
View Source 
const (
	// @enum FailureType
	FailureTypeJobFailed = "JobFailed"
	// @enum FailureType
	FailureTypeConfigurationError = "ConfigurationError"
	// @enum FailureType
	FailureTypePermissionError = "PermissionError"
	// @enum FailureType
	FailureTypeRevisionOutOfSync = "RevisionOutOfSync"
	// @enum FailureType
	FailureTypeRevisionUnavailable = "RevisionUnavailable"
	// @enum FailureType
	FailureTypeSystemUnavailable = "SystemUnavailable"
)
View Source 
const (
	// @enum JobStatus
	JobStatusCreated = "Created"
	// @enum JobStatus
	JobStatusQueued = "Queued"
	// @enum JobStatus
	JobStatusDispatched = "Dispatched"
	// @enum JobStatus
	JobStatusInProgress = "InProgress"
	// @enum JobStatus
	JobStatusTimedOut = "TimedOut"
	// @enum JobStatus
	JobStatusSucceeded = "Succeeded"
	// @enum JobStatus
	JobStatusFailed = "Failed"
)
View Source 
const (
	// @enum StageTransitionType
	StageTransitionTypeInbound = "Inbound"
	// @enum StageTransitionType
	StageTransitionTypeOutbound = "Outbound"
)
View Source 
const (
	// @enum ArtifactLocationType
	ArtifactLocationTypeS3 = "S3"
)
View Source 
const (
	// @enum ArtifactStoreType
	ArtifactStoreTypeS3 = "S3"
)
View Source 
const (
	// @enum BlockerType
	BlockerTypeSchedule = "Schedule"
)
View Source 
const (
	// @enum EncryptionKeyType
	EncryptionKeyTypeKms = "KMS"
)
View Source 
const ServiceName = "codepipeline"

A ServiceName is the name of the service the client will make API calls to.

Variables

This section is empty.

Functions

This section is empty.

Types

type AWSSessionCredentials 

type AWSSessionCredentials struct {

	// The access key for the session.
	AccessKeyId *string `locationName:"accessKeyId" type:"string" required:"true"`

	// The secret access key for the session.
	SecretAccessKey *string `locationName:"secretAccessKey" type:"string" required:"true"`

	// The token for the session.
	SessionToken *string `locationName:"sessionToken" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline.

func (AWSSessionCredentials) GoString 

func (s AWSSessionCredentials) GoString() string

GoString returns the string representation

func (AWSSessionCredentials) String 

func (s AWSSessionCredentials) String() string

String returns the string representation

type AcknowledgeJobInput 

type AcknowledgeJobInput struct {

	// The unique system-generated ID of the job for which you want to confirm receipt.
	JobId *string `locationName:"jobId" type:"string" required:"true"`

	// A system-generated random number that AWS CodePipeline uses to ensure that
	// the job is being worked on by only one job worker. This number must be returned
	// in the response.
	Nonce *string `locationName:"nonce" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of an acknowledge job action.

func (AcknowledgeJobInput) GoString 

func (s AcknowledgeJobInput) GoString() string

GoString returns the string representation

func (AcknowledgeJobInput) String 

func (s AcknowledgeJobInput) String() string

String returns the string representation

func (*AcknowledgeJobInput) Validate 

func (s *AcknowledgeJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AcknowledgeJobOutput 

type AcknowledgeJobOutput struct {

	// Whether the job worker has received the specified job.
	Status *string `locationName:"status" type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

Represents the output of an acknowledge job action.

func (AcknowledgeJobOutput) GoString 

func (s AcknowledgeJobOutput) GoString() string

GoString returns the string representation

func (AcknowledgeJobOutput) String 

func (s AcknowledgeJobOutput) String() string

String returns the string representation

type AcknowledgeThirdPartyJobInput 

type AcknowledgeThirdPartyJobInput struct {

	// The clientToken portion of the clientId and clientToken pair used to verify
	// that the calling entity is allowed access to the job and its details.
	ClientToken *string `locationName:"clientToken" type:"string" required:"true"`

	// The unique system-generated ID of the job.
	JobId *string `locationName:"jobId" min:"1" type:"string" required:"true"`

	// A system-generated random number that AWS CodePipeline uses to ensure that
	// the job is being worked on by only one job worker. This number must be returned
	// in the response.
	Nonce *string `locationName:"nonce" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of an acknowledge third party job action.

func (AcknowledgeThirdPartyJobInput) GoString 

func (s AcknowledgeThirdPartyJobInput) GoString() string

GoString returns the string representation

func (AcknowledgeThirdPartyJobInput) String 

func (s AcknowledgeThirdPartyJobInput) String() string

String returns the string representation

func (*AcknowledgeThirdPartyJobInput) Validate 

func (s *AcknowledgeThirdPartyJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AcknowledgeThirdPartyJobOutput 

type AcknowledgeThirdPartyJobOutput struct {

	// The status information for the third party job, if any.
	Status *string `locationName:"status" type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

Represents the output of an acknowledge third party job action.

func (AcknowledgeThirdPartyJobOutput) GoString 

func (s AcknowledgeThirdPartyJobOutput) GoString() string

GoString returns the string representation

func (AcknowledgeThirdPartyJobOutput) String 

func (s AcknowledgeThirdPartyJobOutput) String() string

String returns the string representation

type ActionConfiguration 

type ActionConfiguration struct {

	// The configuration data for the action.
	Configuration map[string]*string `locationName:"configuration" type:"map"`
	// contains filtered or unexported fields
}

Represents information about an action configuration.

func (ActionConfiguration) GoString 

func (s ActionConfiguration) GoString() string

GoString returns the string representation

func (ActionConfiguration) String 

func (s ActionConfiguration) String() string

String returns the string representation

type ActionConfigurationProperty 

type ActionConfigurationProperty struct {

	// The description of the action configuration property that will be displayed
	// to users.
	Description *string `locationName:"description" min:"1" type:"string"`

	// Whether the configuration property is a key.
	Key *bool `locationName:"key" type:"boolean" required:"true"`

	// The name of the action configuration property.
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// Indicates that the proprety will be used in conjunction with PollForJobs.
	// When creating a custom action, an action can have up to one queryable property.
	// If it has one, that property must be both required and not secret.
	//
	// If you create a pipeline with a custom action type, and that custom action
	// contains a queryable property, the value for that configuration property
	// is subject to additional restrictions. The value must be less than or equal
	// to twenty (20) characters. The value can contain only alphanumeric characters,
	// underscores, and hyphens.
	Queryable *bool `locationName:"queryable" type:"boolean"`

	// Whether the configuration property is a required value.
	Required *bool `locationName:"required" type:"boolean" required:"true"`

	// Whether the configuration property is secret. Secrets are hidden from all
	// calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and
	// PollForThirdPartyJobs.
	//
	// When updating a pipeline, passing * * * * * without changing any other values
	// of the action will preserve the prior value of the secret.
	Secret *bool `locationName:"secret" type:"boolean" required:"true"`

	// The type of the configuration property.
	Type *string `locationName:"type" type:"string" enum:"ActionConfigurationPropertyType"`
	// contains filtered or unexported fields
}

Represents information about an action configuration property.

func (ActionConfigurationProperty) GoString 

func (s ActionConfigurationProperty) GoString() string

GoString returns the string representation

func (ActionConfigurationProperty) String 

func (s ActionConfigurationProperty) String() string

String returns the string representation

func (*ActionConfigurationProperty) Validate 

func (s *ActionConfigurationProperty) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ActionContext 

type ActionContext struct {

	// The name of the action within the context of a job.
	Name *string `locationName:"name" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the context of an action within the stage of a pipeline to a job worker.

func (ActionContext) GoString 

func (s ActionContext) GoString() string

GoString returns the string representation

func (ActionContext) String 

func (s ActionContext) String() string

String returns the string representation

type ActionDeclaration 

type ActionDeclaration struct {

	// The configuration information for the action type.
	ActionTypeId *ActionTypeId `locationName:"actionTypeId" type:"structure" required:"true"`

	// The action declaration's configuration.
	Configuration map[string]*string `locationName:"configuration" type:"map"`

	// The name or ID of the artifact consumed by the action, such as a test or
	// build artifact.
	InputArtifacts []*InputArtifact `locationName:"inputArtifacts" type:"list"`

	// The action declaration's name.
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The name or ID of the result of the action declaration, such as a test or
	// build artifact.
	OutputArtifacts []*OutputArtifact `locationName:"outputArtifacts" type:"list"`

	// The ARN of the IAM service role that will perform the declared action. This
	// is assumed through the roleArn for the pipeline.
	RoleArn *string `locationName:"roleArn" type:"string"`

	// The order in which actions are run.
	RunOrder *int64 `locationName:"runOrder" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Represents information about an action declaration.

func (ActionDeclaration) GoString 

func (s ActionDeclaration) GoString() string

GoString returns the string representation

func (ActionDeclaration) String 

func (s ActionDeclaration) String() string

String returns the string representation

func (*ActionDeclaration) Validate 

func (s *ActionDeclaration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ActionExecution 

type ActionExecution struct {

	// The details of an error returned by a URL external to AWS.
	ErrorDetails *ErrorDetails `locationName:"errorDetails" type:"structure"`

	// The external ID of the run of the action.
	ExternalExecutionId *string `locationName:"externalExecutionId" min:"1" type:"string"`

	// The URL of a resource external to AWS that will be used when running the
	// action, for example an external repository URL.
	ExternalExecutionUrl *string `locationName:"externalExecutionUrl" min:"1" type:"string"`

	// The last status change of the action.
	LastStatusChange *time.Time `locationName:"lastStatusChange" type:"timestamp" timestampFormat:"unix"`

	// A percentage of completeness of the action as it runs.
	PercentComplete *int64 `locationName:"percentComplete" type:"integer"`

	// The status of the action, or for a completed action, the last status of the
	// action.
	Status *string `locationName:"status" type:"string" enum:"ActionExecutionStatus"`

	// A summary of the run of the action.
	Summary *string `locationName:"summary" type:"string"`
	// contains filtered or unexported fields
}

Represents information about how an action runs.

func (ActionExecution) GoString 

func (s ActionExecution) GoString() string

GoString returns the string representation

func (ActionExecution) String 

func (s ActionExecution) String() string

String returns the string representation

type ActionRevision 

type ActionRevision struct {

	// The date and time when the most recent version of the action was created,
	// in timestamp format.
	Created *time.Time `locationName:"created" type:"timestamp" timestampFormat:"unix" required:"true"`

	// The unique identifier of the change that set the state to this revision,
	// for example a deployment ID or timestamp.
	RevisionChangeId *string `locationName:"revisionChangeId" min:"1" type:"string" required:"true"`

	// The system-generated unique ID that identifies the revision number of the
	// action.
	RevisionId *string `locationName:"revisionId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents information about the version (or revision) of an action.

func (ActionRevision) GoString 

func (s ActionRevision) GoString() string

GoString returns the string representation

func (ActionRevision) String 

func (s ActionRevision) String() string

String returns the string representation

func (*ActionRevision) Validate 

func (s *ActionRevision) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ActionState 

type ActionState struct {

	// The name of the action.
	ActionName *string `locationName:"actionName" min:"1" type:"string"`

	// Represents information about the version (or revision) of an action.
	CurrentRevision *ActionRevision `locationName:"currentRevision" type:"structure"`

	// A URL link for more information about the state of the action, such as a
	// deployment group details page.
	EntityUrl *string `locationName:"entityUrl" min:"1" type:"string"`

	// Represents information about how an action runs.
	LatestExecution *ActionExecution `locationName:"latestExecution" type:"structure"`

	// A URL link for more information about the revision, such as a commit details
	// page.
	RevisionUrl *string `locationName:"revisionUrl" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents information about the state of an action.

func (ActionState) GoString 

func (s ActionState) GoString() string

GoString returns the string representation

func (ActionState) String 

func (s ActionState) String() string

String returns the string representation

type ActionType 

type ActionType struct {

	// The configuration properties for the action type.
	ActionConfigurationProperties []*ActionConfigurationProperty `locationName:"actionConfigurationProperties" type:"list"`

	// Represents information about an action type.
	Id *ActionTypeId `locationName:"id" type:"structure" required:"true"`

	// The details of the input artifact for the action, such as its commit ID.
	InputArtifactDetails *ArtifactDetails `locationName:"inputArtifactDetails" type:"structure" required:"true"`

	// The details of the output artifact of the action, such as its commit ID.
	OutputArtifactDetails *ArtifactDetails `locationName:"outputArtifactDetails" type:"structure" required:"true"`

	// The settings for the action type.
	Settings *ActionTypeSettings `locationName:"settings" type:"structure"`
	// contains filtered or unexported fields
}

Returns information about the details of an action type.

func (ActionType) GoString 

func (s ActionType) GoString() string

GoString returns the string representation

func (ActionType) String 

func (s ActionType) String() string

String returns the string representation

type ActionTypeId 

type ActionTypeId struct {

	// A category defines what kind of action can be taken in the stage, and constrains
	// the provider type for the action. Valid categories are limited to one of
	// the values below.
	Category *string `locationName:"category" type:"string" required:"true" enum:"ActionCategory"`

	// The creator of the action being called.
	Owner *string `locationName:"owner" type:"string" required:"true" enum:"ActionOwner"`

	// The provider of the service being called by the action. Valid providers are
	// determined by the action category. For example, an action in the Deploy category
	// type might have a provider of AWS CodeDeploy, which would be specified as
	// CodeDeploy.
	Provider *string `locationName:"provider" min:"1" type:"string" required:"true"`

	// A string that identifies the action type.
	Version *string `locationName:"version" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents information about an action type.

func (ActionTypeId) GoString 

func (s ActionTypeId) GoString() string

GoString returns the string representation

func (ActionTypeId) String 

func (s ActionTypeId) String() string

String returns the string representation

func (*ActionTypeId) Validate 

func (s *ActionTypeId) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ActionTypeSettings 

type ActionTypeSettings struct {

	// The URL returned to the AWS CodePipeline console that provides a deep link
	// to the resources of the external system, such as the configuration page for
	// an AWS CodeDeploy deployment group. This link is provided as part of the
	// action display within the pipeline.
	EntityUrlTemplate *string `locationName:"entityUrlTemplate" min:"1" type:"string"`

	// The URL returned to the AWS CodePipeline console that contains a link to
	// the top-level landing page for the external system, such as console page
	// for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS
	// CodePipeline console and provides a link to the execution entity of the external
	// action.
	ExecutionUrlTemplate *string `locationName:"executionUrlTemplate" min:"1" type:"string"`

	// The URL returned to the AWS CodePipeline console that contains a link to
	// the page where customers can update or change the configuration of the external
	// action.
	RevisionUrlTemplate *string `locationName:"revisionUrlTemplate" min:"1" type:"string"`

	// The URL of a sign-up page where users can sign up for an external service
	// and perform initial configuration of the action provided by that service.
	ThirdPartyConfigurationUrl *string `locationName:"thirdPartyConfigurationUrl" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Returns information about the settings for an action type.

func (ActionTypeSettings) GoString 

func (s ActionTypeSettings) GoString() string

GoString returns the string representation

func (ActionTypeSettings) String 

func (s ActionTypeSettings) String() string

String returns the string representation

func (*ActionTypeSettings) Validate 

func (s *ActionTypeSettings) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Artifact 

type Artifact struct {

	// The location of an artifact.
	Location *ArtifactLocation `locationName:"location" type:"structure"`

	// The artifact's name.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The artifact's revision ID. Depending on the type of object, this could be
	// a commit ID (GitHub) or a revision ID (Amazon S3).
	Revision *string `locationName:"revision" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents information about an artifact that will be worked upon by actions in the pipeline.

func (Artifact) GoString 

func (s Artifact) GoString() string

GoString returns the string representation

func (Artifact) String 

func (s Artifact) String() string

String returns the string representation

type ArtifactDetails 

type ArtifactDetails struct {

	// The maximum number of artifacts allowed for the action type.
	MaximumCount *int64 `locationName:"maximumCount" type:"integer" required:"true"`

	// The minimum number of artifacts allowed for the action type.
	MinimumCount *int64 `locationName:"minimumCount" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Returns information about the details of an artifact.

func (ArtifactDetails) GoString 

func (s ArtifactDetails) GoString() string

GoString returns the string representation

func (ArtifactDetails) String 

func (s ArtifactDetails) String() string

String returns the string representation

func (*ArtifactDetails) Validate 

func (s *ArtifactDetails) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ArtifactLocation 

type ArtifactLocation struct {

	// The Amazon S3 bucket that contains the artifact.
	S3Location *S3ArtifactLocation `locationName:"s3Location" type:"structure"`

	// The type of artifact in the location.
	Type *string `locationName:"type" type:"string" enum:"ArtifactLocationType"`
	// contains filtered or unexported fields
}

Represents information about the location of an artifact.

func (ArtifactLocation) GoString 

func (s ArtifactLocation) GoString() string

GoString returns the string representation

func (ArtifactLocation) String 

func (s ArtifactLocation) String() string

String returns the string representation

type ArtifactStore 

type ArtifactStore struct {

	// The encryption key used to encrypt the data in the artifact store, such as
	// an AWS Key Management Service (AWS KMS) key. If this is undefined, the default
	// key for Amazon S3 is used.
	EncryptionKey *EncryptionKey `locationName:"encryptionKey" type:"structure"`

	// The location for storing the artifacts for a pipeline, such as an S3 bucket
	// or folder.
	Location *string `locationName:"location" min:"3" type:"string" required:"true"`

	// The type of the artifact store, such as S3.
	Type *string `locationName:"type" type:"string" required:"true" enum:"ArtifactStoreType"`
	// contains filtered or unexported fields
}

The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts (http://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#CPS3Bucket).

func (ArtifactStore) GoString 

func (s ArtifactStore) GoString() string

GoString returns the string representation

func (ArtifactStore) String 

func (s ArtifactStore) String() string

String returns the string representation

func (*ArtifactStore) Validate 

func (s *ArtifactStore) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BlockerDeclaration 

type BlockerDeclaration struct {

	// Reserved for future use.
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// Reserved for future use.
	Type *string `locationName:"type" type:"string" required:"true" enum:"BlockerType"`
	// contains filtered or unexported fields
}

Reserved for future use.

func (BlockerDeclaration) GoString 

func (s BlockerDeclaration) GoString() string

GoString returns the string representation

func (BlockerDeclaration) String 

func (s BlockerDeclaration) String() string

String returns the string representation

func (*BlockerDeclaration) Validate 

func (s *BlockerDeclaration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CodePipeline 

type CodePipeline struct {
	*client.Client
}

Overview This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the AWS CodePipeline User Guide (http://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html).

You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below.

Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages.

You can work with pipelines by calling: CreatePipeline, which creates a uniquely-named pipeline. DeletePipeline, which deletes the specified pipeline. GetPipeline, which returns information about a pipeline structure. GetPipelineState, which returns information about the current state of the stages and actions of a pipeline. ListPipelines, which gets a summary of all of the pipelines associated with your account. StartPipelineExecution, which runs the the most recent revision of an artifact through the pipeline. UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.

Pipelines include stages, which are which are logical groupings of gates and actions. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, also refer to the AWS CodePipeline Pipeline Structure Reference (http://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html).

Pipeline stages include actions, which are categorized into categories such as source or build actions performed within a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState.

Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.

You can work with transitions by calling: 

DisableStageTransition, which prevents artifacts from transitioning to

the next stage in a pipeline. EnableStageTransition, which enables transition of artifacts between stages in a pipeline. Using the API to integrate with AWS CodePipeline

For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. In order to integrate with AWS CodePipeline, developers will need to work with the following items: 

Jobs, which are instances of an action. For example, a job for a source

action might import a revision of an artifact from a source. You can work with jobs by calling: 

AcknowledgeJob, which confirms whether a job worker has received the specified

job, GetJobDetails, which returns the details of a job, PollForJobs, which determines whether there are any jobs to act upon, PutJobFailureResult, which provides details of a job failure, and PutJobSuccessResult, which provides details of a job success. Third party jobs, which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network. You can work with third party jobs by calling:

AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job, GetThirdPartyJobDetails, which requests the details of a job for a partner action, PollForThirdPartyJobs, which determines whether there are any jobs to act upon, PutThirdPartyJobFailureResult, which provides details of a job failure, and PutThirdPartyJobSuccessResult, which provides details of a job success. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *CodePipeline

New creates a new instance of the CodePipeline client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a CodePipeline client from just a session.
svc := codepipeline.New(mySession)

// Create a CodePipeline client with additional configuration
svc := codepipeline.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CodePipeline) AcknowledgeJob 

func (c *CodePipeline) AcknowledgeJob(input *AcknowledgeJobInput) (*AcknowledgeJobOutput, error)

Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.AcknowledgeJobInput{
		JobId: aws.String("JobId"), // Required
		Nonce: aws.String("Nonce"), // Required
	}
	resp, err := svc.AcknowledgeJob(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) AcknowledgeJobRequest 

func (c *CodePipeline) AcknowledgeJobRequest(input *AcknowledgeJobInput) (req *request.Request, output *AcknowledgeJobOutput)

AcknowledgeJobRequest generates a request for the AcknowledgeJob operation.

func (*CodePipeline) AcknowledgeThirdPartyJob 

func (c *CodePipeline) AcknowledgeThirdPartyJob(input *AcknowledgeThirdPartyJobInput) (*AcknowledgeThirdPartyJobOutput, error)

Confirms a job worker has received the specified job. Only used for partner actions.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.AcknowledgeThirdPartyJobInput{
		ClientToken: aws.String("ClientToken"),     // Required
		JobId:       aws.String("ThirdPartyJobId"), // Required
		Nonce:       aws.String("Nonce"),           // Required
	}
	resp, err := svc.AcknowledgeThirdPartyJob(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) AcknowledgeThirdPartyJobRequest 

func (c *CodePipeline) AcknowledgeThirdPartyJobRequest(input *AcknowledgeThirdPartyJobInput) (req *request.Request, output *AcknowledgeThirdPartyJobOutput)

AcknowledgeThirdPartyJobRequest generates a request for the AcknowledgeThirdPartyJob operation.

func (*CodePipeline) CreateCustomActionType 

func (c *CodePipeline) CreateCustomActionType(input *CreateCustomActionTypeInput) (*CreateCustomActionTypeOutput, error)

Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.CreateCustomActionTypeInput{
		Category: aws.String("ActionCategory"), // Required
		InputArtifactDetails: &codepipeline.ArtifactDetails{ // Required
			MaximumCount: aws.Int64(1), // Required
			MinimumCount: aws.Int64(1), // Required
		},
		OutputArtifactDetails: &codepipeline.ArtifactDetails{ // Required
			MaximumCount: aws.Int64(1), // Required
			MinimumCount: aws.Int64(1), // Required
		},
		Provider: aws.String("ActionProvider"), // Required
		Version:  aws.String("Version"),        // Required
		ConfigurationProperties: []*codepipeline.ActionConfigurationProperty{
			&codepipeline.ActionConfigurationProperty{ // Required
				Key:         aws.Bool(true),                       // Required
				Name:        aws.String("ActionConfigurationKey"), // Required
				Required:    aws.Bool(true),                       // Required
				Secret:      aws.Bool(true),                       // Required
				Description: aws.String("Description"),
				Queryable:   aws.Bool(true),
				Type:        aws.String("ActionConfigurationPropertyType"),
			},
			// More values...
		},
		Settings: &codepipeline.ActionTypeSettings{
			EntityUrlTemplate:          aws.String("UrlTemplate"),
			ExecutionUrlTemplate:       aws.String("UrlTemplate"),
			RevisionUrlTemplate:        aws.String("UrlTemplate"),
			ThirdPartyConfigurationUrl: aws.String("Url"),
		},
	}
	resp, err := svc.CreateCustomActionType(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) CreateCustomActionTypeRequest 

func (c *CodePipeline) CreateCustomActionTypeRequest(input *CreateCustomActionTypeInput) (req *request.Request, output *CreateCustomActionTypeOutput)

CreateCustomActionTypeRequest generates a request for the CreateCustomActionType operation.

func (*CodePipeline) CreatePipeline 

func (c *CodePipeline) CreatePipeline(input *CreatePipelineInput) (*CreatePipelineOutput, error)

Creates a pipeline.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.CreatePipelineInput{
		Pipeline: &codepipeline.PipelineDeclaration{ // Required
			ArtifactStore: &codepipeline.ArtifactStore{ // Required
				Location: aws.String("ArtifactStoreLocation"), // Required
				Type:     aws.String("ArtifactStoreType"),     // Required
				EncryptionKey: &codepipeline.EncryptionKey{
					Id:   aws.String("EncryptionKeyId"),   // Required
					Type: aws.String("EncryptionKeyType"), // Required
				},
			},
			Name:    aws.String("PipelineName"), // Required
			RoleArn: aws.String("RoleArn"),      // Required
			Stages: []*codepipeline.StageDeclaration{ // Required
				&codepipeline.StageDeclaration{ // Required
					Actions: []*codepipeline.ActionDeclaration{ // Required
						&codepipeline.ActionDeclaration{ // Required
							ActionTypeId: &codepipeline.ActionTypeId{ // Required
								Category: aws.String("ActionCategory"), // Required
								Owner:    aws.String("ActionOwner"),    // Required
								Provider: aws.String("ActionProvider"), // Required
								Version:  aws.String("Version"),        // Required
							},
							Name: aws.String("ActionName"), // Required
							Configuration: map[string]*string{
								"Key": aws.String("ActionConfigurationValue"), // Required
								// More values...
							},
							InputArtifacts: []*codepipeline.InputArtifact{
								&codepipeline.InputArtifact{ // Required
									Name: aws.String("ArtifactName"), // Required
								},
								// More values...
							},
							OutputArtifacts: []*codepipeline.OutputArtifact{
								&codepipeline.OutputArtifact{ // Required
									Name: aws.String("ArtifactName"), // Required
								},
								// More values...
							},
							RoleArn:  aws.String("RoleArn"),
							RunOrder: aws.Int64(1),
						},
						// More values...
					},
					Name: aws.String("StageName"), // Required
					Blockers: []*codepipeline.BlockerDeclaration{
						&codepipeline.BlockerDeclaration{ // Required
							Name: aws.String("BlockerName"), // Required
							Type: aws.String("BlockerType"), // Required
						},
						// More values...
					},
				},
				// More values...
			},
			Version: aws.Int64(1),
		},
	}
	resp, err := svc.CreatePipeline(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) CreatePipelineRequest 

func (c *CodePipeline) CreatePipelineRequest(input *CreatePipelineInput) (req *request.Request, output *CreatePipelineOutput)

CreatePipelineRequest generates a request for the CreatePipeline operation.

func (*CodePipeline) DeleteCustomActionType 

func (c *CodePipeline) DeleteCustomActionType(input *DeleteCustomActionTypeInput) (*DeleteCustomActionTypeOutput, error)

Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.

You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.DeleteCustomActionTypeInput{
		Category: aws.String("ActionCategory"), // Required
		Provider: aws.String("ActionProvider"), // Required
		Version:  aws.String("Version"),        // Required
	}
	resp, err := svc.DeleteCustomActionType(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) DeleteCustomActionTypeRequest 

func (c *CodePipeline) DeleteCustomActionTypeRequest(input *DeleteCustomActionTypeInput) (req *request.Request, output *DeleteCustomActionTypeOutput)

DeleteCustomActionTypeRequest generates a request for the DeleteCustomActionType operation.

func (*CodePipeline) DeletePipeline 

func (c *CodePipeline) DeletePipeline(input *DeletePipelineInput) (*DeletePipelineOutput, error)

Deletes the specified pipeline.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.DeletePipelineInput{
		Name: aws.String("PipelineName"), // Required
	}
	resp, err := svc.DeletePipeline(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) DeletePipelineRequest 

func (c *CodePipeline) DeletePipelineRequest(input *DeletePipelineInput) (req *request.Request, output *DeletePipelineOutput)

DeletePipelineRequest generates a request for the DeletePipeline operation.

func (*CodePipeline) DisableStageTransition 

func (c *CodePipeline) DisableStageTransition(input *DisableStageTransitionInput) (*DisableStageTransitionOutput, error)

Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.DisableStageTransitionInput{
		PipelineName:   aws.String("PipelineName"),        // Required
		Reason:         aws.String("DisabledReason"),      // Required
		StageName:      aws.String("StageName"),           // Required
		TransitionType: aws.String("StageTransitionType"), // Required
	}
	resp, err := svc.DisableStageTransition(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) DisableStageTransitionRequest 

func (c *CodePipeline) DisableStageTransitionRequest(input *DisableStageTransitionInput) (req *request.Request, output *DisableStageTransitionOutput)

DisableStageTransitionRequest generates a request for the DisableStageTransition operation.

func (*CodePipeline) EnableStageTransition 

func (c *CodePipeline) EnableStageTransition(input *EnableStageTransitionInput) (*EnableStageTransitionOutput, error)

Enables artifacts in a pipeline to transition to a stage in a pipeline.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.EnableStageTransitionInput{
		PipelineName:   aws.String("PipelineName"),        // Required
		StageName:      aws.String("StageName"),           // Required
		TransitionType: aws.String("StageTransitionType"), // Required
	}
	resp, err := svc.EnableStageTransition(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) EnableStageTransitionRequest 

func (c *CodePipeline) EnableStageTransitionRequest(input *EnableStageTransitionInput) (req *request.Request, output *EnableStageTransitionOutput)

EnableStageTransitionRequest generates a request for the EnableStageTransition operation.

func (*CodePipeline) GetJobDetails 

func (c *CodePipeline) GetJobDetails(input *GetJobDetailsInput) (*GetJobDetailsOutput, error)

Returns information about a job. Only used for custom actions.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.GetJobDetailsInput{
		JobId: aws.String("JobId"), // Required
	}
	resp, err := svc.GetJobDetails(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) GetJobDetailsRequest 

func (c *CodePipeline) GetJobDetailsRequest(input *GetJobDetailsInput) (req *request.Request, output *GetJobDetailsOutput)

GetJobDetailsRequest generates a request for the GetJobDetails operation.

func (*CodePipeline) GetPipeline 

func (c *CodePipeline) GetPipeline(input *GetPipelineInput) (*GetPipelineOutput, error)

Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.GetPipelineInput{
		Name:    aws.String("PipelineName"), // Required
		Version: aws.Int64(1),
	}
	resp, err := svc.GetPipeline(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) GetPipelineRequest 

func (c *CodePipeline) GetPipelineRequest(input *GetPipelineInput) (req *request.Request, output *GetPipelineOutput)

GetPipelineRequest generates a request for the GetPipeline operation.

func (*CodePipeline) GetPipelineState 

func (c *CodePipeline) GetPipelineState(input *GetPipelineStateInput) (*GetPipelineStateOutput, error)

Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.GetPipelineStateInput{
		Name: aws.String("PipelineName"), // Required
	}
	resp, err := svc.GetPipelineState(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) GetPipelineStateRequest 

func (c *CodePipeline) GetPipelineStateRequest(input *GetPipelineStateInput) (req *request.Request, output *GetPipelineStateOutput)

GetPipelineStateRequest generates a request for the GetPipelineState operation.

func (*CodePipeline) GetThirdPartyJobDetails 

func (c *CodePipeline) GetThirdPartyJobDetails(input *GetThirdPartyJobDetailsInput) (*GetThirdPartyJobDetailsOutput, error)

Requests the details of a job for a third party action. Only used for partner actions.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.GetThirdPartyJobDetailsInput{
		ClientToken: aws.String("ClientToken"),     // Required
		JobId:       aws.String("ThirdPartyJobId"), // Required
	}
	resp, err := svc.GetThirdPartyJobDetails(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) GetThirdPartyJobDetailsRequest 

func (c *CodePipeline) GetThirdPartyJobDetailsRequest(input *GetThirdPartyJobDetailsInput) (req *request.Request, output *GetThirdPartyJobDetailsOutput)

GetThirdPartyJobDetailsRequest generates a request for the GetThirdPartyJobDetails operation.

func (*CodePipeline) ListActionTypes 

func (c *CodePipeline) ListActionTypes(input *ListActionTypesInput) (*ListActionTypesOutput, error)

Gets a summary of all AWS CodePipeline action types associated with your account.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.ListActionTypesInput{
		ActionOwnerFilter: aws.String("ActionOwner"),
		NextToken:         aws.String("NextToken"),
	}
	resp, err := svc.ListActionTypes(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) ListActionTypesRequest 

func (c *CodePipeline) ListActionTypesRequest(input *ListActionTypesInput) (req *request.Request, output *ListActionTypesOutput)

ListActionTypesRequest generates a request for the ListActionTypes operation.

func (*CodePipeline) ListPipelines 

func (c *CodePipeline) ListPipelines(input *ListPipelinesInput) (*ListPipelinesOutput, error)

Gets a summary of all of the pipelines associated with your account.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.ListPipelinesInput{
		NextToken: aws.String("NextToken"),
	}
	resp, err := svc.ListPipelines(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) ListPipelinesRequest 

func (c *CodePipeline) ListPipelinesRequest(input *ListPipelinesInput) (req *request.Request, output *ListPipelinesOutput)

ListPipelinesRequest generates a request for the ListPipelines operation.

func (*CodePipeline) PollForJobs 

func (c *CodePipeline) PollForJobs(input *PollForJobsInput) (*PollForJobsOutput, error)

Returns information about any jobs for AWS CodePipeline to act upon.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.PollForJobsInput{
		ActionTypeId: &codepipeline.ActionTypeId{ // Required
			Category: aws.String("ActionCategory"), // Required
			Owner:    aws.String("ActionOwner"),    // Required
			Provider: aws.String("ActionProvider"), // Required
			Version:  aws.String("Version"),        // Required
		},
		MaxBatchSize: aws.Int64(1),
		QueryParam: map[string]*string{
			"Key": aws.String("ActionConfigurationQueryableValue"), // Required
			// More values...
		},
	}
	resp, err := svc.PollForJobs(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) PollForJobsRequest 

func (c *CodePipeline) PollForJobsRequest(input *PollForJobsInput) (req *request.Request, output *PollForJobsOutput)

PollForJobsRequest generates a request for the PollForJobs operation.

func (*CodePipeline) PollForThirdPartyJobs 

func (c *CodePipeline) PollForThirdPartyJobs(input *PollForThirdPartyJobsInput) (*PollForThirdPartyJobsOutput, error)

Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.PollForThirdPartyJobsInput{
		ActionTypeId: &codepipeline.ActionTypeId{ // Required
			Category: aws.String("ActionCategory"), // Required
			Owner:    aws.String("ActionOwner"),    // Required
			Provider: aws.String("ActionProvider"), // Required
			Version:  aws.String("Version"),        // Required
		},
		MaxBatchSize: aws.Int64(1),
	}
	resp, err := svc.PollForThirdPartyJobs(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) PollForThirdPartyJobsRequest 

func (c *CodePipeline) PollForThirdPartyJobsRequest(input *PollForThirdPartyJobsInput) (req *request.Request, output *PollForThirdPartyJobsOutput)

PollForThirdPartyJobsRequest generates a request for the PollForThirdPartyJobs operation.

func (*CodePipeline) PutActionRevision 

func (c *CodePipeline) PutActionRevision(input *PutActionRevisionInput) (*PutActionRevisionOutput, error)

Provides information to AWS CodePipeline about new revisions to a source.

Example 
package main

import (
	"fmt"
	"time"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.PutActionRevisionInput{
		ActionName: aws.String("ActionName"), // Required
		ActionRevision: &codepipeline.ActionRevision{ // Required
			Created:          aws.Time(time.Now()),                   // Required
			RevisionChangeId: aws.String("RevisionChangeIdentifier"), // Required
			RevisionId:       aws.String("Revision"),                 // Required
		},
		PipelineName: aws.String("PipelineName"), // Required
		StageName:    aws.String("StageName"),    // Required
	}
	resp, err := svc.PutActionRevision(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) PutActionRevisionRequest 

func (c *CodePipeline) PutActionRevisionRequest(input *PutActionRevisionInput) (req *request.Request, output *PutActionRevisionOutput)

PutActionRevisionRequest generates a request for the PutActionRevision operation.

func (*CodePipeline) PutJobFailureResult 

func (c *CodePipeline) PutJobFailureResult(input *PutJobFailureResultInput) (*PutJobFailureResultOutput, error)

Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.PutJobFailureResultInput{
		FailureDetails: &codepipeline.FailureDetails{ // Required
			Message:             aws.String("Message"),     // Required
			Type:                aws.String("FailureType"), // Required
			ExternalExecutionId: aws.String("ExecutionId"),
		},
		JobId: aws.String("JobId"), // Required
	}
	resp, err := svc.PutJobFailureResult(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) PutJobFailureResultRequest 

func (c *CodePipeline) PutJobFailureResultRequest(input *PutJobFailureResultInput) (req *request.Request, output *PutJobFailureResultOutput)

PutJobFailureResultRequest generates a request for the PutJobFailureResult operation.

func (*CodePipeline) PutJobSuccessResult 

func (c *CodePipeline) PutJobSuccessResult(input *PutJobSuccessResultInput) (*PutJobSuccessResultOutput, error)

Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.PutJobSuccessResultInput{
		JobId:             aws.String("JobId"), // Required
		ContinuationToken: aws.String("ContinuationToken"),
		CurrentRevision: &codepipeline.CurrentRevision{
			ChangeIdentifier: aws.String("RevisionChangeIdentifier"), // Required
			Revision:         aws.String("Revision"),                 // Required
		},
		ExecutionDetails: &codepipeline.ExecutionDetails{
			ExternalExecutionId: aws.String("ExecutionId"),
			PercentComplete:     aws.Int64(1),
			Summary:             aws.String("ExecutionSummary"),
		},
	}
	resp, err := svc.PutJobSuccessResult(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) PutJobSuccessResultRequest 

func (c *CodePipeline) PutJobSuccessResultRequest(input *PutJobSuccessResultInput) (req *request.Request, output *PutJobSuccessResultOutput)

PutJobSuccessResultRequest generates a request for the PutJobSuccessResult operation.

func (*CodePipeline) PutThirdPartyJobFailureResult 

func (c *CodePipeline) PutThirdPartyJobFailureResult(input *PutThirdPartyJobFailureResultInput) (*PutThirdPartyJobFailureResultOutput, error)

Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.PutThirdPartyJobFailureResultInput{
		ClientToken: aws.String("ClientToken"), // Required
		FailureDetails: &codepipeline.FailureDetails{ // Required
			Message:             aws.String("Message"),     // Required
			Type:                aws.String("FailureType"), // Required
			ExternalExecutionId: aws.String("ExecutionId"),
		},
		JobId: aws.String("ThirdPartyJobId"), // Required
	}
	resp, err := svc.PutThirdPartyJobFailureResult(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) PutThirdPartyJobFailureResultRequest 

func (c *CodePipeline) PutThirdPartyJobFailureResultRequest(input *PutThirdPartyJobFailureResultInput) (req *request.Request, output *PutThirdPartyJobFailureResultOutput)

PutThirdPartyJobFailureResultRequest generates a request for the PutThirdPartyJobFailureResult operation.

func (*CodePipeline) PutThirdPartyJobSuccessResult 

func (c *CodePipeline) PutThirdPartyJobSuccessResult(input *PutThirdPartyJobSuccessResultInput) (*PutThirdPartyJobSuccessResultOutput, error)

Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.PutThirdPartyJobSuccessResultInput{
		ClientToken:       aws.String("ClientToken"),     // Required
		JobId:             aws.String("ThirdPartyJobId"), // Required
		ContinuationToken: aws.String("ContinuationToken"),
		CurrentRevision: &codepipeline.CurrentRevision{
			ChangeIdentifier: aws.String("RevisionChangeIdentifier"), // Required
			Revision:         aws.String("Revision"),                 // Required
		},
		ExecutionDetails: &codepipeline.ExecutionDetails{
			ExternalExecutionId: aws.String("ExecutionId"),
			PercentComplete:     aws.Int64(1),
			Summary:             aws.String("ExecutionSummary"),
		},
	}
	resp, err := svc.PutThirdPartyJobSuccessResult(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) PutThirdPartyJobSuccessResultRequest 

func (c *CodePipeline) PutThirdPartyJobSuccessResultRequest(input *PutThirdPartyJobSuccessResultInput) (req *request.Request, output *PutThirdPartyJobSuccessResultOutput)

PutThirdPartyJobSuccessResultRequest generates a request for the PutThirdPartyJobSuccessResult operation.

func (*CodePipeline) StartPipelineExecution 

func (c *CodePipeline) StartPipelineExecution(input *StartPipelineExecutionInput) (*StartPipelineExecutionOutput, error)

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.StartPipelineExecutionInput{
		Name: aws.String("PipelineName"), // Required
	}
	resp, err := svc.StartPipelineExecution(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) StartPipelineExecutionRequest 

func (c *CodePipeline) StartPipelineExecutionRequest(input *StartPipelineExecutionInput) (req *request.Request, output *StartPipelineExecutionOutput)

StartPipelineExecutionRequest generates a request for the StartPipelineExecution operation.

func (*CodePipeline) UpdatePipeline 

func (c *CodePipeline) UpdatePipeline(input *UpdatePipelineInput) (*UpdatePipelineOutput, error)

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/codepipeline"
)

func main() {
	svc := codepipeline.New(session.New())

	params := &codepipeline.UpdatePipelineInput{
		Pipeline: &codepipeline.PipelineDeclaration{ // Required
			ArtifactStore: &codepipeline.ArtifactStore{ // Required
				Location: aws.String("ArtifactStoreLocation"), // Required
				Type:     aws.String("ArtifactStoreType"),     // Required
				EncryptionKey: &codepipeline.EncryptionKey{
					Id:   aws.String("EncryptionKeyId"),   // Required
					Type: aws.String("EncryptionKeyType"), // Required
				},
			},
			Name:    aws.String("PipelineName"), // Required
			RoleArn: aws.String("RoleArn"),      // Required
			Stages: []*codepipeline.StageDeclaration{ // Required
				&codepipeline.StageDeclaration{ // Required
					Actions: []*codepipeline.ActionDeclaration{ // Required
						&codepipeline.ActionDeclaration{ // Required
							ActionTypeId: &codepipeline.ActionTypeId{ // Required
								Category: aws.String("ActionCategory"), // Required
								Owner:    aws.String("ActionOwner"),    // Required
								Provider: aws.String("ActionProvider"), // Required
								Version:  aws.String("Version"),        // Required
							},
							Name: aws.String("ActionName"), // Required
							Configuration: map[string]*string{
								"Key": aws.String("ActionConfigurationValue"), // Required
								// More values...
							},
							InputArtifacts: []*codepipeline.InputArtifact{
								&codepipeline.InputArtifact{ // Required
									Name: aws.String("ArtifactName"), // Required
								},
								// More values...
							},
							OutputArtifacts: []*codepipeline.OutputArtifact{
								&codepipeline.OutputArtifact{ // Required
									Name: aws.String("ArtifactName"), // Required
								},
								// More values...
							},
							RoleArn:  aws.String("RoleArn"),
							RunOrder: aws.Int64(1),
						},
						// More values...
					},
					Name: aws.String("StageName"), // Required
					Blockers: []*codepipeline.BlockerDeclaration{
						&codepipeline.BlockerDeclaration{ // Required
							Name: aws.String("BlockerName"), // Required
							Type: aws.String("BlockerType"), // Required
						},
						// More values...
					},
				},
				// More values...
			},
			Version: aws.Int64(1),
		},
	}
	resp, err := svc.UpdatePipeline(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CodePipeline) UpdatePipelineRequest 

func (c *CodePipeline) UpdatePipelineRequest(input *UpdatePipelineInput) (req *request.Request, output *UpdatePipelineOutput)

UpdatePipelineRequest generates a request for the UpdatePipeline operation.

type CreateCustomActionTypeInput 

type CreateCustomActionTypeInput struct {

	// The category of the custom action, such as a source action or a build action.
	//
	// Although Source is listed as a valid value, it is not currently functional.
	// This value is reserved for future use.
	Category *string `locationName:"category" type:"string" required:"true" enum:"ActionCategory"`

	// The configuration properties for the custom action.
	//
	// You can refer to a name in the configuration properties of the custom action
	// within the URL templates by following the format of {Config:name}, as long
	// as the configuration property is both required and not secret. For more information,
	// see Create a Custom Action for a Pipeline (http://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html).
	ConfigurationProperties []*ActionConfigurationProperty `locationName:"configurationProperties" type:"list"`

	// Returns information about the details of an artifact.
	InputArtifactDetails *ArtifactDetails `locationName:"inputArtifactDetails" type:"structure" required:"true"`

	// Returns information about the details of an artifact.
	OutputArtifactDetails *ArtifactDetails `locationName:"outputArtifactDetails" type:"structure" required:"true"`

	// The provider of the service used in the custom action, such as AWS CodeDeploy.
	Provider *string `locationName:"provider" min:"1" type:"string" required:"true"`

	// Returns information about the settings for an action type.
	Settings *ActionTypeSettings `locationName:"settings" type:"structure"`

	// The version number of the custom action.
	Version *string `locationName:"version" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a create custom action operation.

func (CreateCustomActionTypeInput) GoString 

func (s CreateCustomActionTypeInput) GoString() string

GoString returns the string representation

func (CreateCustomActionTypeInput) String 

func (s CreateCustomActionTypeInput) String() string

String returns the string representation

func (*CreateCustomActionTypeInput) Validate 

func (s *CreateCustomActionTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateCustomActionTypeOutput 

type CreateCustomActionTypeOutput struct {

	// Returns information about the details of an action type.
	ActionType *ActionType `locationName:"actionType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a create custom action operation.

func (CreateCustomActionTypeOutput) GoString 

func (s CreateCustomActionTypeOutput) GoString() string

GoString returns the string representation

func (CreateCustomActionTypeOutput) String 

func (s CreateCustomActionTypeOutput) String() string

String returns the string representation

type CreatePipelineInput 

type CreatePipelineInput struct {

	// Represents the structure of actions and stages to be performed in the pipeline.
	Pipeline *PipelineDeclaration `locationName:"pipeline" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a create pipeline action.

func (CreatePipelineInput) GoString 

func (s CreatePipelineInput) GoString() string

GoString returns the string representation

func (CreatePipelineInput) String 

func (s CreatePipelineInput) String() string

String returns the string representation

func (*CreatePipelineInput) Validate 

func (s *CreatePipelineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePipelineOutput 

type CreatePipelineOutput struct {

	// Represents the structure of actions and stages to be performed in the pipeline.
	Pipeline *PipelineDeclaration `locationName:"pipeline" type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a create pipeline action.

func (CreatePipelineOutput) GoString 

func (s CreatePipelineOutput) GoString() string

GoString returns the string representation

func (CreatePipelineOutput) String 

func (s CreatePipelineOutput) String() string

String returns the string representation

type CurrentRevision 

type CurrentRevision struct {

	// The change identifier for the current revision.
	ChangeIdentifier *string `locationName:"changeIdentifier" min:"1" type:"string" required:"true"`

	// The revision ID of the current version of an artifact.
	Revision *string `locationName:"revision" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents information about a current revision.

func (CurrentRevision) GoString 

func (s CurrentRevision) GoString() string

GoString returns the string representation

func (CurrentRevision) String 

func (s CurrentRevision) String() string

String returns the string representation

func (*CurrentRevision) Validate 

func (s *CurrentRevision) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCustomActionTypeInput 

type DeleteCustomActionTypeInput struct {

	// The category of the custom action that you want to delete, such as source
	// or deploy.
	Category *string `locationName:"category" type:"string" required:"true" enum:"ActionCategory"`

	// The provider of the service used in the custom action, such as AWS CodeDeploy.
	Provider *string `locationName:"provider" min:"1" type:"string" required:"true"`

	// The version of the custom action to delete.
	Version *string `locationName:"version" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a delete custom action operation. The custom action will be marked as deleted.

func (DeleteCustomActionTypeInput) GoString 

func (s DeleteCustomActionTypeInput) GoString() string

GoString returns the string representation

func (DeleteCustomActionTypeInput) String 

func (s DeleteCustomActionTypeInput) String() string

String returns the string representation

func (*DeleteCustomActionTypeInput) Validate 

func (s *DeleteCustomActionTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCustomActionTypeOutput 

type DeleteCustomActionTypeOutput struct {
	// contains filtered or unexported fields
}

func (DeleteCustomActionTypeOutput) GoString 

func (s DeleteCustomActionTypeOutput) GoString() string

GoString returns the string representation

func (DeleteCustomActionTypeOutput) String 

func (s DeleteCustomActionTypeOutput) String() string

String returns the string representation

type DeletePipelineInput 

type DeletePipelineInput struct {

	// The name of the pipeline to be deleted.
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a delete pipeline action.

func (DeletePipelineInput) GoString 

func (s DeletePipelineInput) GoString() string

GoString returns the string representation

func (DeletePipelineInput) String 

func (s DeletePipelineInput) String() string

String returns the string representation

func (*DeletePipelineInput) Validate 

func (s *DeletePipelineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeletePipelineOutput 

type DeletePipelineOutput struct {
	// contains filtered or unexported fields
}

func (DeletePipelineOutput) GoString 

func (s DeletePipelineOutput) GoString() string

GoString returns the string representation

func (DeletePipelineOutput) String 

func (s DeletePipelineOutput) String() string

String returns the string representation

type DisableStageTransitionInput 

type DisableStageTransitionInput struct {

	// The name of the pipeline in which you want to disable the flow of artifacts
	// from one stage to another.
	PipelineName *string `locationName:"pipelineName" min:"1" type:"string" required:"true"`

	// The reason given to the user why a stage is disabled, such as waiting for
	// manual approval or manual tests. This message is displayed in the pipeline
	// console UI.
	Reason *string `locationName:"reason" min:"1" type:"string" required:"true"`

	// The name of the stage where you want to disable the inbound or outbound transition
	// of artifacts.
	StageName *string `locationName:"stageName" min:"1" type:"string" required:"true"`

	// Specifies whether artifacts will be prevented from transitioning into the
	// stage and being processed by the actions in that stage (inbound), or prevented
	// from transitioning from the stage after they have been processed by the actions
	// in that stage (outbound).
	TransitionType *string `locationName:"transitionType" type:"string" required:"true" enum:"StageTransitionType"`
	// contains filtered or unexported fields
}

Represents the input of a disable stage transition input action.

func (DisableStageTransitionInput) GoString 

func (s DisableStageTransitionInput) GoString() string

GoString returns the string representation

func (DisableStageTransitionInput) String 

func (s DisableStageTransitionInput) String() string

String returns the string representation

func (*DisableStageTransitionInput) Validate 

func (s *DisableStageTransitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisableStageTransitionOutput 

type DisableStageTransitionOutput struct {
	// contains filtered or unexported fields
}

func (DisableStageTransitionOutput) GoString 

func (s DisableStageTransitionOutput) GoString() string

GoString returns the string representation

func (DisableStageTransitionOutput) String 

func (s DisableStageTransitionOutput) String() string

String returns the string representation

type EnableStageTransitionInput 

type EnableStageTransitionInput struct {

	// The name of the pipeline in which you want to enable the flow of artifacts
	// from one stage to another.
	PipelineName *string `locationName:"pipelineName" min:"1" type:"string" required:"true"`

	// The name of the stage where you want to enable the transition of artifacts,
	// either into the stage (inbound) or from that stage to the next stage (outbound).
	StageName *string `locationName:"stageName" min:"1" type:"string" required:"true"`

	// Specifies whether artifacts will be allowed to enter the stage and be processed
	// by the actions in that stage (inbound) or whether already-processed artifacts
	// will be allowed to transition to the next stage (outbound).
	TransitionType *string `locationName:"transitionType" type:"string" required:"true" enum:"StageTransitionType"`
	// contains filtered or unexported fields
}

Represents the input of an enable stage transition action.

func (EnableStageTransitionInput) GoString 

func (s EnableStageTransitionInput) GoString() string

GoString returns the string representation

func (EnableStageTransitionInput) String 

func (s EnableStageTransitionInput) String() string

String returns the string representation

func (*EnableStageTransitionInput) Validate 

func (s *EnableStageTransitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EnableStageTransitionOutput 

type EnableStageTransitionOutput struct {
	// contains filtered or unexported fields
}

func (EnableStageTransitionOutput) GoString 

func (s EnableStageTransitionOutput) GoString() string

GoString returns the string representation

func (EnableStageTransitionOutput) String 

func (s EnableStageTransitionOutput) String() string

String returns the string representation

type EncryptionKey 

type EncryptionKey struct {

	// The ID used to identify the key. For an AWS KMS key, this is the key ID or
	// key ARN.
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`

	// The type of encryption key, such as an AWS Key Management Service (AWS KMS)
	// key. When creating or updating a pipeline, the value must be set to 'KMS'.
	Type *string `locationName:"type" type:"string" required:"true" enum:"EncryptionKeyType"`
	// contains filtered or unexported fields
}

Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.

func (EncryptionKey) GoString 

func (s EncryptionKey) GoString() string

GoString returns the string representation

func (EncryptionKey) String 

func (s EncryptionKey) String() string

String returns the string representation

func (*EncryptionKey) Validate 

func (s *EncryptionKey) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ErrorDetails 

type ErrorDetails struct {

	// The system ID or error number code of the error.
	Code *string `locationName:"code" type:"string"`

	// The text of the error message.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Represents information about an error in AWS CodePipeline.

func (ErrorDetails) GoString 

func (s ErrorDetails) GoString() string

GoString returns the string representation

func (ErrorDetails) String 

func (s ErrorDetails) String() string

String returns the string representation

type ExecutionDetails 

type ExecutionDetails struct {

	// The system-generated unique ID of this action used to identify this job worker
	// in any external systems, such as AWS CodeDeploy.
	ExternalExecutionId *string `locationName:"externalExecutionId" min:"1" type:"string"`

	// The percentage of work completed on the action, represented on a scale of
	// zero to one hundred percent.
	PercentComplete *int64 `locationName:"percentComplete" type:"integer"`

	// The summary of the current status of the actions.
	Summary *string `locationName:"summary" type:"string"`
	// contains filtered or unexported fields
}

The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.

func (ExecutionDetails) GoString 

func (s ExecutionDetails) GoString() string

GoString returns the string representation

func (ExecutionDetails) String 

func (s ExecutionDetails) String() string

String returns the string representation

func (*ExecutionDetails) Validate 

func (s *ExecutionDetails) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FailureDetails 

type FailureDetails struct {

	// The external ID of the run of the action that failed.
	ExternalExecutionId *string `locationName:"externalExecutionId" min:"1" type:"string"`

	// The message about the failure.
	Message *string `locationName:"message" type:"string" required:"true"`

	// The type of the failure.
	Type *string `locationName:"type" type:"string" required:"true" enum:"FailureType"`
	// contains filtered or unexported fields
}

Represents information about failure details.

func (FailureDetails) GoString 

func (s FailureDetails) GoString() string

GoString returns the string representation

func (FailureDetails) String 

func (s FailureDetails) String() string

String returns the string representation

func (*FailureDetails) Validate 

func (s *FailureDetails) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetJobDetailsInput 

type GetJobDetailsInput struct {

	// The unique system-generated ID for the job.
	JobId *string `locationName:"jobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a get job details action.

func (GetJobDetailsInput) GoString 

func (s GetJobDetailsInput) GoString() string

GoString returns the string representation

func (GetJobDetailsInput) String 

func (s GetJobDetailsInput) String() string

String returns the string representation

func (*GetJobDetailsInput) Validate 

func (s *GetJobDetailsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetJobDetailsOutput 

type GetJobDetailsOutput struct {

	// The details of the job.
	//
	//  If AWSSessionCredentials is used, a long-running job can call GetJobDetails
	// again to obtain new credentials.
	JobDetails *JobDetails `locationName:"jobDetails" type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a get job details action.

func (GetJobDetailsOutput) GoString 

func (s GetJobDetailsOutput) GoString() string

GoString returns the string representation

func (GetJobDetailsOutput) String 

func (s GetJobDetailsOutput) String() string

String returns the string representation

type GetPipelineInput 

type GetPipelineInput struct {

	// The name of the pipeline for which you want to get information. Pipeline
	// names must be unique under an Amazon Web Services (AWS) user account.
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The version number of the pipeline. If you do not specify a version, defaults
	// to the most current version.
	Version *int64 `locationName:"version" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Represents the input of a get pipeline action.

func (GetPipelineInput) GoString 

func (s GetPipelineInput) GoString() string

GoString returns the string representation

func (GetPipelineInput) String 

func (s GetPipelineInput) String() string

String returns the string representation

func (*GetPipelineInput) Validate 

func (s *GetPipelineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetPipelineOutput 

type GetPipelineOutput struct {

	// Represents the structure of actions and stages to be performed in the pipeline.
	Pipeline *PipelineDeclaration `locationName:"pipeline" type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a get pipeline action.

func (GetPipelineOutput) GoString 

func (s GetPipelineOutput) GoString() string

GoString returns the string representation

func (GetPipelineOutput) String 

func (s GetPipelineOutput) String() string

String returns the string representation

type GetPipelineStateInput 

type GetPipelineStateInput struct {

	// The name of the pipeline about which you want to get information.
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a get pipeline state action.

func (GetPipelineStateInput) GoString 

func (s GetPipelineStateInput) GoString() string

GoString returns the string representation

func (GetPipelineStateInput) String 

func (s GetPipelineStateInput) String() string

String returns the string representation

func (*GetPipelineStateInput) Validate 

func (s *GetPipelineStateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetPipelineStateOutput 

type GetPipelineStateOutput struct {

	// The date and time the pipeline was created, in timestamp format.
	Created *time.Time `locationName:"created" type:"timestamp" timestampFormat:"unix"`

	// The name of the pipeline for which you want to get the state.
	PipelineName *string `locationName:"pipelineName" min:"1" type:"string"`

	// The version number of the pipeline.
	//
	// A newly-created pipeline is always assigned a version number of 1.
	PipelineVersion *int64 `locationName:"pipelineVersion" min:"1" type:"integer"`

	// A list of the pipeline stage output information, including stage name, state,
	// most recent run details, whether the stage is disabled, and other data.
	StageStates []*StageState `locationName:"stageStates" type:"list"`

	// The date and time the pipeline was last updated, in timestamp format.
	Updated *time.Time `locationName:"updated" type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Represents the output of a get pipeline state action.

func (GetPipelineStateOutput) GoString 

func (s GetPipelineStateOutput) GoString() string

GoString returns the string representation

func (GetPipelineStateOutput) String 

func (s GetPipelineStateOutput) String() string

String returns the string representation

type GetThirdPartyJobDetailsInput 

type GetThirdPartyJobDetailsInput struct {

	// The clientToken portion of the clientId and clientToken pair used to verify
	// that the calling entity is allowed access to the job and its details.
	ClientToken *string `locationName:"clientToken" type:"string" required:"true"`

	// The unique system-generated ID used for identifying the job.
	JobId *string `locationName:"jobId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a get third party job details action.

func (GetThirdPartyJobDetailsInput) GoString 

func (s GetThirdPartyJobDetailsInput) GoString() string

GoString returns the string representation

func (GetThirdPartyJobDetailsInput) String 

func (s GetThirdPartyJobDetailsInput) String() string

String returns the string representation

func (*GetThirdPartyJobDetailsInput) Validate 

func (s *GetThirdPartyJobDetailsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetThirdPartyJobDetailsOutput 

type GetThirdPartyJobDetailsOutput struct {

	// The details of the job, including any protected values defined for the job.
	JobDetails *ThirdPartyJobDetails `locationName:"jobDetails" type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a get third party job details action.

func (GetThirdPartyJobDetailsOutput) GoString 

func (s GetThirdPartyJobDetailsOutput) GoString() string

GoString returns the string representation

func (GetThirdPartyJobDetailsOutput) String 

func (s GetThirdPartyJobDetailsOutput) String() string

String returns the string representation

type InputArtifact 

type InputArtifact struct {

	// The name of the artifact to be worked on, for example, "My App".
	//
	// The input artifact of an action must exactly match the output artifact declared
	// in a preceding action, but the input artifact does not have to be the next
	// action in strict sequence from the action that provided the output artifact.
	// Actions in parallel can declare different output artifacts, which are in
	// turn consumed by different following actions.
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents information about an artifact to be worked on, such as a test or build artifact.

func (InputArtifact) GoString 

func (s InputArtifact) GoString() string

GoString returns the string representation

func (InputArtifact) String 

func (s InputArtifact) String() string

String returns the string representation

func (*InputArtifact) Validate 

func (s *InputArtifact) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Job 

type Job struct {

	// The ID of the AWS account to use when performing the job.
	AccountId *string `locationName:"accountId" type:"string"`

	// Additional data about a job.
	Data *JobData `locationName:"data" type:"structure"`

	// The unique system-generated ID of the job.
	Id *string `locationName:"id" type:"string"`

	// A system-generated random number that AWS CodePipeline uses to ensure that
	// the job is being worked on by only one job worker. This number must be returned
	// in the response.
	Nonce *string `locationName:"nonce" type:"string"`
	// contains filtered or unexported fields
}

Represents information about a job.

func (Job) GoString 

func (s Job) GoString() string

GoString returns the string representation

func (Job) String 

func (s Job) String() string

String returns the string representation

type JobData 

type JobData struct {

	// Represents information about an action configuration.
	ActionConfiguration *ActionConfiguration `locationName:"actionConfiguration" type:"structure"`

	// Represents information about an action type.
	ActionTypeId *ActionTypeId `locationName:"actionTypeId" type:"structure"`

	// Represents an AWS session credentials object. These credentials are temporary
	// credentials that are issued by AWS Secure Token Service (STS). They can be
	// used to access input and output artifacts in the Amazon S3 bucket used to
	// store artifact for the pipeline in AWS CodePipeline.
	ArtifactCredentials *AWSSessionCredentials `locationName:"artifactCredentials" type:"structure"`

	// A system-generated token, such as a AWS CodeDeploy deployment ID, that a
	// job requires in order to continue the job asynchronously.
	ContinuationToken *string `locationName:"continuationToken" type:"string"`

	// Represents information about the key used to encrypt data in the artifact
	// store, such as an AWS Key Management Service (AWS KMS) key.
	EncryptionKey *EncryptionKey `locationName:"encryptionKey" type:"structure"`

	// The artifact supplied to the job.
	InputArtifacts []*Artifact `locationName:"inputArtifacts" type:"list"`

	// The output of the job.
	OutputArtifacts []*Artifact `locationName:"outputArtifacts" type:"list"`

	// Represents information about a pipeline to a job worker.
	PipelineContext *PipelineContext `locationName:"pipelineContext" type:"structure"`
	// contains filtered or unexported fields
}

Represents additional information about a job required for a job worker to complete the job.

func (JobData) GoString 

func (s JobData) GoString() string

GoString returns the string representation

func (JobData) String 

func (s JobData) String() string

String returns the string representation

type JobDetails 

type JobDetails struct {

	// The AWS account ID associated with the job.
	AccountId *string `locationName:"accountId" type:"string"`

	// Represents additional information about a job required for a job worker to
	// complete the job.
	Data *JobData `locationName:"data" type:"structure"`

	// The unique system-generated ID of the job.
	Id *string `locationName:"id" type:"string"`
	// contains filtered or unexported fields
}

Represents information about the details of a job.

func (JobDetails) GoString 

func (s JobDetails) GoString() string

GoString returns the string representation

func (JobDetails) String 

func (s JobDetails) String() string

String returns the string representation

type ListActionTypesInput 

type ListActionTypesInput struct {

	// Filters the list of action types to those created by a specified entity.
	ActionOwnerFilter *string `locationName:"actionOwnerFilter" type:"string" enum:"ActionOwner"`

	// An identifier that was returned from the previous list action types call,
	// which can be used to return the next set of action types in the list.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Represents the input of a list action types action.

func (ListActionTypesInput) GoString 

func (s ListActionTypesInput) GoString() string

GoString returns the string representation

func (ListActionTypesInput) String 

func (s ListActionTypesInput) String() string

String returns the string representation

type ListActionTypesOutput 

type ListActionTypesOutput struct {

	// Provides details of the action types.
	ActionTypes []*ActionType `locationName:"actionTypes" type:"list" required:"true"`

	// If the amount of returned information is significantly large, an identifier
	// is also returned which can be used in a subsequent list action types call
	// to return the next set of action types in the list.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a list action types action.

func (ListActionTypesOutput) GoString 

func (s ListActionTypesOutput) GoString() string

GoString returns the string representation

func (ListActionTypesOutput) String 

func (s ListActionTypesOutput) String() string

String returns the string representation

type ListPipelinesInput 

type ListPipelinesInput struct {

	// An identifier that was returned from the previous list pipelines call, which
	// can be used to return the next set of pipelines in the list.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Represents the input of a list pipelines action.

func (ListPipelinesInput) GoString 

func (s ListPipelinesInput) GoString() string

GoString returns the string representation

func (ListPipelinesInput) String 

func (s ListPipelinesInput) String() string

String returns the string representation

type ListPipelinesOutput 

type ListPipelinesOutput struct {

	// If the amount of returned information is significantly large, an identifier
	// is also returned which can be used in a subsequent list pipelines call to
	// return the next set of pipelines in the list.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The list of pipelines.
	Pipelines []*PipelineSummary `locationName:"pipelines" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a list pipelines action.

func (ListPipelinesOutput) GoString 

func (s ListPipelinesOutput) GoString() string

GoString returns the string representation

func (ListPipelinesOutput) String 

func (s ListPipelinesOutput) String() string

String returns the string representation

type OutputArtifact 

type OutputArtifact struct {

	// The name of the output of an artifact, such as "My App".
	//
	// The input artifact of an action must exactly match the output artifact declared
	// in a preceding action, but the input artifact does not have to be the next
	// action in strict sequence from the action that provided the output artifact.
	// Actions in parallel can declare different output artifacts, which are in
	// turn consumed by different following actions.
	//
	// Output artifact names must be unique within a pipeline.
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents information about the output of an action.

func (OutputArtifact) GoString 

func (s OutputArtifact) GoString() string

GoString returns the string representation

func (OutputArtifact) String 

func (s OutputArtifact) String() string

String returns the string representation

func (*OutputArtifact) Validate 

func (s *OutputArtifact) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PipelineContext 

type PipelineContext struct {

	// Represents the context of an action within the stage of a pipeline to a job
	// worker.
	Action *ActionContext `locationName:"action" type:"structure"`

	// The name of the pipeline. This is a user-specified value. Pipeline names
	// must be unique across all pipeline names under an Amazon Web Services account.
	PipelineName *string `locationName:"pipelineName" min:"1" type:"string"`

	// The stage of the pipeline.
	Stage *StageContext `locationName:"stage" type:"structure"`
	// contains filtered or unexported fields
}

Represents information about a pipeline to a job worker.

func (PipelineContext) GoString 

func (s PipelineContext) GoString() string

GoString returns the string representation

func (PipelineContext) String 

func (s PipelineContext) String() string

String returns the string representation

type PipelineDeclaration 

type PipelineDeclaration struct {

	// The Amazon S3 location where artifacts are stored for the pipeline. If this
	// Amazon S3 bucket is created manually, it must meet the requirements for AWS
	// CodePipeline. For more information, see the Concepts (http://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#CPS3Bucket).
	ArtifactStore *ArtifactStore `locationName:"artifactStore" type:"structure" required:"true"`

	// The name of the action to be performed.
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform
	// actions with no actionRoleArn, or to use to assume roles for actions with
	// an actionRoleArn.
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The stage in which to perform the action.
	Stages []*StageDeclaration `locationName:"stages" type:"list" required:"true"`

	// The version number of the pipeline. A new pipeline always has a version number
	// of 1. This number is automatically incremented when a pipeline is updated.
	Version *int64 `locationName:"version" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Represents the structure of actions and stages to be performed in the pipeline.

func (PipelineDeclaration) GoString 

func (s PipelineDeclaration) GoString() string

GoString returns the string representation

func (PipelineDeclaration) String 

func (s PipelineDeclaration) String() string

String returns the string representation

func (*PipelineDeclaration) Validate 

func (s *PipelineDeclaration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PipelineSummary 

type PipelineSummary struct {

	// The date and time the pipeline was created, in timestamp format.
	Created *time.Time `locationName:"created" type:"timestamp" timestampFormat:"unix"`

	// The name of the pipeline.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The date and time of the last update to the pipeline, in timestamp format.
	Updated *time.Time `locationName:"updated" type:"timestamp" timestampFormat:"unix"`

	// The version number of the pipeline.
	Version *int64 `locationName:"version" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Returns a summary of a pipeline.

func (PipelineSummary) GoString 

func (s PipelineSummary) GoString() string

GoString returns the string representation

func (PipelineSummary) String 

func (s PipelineSummary) String() string

String returns the string representation

type PollForJobsInput 

type PollForJobsInput struct {

	// Represents information about an action type.
	ActionTypeId *ActionTypeId `locationName:"actionTypeId" type:"structure" required:"true"`

	// The maximum number of jobs to return in a poll for jobs call.
	MaxBatchSize *int64 `locationName:"maxBatchSize" min:"1" type:"integer"`

	// A map of property names and values. For an action type with no queryable
	// properties, this value must be null or an empty map. For an action type with
	// a queryable property, you must supply that property as a key in the map.
	// Only jobs whose action configuration matches the mapped value will be returned.
	QueryParam map[string]*string `locationName:"queryParam" type:"map"`
	// contains filtered or unexported fields
}

Represents the input of a poll for jobs action.

func (PollForJobsInput) GoString 

func (s PollForJobsInput) GoString() string

GoString returns the string representation

func (PollForJobsInput) String 

func (s PollForJobsInput) String() string

String returns the string representation

func (*PollForJobsInput) Validate 

func (s *PollForJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PollForJobsOutput 

type PollForJobsOutput struct {

	// Information about the jobs to take action on.
	Jobs []*Job `locationName:"jobs" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a poll for jobs action.

func (PollForJobsOutput) GoString 

func (s PollForJobsOutput) GoString() string

GoString returns the string representation

func (PollForJobsOutput) String 

func (s PollForJobsOutput) String() string

String returns the string representation

type PollForThirdPartyJobsInput 

type PollForThirdPartyJobsInput struct {

	// Represents information about an action type.
	ActionTypeId *ActionTypeId `locationName:"actionTypeId" type:"structure" required:"true"`

	// The maximum number of jobs to return in a poll for jobs call.
	MaxBatchSize *int64 `locationName:"maxBatchSize" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Represents the input of a poll for third party jobs action.

func (PollForThirdPartyJobsInput) GoString 

func (s PollForThirdPartyJobsInput) GoString() string

GoString returns the string representation

func (PollForThirdPartyJobsInput) String 

func (s PollForThirdPartyJobsInput) String() string

String returns the string representation

func (*PollForThirdPartyJobsInput) Validate 

func (s *PollForThirdPartyJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PollForThirdPartyJobsOutput 

type PollForThirdPartyJobsOutput struct {

	// Information about the jobs to take action on.
	Jobs []*ThirdPartyJob `locationName:"jobs" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a poll for third party jobs action.

func (PollForThirdPartyJobsOutput) GoString 

func (s PollForThirdPartyJobsOutput) GoString() string

GoString returns the string representation

func (PollForThirdPartyJobsOutput) String 

func (s PollForThirdPartyJobsOutput) String() string

String returns the string representation

type PutActionRevisionInput 

type PutActionRevisionInput struct {

	// The name of the action that will process the revision.
	ActionName *string `locationName:"actionName" min:"1" type:"string" required:"true"`

	// Represents information about the version (or revision) of an action.
	ActionRevision *ActionRevision `locationName:"actionRevision" type:"structure" required:"true"`

	// The name of the pipeline that will start processing the revision to the source.
	PipelineName *string `locationName:"pipelineName" min:"1" type:"string" required:"true"`

	// The name of the stage that contains the action that will act upon the revision.
	StageName *string `locationName:"stageName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a put action revision action.

func (PutActionRevisionInput) GoString 

func (s PutActionRevisionInput) GoString() string

GoString returns the string representation

func (PutActionRevisionInput) String 

func (s PutActionRevisionInput) String() string

String returns the string representation

func (*PutActionRevisionInput) Validate 

func (s *PutActionRevisionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutActionRevisionOutput 

type PutActionRevisionOutput struct {

	// The new revision number or ID for the revision after the action completes.
	NewRevision *bool `locationName:"newRevision" type:"boolean"`

	// The ID of the current workflow state of the pipeline.
	PipelineExecutionId *string `locationName:"pipelineExecutionId" type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a put action revision action.

func (PutActionRevisionOutput) GoString 

func (s PutActionRevisionOutput) GoString() string

GoString returns the string representation

func (PutActionRevisionOutput) String 

func (s PutActionRevisionOutput) String() string

String returns the string representation

type PutJobFailureResultInput 

type PutJobFailureResultInput struct {

	// The details about the failure of a job.
	FailureDetails *FailureDetails `locationName:"failureDetails" type:"structure" required:"true"`

	// The unique system-generated ID of the job that failed. This is the same ID
	// returned from PollForJobs.
	JobId *string `locationName:"jobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a put job failure result action.

func (PutJobFailureResultInput) GoString 

func (s PutJobFailureResultInput) GoString() string

GoString returns the string representation

func (PutJobFailureResultInput) String 

func (s PutJobFailureResultInput) String() string

String returns the string representation

func (*PutJobFailureResultInput) Validate 

func (s *PutJobFailureResultInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutJobFailureResultOutput 

type PutJobFailureResultOutput struct {
	// contains filtered or unexported fields
}

func (PutJobFailureResultOutput) GoString 

func (s PutJobFailureResultOutput) GoString() string

GoString returns the string representation

func (PutJobFailureResultOutput) String 

func (s PutJobFailureResultOutput) String() string

String returns the string representation

type PutJobSuccessResultInput 

type PutJobSuccessResultInput struct {

	// A token generated by a job worker, such as an AWS CodeDeploy deployment ID,
	// that a successful job provides to identify a custom action in progress. Future
	// jobs will use this token in order to identify the running instance of the
	// action. It can be reused to return additional information about the progress
	// of the custom action. When the action is complete, no continuation token
	// should be supplied.
	ContinuationToken *string `locationName:"continuationToken" type:"string"`

	// The ID of the current revision of the artifact successfully worked upon by
	// the job.
	CurrentRevision *CurrentRevision `locationName:"currentRevision" type:"structure"`

	// The execution details of the successful job, such as the actions taken by
	// the job worker.
	ExecutionDetails *ExecutionDetails `locationName:"executionDetails" type:"structure"`

	// The unique system-generated ID of the job that succeeded. This is the same
	// ID returned from PollForJobs.
	JobId *string `locationName:"jobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a put job success result action.

func (PutJobSuccessResultInput) GoString 

func (s PutJobSuccessResultInput) GoString() string

GoString returns the string representation

func (PutJobSuccessResultInput) String 

func (s PutJobSuccessResultInput) String() string

String returns the string representation

func (*PutJobSuccessResultInput) Validate 

func (s *PutJobSuccessResultInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutJobSuccessResultOutput 

type PutJobSuccessResultOutput struct {
	// contains filtered or unexported fields
}

func (PutJobSuccessResultOutput) GoString 

func (s PutJobSuccessResultOutput) GoString() string

GoString returns the string representation

func (PutJobSuccessResultOutput) String 

func (s PutJobSuccessResultOutput) String() string

String returns the string representation

type PutThirdPartyJobFailureResultInput 

type PutThirdPartyJobFailureResultInput struct {

	// The clientToken portion of the clientId and clientToken pair used to verify
	// that the calling entity is allowed access to the job and its details.
	ClientToken *string `locationName:"clientToken" type:"string" required:"true"`

	// Represents information about failure details.
	FailureDetails *FailureDetails `locationName:"failureDetails" type:"structure" required:"true"`

	// The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.
	JobId *string `locationName:"jobId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a third party job failure result action.

func (PutThirdPartyJobFailureResultInput) GoString 

func (s PutThirdPartyJobFailureResultInput) GoString() string

GoString returns the string representation

func (PutThirdPartyJobFailureResultInput) String 

func (s PutThirdPartyJobFailureResultInput) String() string

String returns the string representation

func (*PutThirdPartyJobFailureResultInput) Validate 

func (s *PutThirdPartyJobFailureResultInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutThirdPartyJobFailureResultOutput 

type PutThirdPartyJobFailureResultOutput struct {
	// contains filtered or unexported fields
}

func (PutThirdPartyJobFailureResultOutput) GoString 

func (s PutThirdPartyJobFailureResultOutput) GoString() string

GoString returns the string representation

func (PutThirdPartyJobFailureResultOutput) String 

func (s PutThirdPartyJobFailureResultOutput) String() string

String returns the string representation

type PutThirdPartyJobSuccessResultInput 

type PutThirdPartyJobSuccessResultInput struct {

	// The clientToken portion of the clientId and clientToken pair used to verify
	// that the calling entity is allowed access to the job and its details.
	ClientToken *string `locationName:"clientToken" type:"string" required:"true"`

	// A token generated by a job worker, such as an AWS CodeDeploy deployment ID,
	// that a successful job provides to identify a partner action in progress.
	// Future jobs will use this token in order to identify the running instance
	// of the action. It can be reused to return additional information about the
	// progress of the partner action. When the action is complete, no continuation
	// token should be supplied.
	ContinuationToken *string `locationName:"continuationToken" type:"string"`

	// Represents information about a current revision.
	CurrentRevision *CurrentRevision `locationName:"currentRevision" type:"structure"`

	// The details of the actions taken and results produced on an artifact as it
	// passes through stages in the pipeline.
	ExecutionDetails *ExecutionDetails `locationName:"executionDetails" type:"structure"`

	// The ID of the job that successfully completed. This is the same ID returned
	// from PollForThirdPartyJobs.
	JobId *string `locationName:"jobId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a put third party job success result action.

func (PutThirdPartyJobSuccessResultInput) GoString 

func (s PutThirdPartyJobSuccessResultInput) GoString() string

GoString returns the string representation

func (PutThirdPartyJobSuccessResultInput) String 

func (s PutThirdPartyJobSuccessResultInput) String() string

String returns the string representation

func (*PutThirdPartyJobSuccessResultInput) Validate 

func (s *PutThirdPartyJobSuccessResultInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutThirdPartyJobSuccessResultOutput 

type PutThirdPartyJobSuccessResultOutput struct {
	// contains filtered or unexported fields
}

func (PutThirdPartyJobSuccessResultOutput) GoString 

func (s PutThirdPartyJobSuccessResultOutput) GoString() string

GoString returns the string representation

func (PutThirdPartyJobSuccessResultOutput) String 

func (s PutThirdPartyJobSuccessResultOutput) String() string

String returns the string representation

type S3ArtifactLocation 

type S3ArtifactLocation struct {

	// The name of the Amazon S3 bucket.
	BucketName *string `locationName:"bucketName" type:"string" required:"true"`

	// The key of the object in the Amazon S3 bucket, which uniquely identifies
	// the object in the bucket.
	ObjectKey *string `locationName:"objectKey" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The location of the Amazon S3 bucket that contains a revision.

func (S3ArtifactLocation) GoString 

func (s S3ArtifactLocation) GoString() string

GoString returns the string representation

func (S3ArtifactLocation) String 

func (s S3ArtifactLocation) String() string

String returns the string representation

type StageContext 

type StageContext struct {

	// The name of the stage.
	Name *string `locationName:"name" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents information about a stage to a job worker.

func (StageContext) GoString 

func (s StageContext) GoString() string

GoString returns the string representation

func (StageContext) String 

func (s StageContext) String() string

String returns the string representation

type StageDeclaration 

type StageDeclaration struct {

	// The actions included in a stage.
	Actions []*ActionDeclaration `locationName:"actions" type:"list" required:"true"`

	// Reserved for future use.
	Blockers []*BlockerDeclaration `locationName:"blockers" type:"list"`

	// The name of the stage.
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents information about a stage and its definition.

func (StageDeclaration) GoString 

func (s StageDeclaration) GoString() string

GoString returns the string representation

func (StageDeclaration) String 

func (s StageDeclaration) String() string

String returns the string representation

func (*StageDeclaration) Validate 

func (s *StageDeclaration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StageState 

type StageState struct {

	// The state of the stage.
	ActionStates []*ActionState `locationName:"actionStates" type:"list"`

	// The state of the inbound transition, which is either enabled or disabled.
	InboundTransitionState *TransitionState `locationName:"inboundTransitionState" type:"structure"`

	// The name of the stage.
	StageName *string `locationName:"stageName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents information about the state of the stage.

func (StageState) GoString 

func (s StageState) GoString() string

GoString returns the string representation

func (StageState) String 

func (s StageState) String() string

String returns the string representation

type StartPipelineExecutionInput 

type StartPipelineExecutionInput struct {

	// The name of the pipeline to start.
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a start pipeline execution action.

func (StartPipelineExecutionInput) GoString 

func (s StartPipelineExecutionInput) GoString() string

GoString returns the string representation

func (StartPipelineExecutionInput) String 

func (s StartPipelineExecutionInput) String() string

String returns the string representation

func (*StartPipelineExecutionInput) Validate 

func (s *StartPipelineExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartPipelineExecutionOutput 

type StartPipelineExecutionOutput struct {

	// The unique system-generated ID of the pipeline that was started.
	PipelineExecutionId *string `locationName:"pipelineExecutionId" type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a start pipeline execution action.

func (StartPipelineExecutionOutput) GoString 

func (s StartPipelineExecutionOutput) GoString() string

GoString returns the string representation

func (StartPipelineExecutionOutput) String 

func (s StartPipelineExecutionOutput) String() string

String returns the string representation

type ThirdPartyJob 

type ThirdPartyJob struct {

	// The clientToken portion of the clientId and clientToken pair used to verify
	// that the calling entity is allowed access to the job and its details.
	ClientId *string `locationName:"clientId" type:"string"`

	// The identifier used to identify the job in AWS CodePipeline.
	JobId *string `locationName:"jobId" type:"string"`
	// contains filtered or unexported fields
}

A response to a PollForThirdPartyJobs request returned by AWS CodePipeline when there is a job to be worked upon by a partner action.

func (ThirdPartyJob) GoString 

func (s ThirdPartyJob) GoString() string

GoString returns the string representation

func (ThirdPartyJob) String 

func (s ThirdPartyJob) String() string

String returns the string representation

type ThirdPartyJobData 

type ThirdPartyJobData struct {

	// Represents information about an action configuration.
	ActionConfiguration *ActionConfiguration `locationName:"actionConfiguration" type:"structure"`

	// Represents information about an action type.
	ActionTypeId *ActionTypeId `locationName:"actionTypeId" type:"structure"`

	// Represents an AWS session credentials object. These credentials are temporary
	// credentials that are issued by AWS Secure Token Service (STS). They can be
	// used to access input and output artifacts in the Amazon S3 bucket used to
	// store artifact for the pipeline in AWS CodePipeline.
	ArtifactCredentials *AWSSessionCredentials `locationName:"artifactCredentials" type:"structure"`

	// A system-generated token, such as a AWS CodeDeploy deployment ID, that a
	// job requires in order to continue the job asynchronously.
	ContinuationToken *string `locationName:"continuationToken" type:"string"`

	// The encryption key used to encrypt and decrypt data in the artifact store
	// for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This
	// is optional and might not be present.
	EncryptionKey *EncryptionKey `locationName:"encryptionKey" type:"structure"`

	// The name of the artifact that will be worked upon by the action, if any.
	// This name might be system-generated, such as "MyApp", or might be defined
	// by the user when the action is created. The input artifact name must match
	// the name of an output artifact generated by an action in an earlier action
	// or stage of the pipeline.
	InputArtifacts []*Artifact `locationName:"inputArtifacts" type:"list"`

	// The name of the artifact that will be the result of the action, if any. This
	// name might be system-generated, such as "MyBuiltApp", or might be defined
	// by the user when the action is created.
	OutputArtifacts []*Artifact `locationName:"outputArtifacts" type:"list"`

	// Represents information about a pipeline to a job worker.
	PipelineContext *PipelineContext `locationName:"pipelineContext" type:"structure"`
	// contains filtered or unexported fields
}

Represents information about the job data for a partner action.

func (ThirdPartyJobData) GoString 

func (s ThirdPartyJobData) GoString() string

GoString returns the string representation

func (ThirdPartyJobData) String 

func (s ThirdPartyJobData) String() string

String returns the string representation

type ThirdPartyJobDetails 

type ThirdPartyJobDetails struct {

	// The data to be returned by the third party job worker.
	Data *ThirdPartyJobData `locationName:"data" type:"structure"`

	// The identifier used to identify the job details in AWS CodePipeline.
	Id *string `locationName:"id" min:"1" type:"string"`

	// A system-generated random number that AWS CodePipeline uses to ensure that
	// the job is being worked on by only one job worker. This number must be returned
	// in the response.
	Nonce *string `locationName:"nonce" type:"string"`
	// contains filtered or unexported fields
}

The details of a job sent in response to a GetThirdPartyJobDetails request.

func (ThirdPartyJobDetails) GoString 

func (s ThirdPartyJobDetails) GoString() string

GoString returns the string representation

func (ThirdPartyJobDetails) String 

func (s ThirdPartyJobDetails) String() string

String returns the string representation

type TransitionState 

type TransitionState struct {

	// The user-specified reason why the transition between two stages of a pipeline
	// was disabled.
	DisabledReason *string `locationName:"disabledReason" min:"1" type:"string"`

	// Whether the transition between stages is enabled (true) or disabled (false).
	Enabled *bool `locationName:"enabled" type:"boolean"`

	// The timestamp when the transition state was last changed.
	LastChangedAt *time.Time `locationName:"lastChangedAt" type:"timestamp" timestampFormat:"unix"`

	// The ID of the user who last changed the transition state.
	LastChangedBy *string `locationName:"lastChangedBy" type:"string"`
	// contains filtered or unexported fields
}

Represents information about the state of transitions between one stage and another stage.

func (TransitionState) GoString 

func (s TransitionState) GoString() string

GoString returns the string representation

func (TransitionState) String 

func (s TransitionState) String() string

String returns the string representation

type UpdatePipelineInput 

type UpdatePipelineInput struct {

	// The name of the pipeline to be updated.
	Pipeline *PipelineDeclaration `locationName:"pipeline" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of an update pipeline action.

func (UpdatePipelineInput) GoString 

func (s UpdatePipelineInput) GoString() string

GoString returns the string representation

func (UpdatePipelineInput) String 

func (s UpdatePipelineInput) String() string

String returns the string representation

func (*UpdatePipelineInput) Validate 

func (s *UpdatePipelineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdatePipelineOutput 

type UpdatePipelineOutput struct {

	// The structure of the updated pipeline.
	Pipeline *PipelineDeclaration `locationName:"pipeline" type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of an update pipeline action.

func (UpdatePipelineOutput) GoString 

func (s UpdatePipelineOutput) GoString() string

GoString returns the string representation

func (UpdatePipelineOutput) String 

func (s UpdatePipelineOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package codepipelineiface provides an interface for the AWS CodePipeline.
 Package codepipelineiface provides an interface for the AWS CodePipeline.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.