types

package
v1.1.1 Latest Latest
Warning

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

 Go to latest Published: Feb 10, 2021 License: Apache-2.0 Imports: 3 Imported by: 11

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AWSSessionCredentials 

type AWSSessionCredentials struct {

	// The access key for the session.
	//
	// This member is required.
	AccessKeyId *string

	// The secret access key for the session.
	//
	// This member is required.
	SecretAccessKey *string

	// The token for the session.
	//
	// This member is required.
	SessionToken *string
}

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 S3 bucket used to store artifact for the pipeline in AWS CodePipeline.

type ActionCategory 

type ActionCategory string
const (
	ActionCategorySource   ActionCategory = "Source"
	ActionCategoryBuild    ActionCategory = "Build"
	ActionCategoryDeploy   ActionCategory = "Deploy"
	ActionCategoryTest     ActionCategory = "Test"
	ActionCategoryInvoke   ActionCategory = "Invoke"
	ActionCategoryApproval ActionCategory = "Approval"
)

Enum values for ActionCategory

func (ActionCategory) Values added in v0.29.0 

func (ActionCategory) Values() []ActionCategory

Values returns all known values for ActionCategory. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ActionConfiguration 

type ActionConfiguration struct {

	// The configuration data for the action.
	Configuration map[string]string
}

Represents information about an action configuration.

type ActionConfigurationProperty 

type ActionConfigurationProperty struct {

	// Whether the configuration property is a key.
	//
	// This member is required.
	Key bool

	// The name of the action configuration property.
	//
	// This member is required.
	Name *string

	// Whether the configuration property is a required value.
	//
	// This member is required.
	Required bool

	// 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 preserves the previous value of the
	// secret.
	//
	// This member is required.
	Secret bool

	// The description of the action configuration property that is displayed to users.
	Description *string

	// Indicates that the property is used 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 other 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

	// The type of the configuration property.
	Type ActionConfigurationPropertyType
}

Represents information about an action configuration property.

type ActionConfigurationPropertyType 

type ActionConfigurationPropertyType string
const (
	ActionConfigurationPropertyTypeString  ActionConfigurationPropertyType = "String"
	ActionConfigurationPropertyTypeNumber  ActionConfigurationPropertyType = "Number"
	ActionConfigurationPropertyTypeBoolean ActionConfigurationPropertyType = "Boolean"
)

Enum values for ActionConfigurationPropertyType

func (ActionConfigurationPropertyType) Values added in v0.29.0 

func (ActionConfigurationPropertyType) Values() []ActionConfigurationPropertyType

Values returns all known values for ActionConfigurationPropertyType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ActionContext 

type ActionContext struct {

	// The system-generated unique ID that corresponds to an action's execution.
	ActionExecutionId *string

	// The name of the action in the context of a job.
	Name *string
}

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

type ActionDeclaration 

type ActionDeclaration struct {

	// Specifies the action type and the provider of the action.
	//
	// This member is required.
	ActionTypeId *ActionTypeId

	// The action declaration's name.
	//
	// This member is required.
	Name *string

	// The action's configuration. These are key-value pairs that specify input values
	// for an action. For more information, see Action Structure Requirements in
	// CodePipeline
	// (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements).
	// For the list of configuration properties for the AWS CloudFormation action type
	// in CodePipeline, see Configuration Properties Reference
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-reference.html)
	// in the AWS CloudFormation User Guide. For template snippets with examples, see
	// Using Parameter Override Functions with CodePipeline Pipelines
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-parameter-override-functions.html)
	// in the AWS CloudFormation User Guide. The values can be represented in either
	// JSON or YAML format. For example, the JSON configuration item format is as
	// follows: JSON: "Configuration" : { Key : Value },
	Configuration map[string]string

	// The name or ID of the artifact consumed by the action, such as a test or build
	// artifact.
	InputArtifacts []InputArtifact

	// The variable namespace associated with the action. All variables produced as
	// output by this action fall under this namespace.
	Namespace *string

	// The name or ID of the result of the action declaration, such as a test or build
	// artifact.
	OutputArtifacts []OutputArtifact

	// The action declaration's AWS Region, such as us-east-1.
	Region *string

	// The ARN of the IAM service role that performs the declared action. This is
	// assumed through the roleArn for the pipeline.
	RoleArn *string

	// The order in which actions are run.
	RunOrder *int32
}

Represents information about an action declaration.

type ActionExecution 

type ActionExecution struct {

	// ID of the workflow action execution in the current stage. Use the
	// GetPipelineState action to retrieve the current action execution details of the
	// current stage. For older executions, this field might be empty. The action
	// execution ID is available for executions run on or after March 2020.
	ActionExecutionId *string

	// The details of an error returned by a URL external to AWS.
	ErrorDetails *ErrorDetails

	// The external ID of the run of the action.
	ExternalExecutionId *string

	// The URL of a resource external to AWS that is used when running the action (for
	// example, an external repository URL).
	ExternalExecutionUrl *string

	// The last status change of the action.
	LastStatusChange *time.Time

	// The ARN of the user who last changed the pipeline.
	LastUpdatedBy *string

	// A percentage of completeness of the action as it runs.
	PercentComplete *int32

	// The status of the action, or for a completed action, the last status of the
	// action.
	Status ActionExecutionStatus

	// A summary of the run of the action.
	Summary *string

	// The system-generated token used to identify a unique approval request. The token
	// for each open approval request can be obtained using the GetPipelineState
	// command. It is used to validate that the approval request corresponding to this
	// token is still valid.
	Token *string
}

Represents information about the run of an action.

type ActionExecutionDetail 

type ActionExecutionDetail struct {

	// The action execution ID.
	ActionExecutionId *string

	// The name of the action.
	ActionName *string

	// Input details for the action execution, such as role ARN, Region, and input
	// artifacts.
	Input *ActionExecutionInput

	// The last update time of the action execution.
	LastUpdateTime *time.Time

	// Output details for the action execution, such as the action execution result.
	Output *ActionExecutionOutput

	// The pipeline execution ID for the action execution.
	PipelineExecutionId *string

	// The version of the pipeline where the action was run.
	PipelineVersion *int32

	// The name of the stage that contains the action.
	StageName *string

	// The start time of the action execution.
	StartTime *time.Time

	// The status of the action execution. Status categories are InProgress, Succeeded,
	// and Failed.
	Status ActionExecutionStatus
}

Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action.

type ActionExecutionFilter 

type ActionExecutionFilter struct {

	// The pipeline execution ID used to filter action execution history.
	PipelineExecutionId *string
}

Filter values for the action execution.

type ActionExecutionInput 

type ActionExecutionInput struct {

	// Represents information about an action type.
	ActionTypeId *ActionTypeId

	// Configuration data for an action execution.
	Configuration map[string]string

	// Details of input artifacts of the action that correspond to the action
	// execution.
	InputArtifacts []ArtifactDetail

	// The variable namespace associated with the action. All variables produced as
	// output by this action fall under this namespace.
	Namespace *string

	// The AWS Region for the action, such as us-east-1.
	Region *string

	// Configuration data for an action execution with all variable references replaced
	// with their real values for the execution.
	ResolvedConfiguration map[string]string

	// The ARN of the IAM service role that performs the declared action. This is
	// assumed through the roleArn for the pipeline.
	RoleArn *string
}

Input information used for an action execution.

type ActionExecutionOutput 

type ActionExecutionOutput struct {

	// Execution result information listed in the output details for an action
	// execution.
	ExecutionResult *ActionExecutionResult

	// Details of output artifacts of the action that correspond to the action
	// execution.
	OutputArtifacts []ArtifactDetail

	// The outputVariables field shows the key-value pairs that were output as part of
	// that execution.
	OutputVariables map[string]string
}

Output details listed for an action execution, such as the action execution result.

type ActionExecutionResult 

type ActionExecutionResult struct {

	// The action provider's external ID for the action execution.
	ExternalExecutionId *string

	// The action provider's summary for the action execution.
	ExternalExecutionSummary *string

	// The deepest external link to the external resource (for example, a repository
	// URL or deployment endpoint) that is used when running the action.
	ExternalExecutionUrl *string
}

Execution result information, such as the external execution ID.

type ActionExecutionStatus 

type ActionExecutionStatus string
const (
	ActionExecutionStatusInProgress ActionExecutionStatus = "InProgress"
	ActionExecutionStatusAbandoned  ActionExecutionStatus = "Abandoned"
	ActionExecutionStatusSucceeded  ActionExecutionStatus = "Succeeded"
	ActionExecutionStatusFailed     ActionExecutionStatus = "Failed"
)

Enum values for ActionExecutionStatus

func (ActionExecutionStatus) Values added in v0.29.0 

func (ActionExecutionStatus) Values() []ActionExecutionStatus

Values returns all known values for ActionExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ActionNotFoundException 

type ActionNotFoundException struct {
	Message *string
}

The specified action cannot be found.

func (*ActionNotFoundException) Error 

func (e *ActionNotFoundException) Error() string

func (*ActionNotFoundException) ErrorCode 

func (e *ActionNotFoundException) ErrorCode() string

func (*ActionNotFoundException) ErrorFault 

func (e *ActionNotFoundException) ErrorFault() smithy.ErrorFault

func (*ActionNotFoundException) ErrorMessage 

func (e *ActionNotFoundException) ErrorMessage() string

type ActionOwner 

type ActionOwner string
const (
	ActionOwnerAws        ActionOwner = "AWS"
	ActionOwnerThirdParty ActionOwner = "ThirdParty"
	ActionOwnerCustom     ActionOwner = "Custom"
)

Enum values for ActionOwner

func (ActionOwner) Values added in v0.29.0 

func (ActionOwner) Values() []ActionOwner

Values returns all known values for ActionOwner. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ActionRevision 

type ActionRevision struct {

	// The date and time when the most recent version of the action was created, in
	// timestamp format.
	//
	// This member is required.
	Created *time.Time

	// The unique identifier of the change that set the state to this revision (for
	// example, a deployment ID or timestamp).
	//
	// This member is required.
	RevisionChangeId *string

	// The system-generated unique ID that identifies the revision number of the
	// action.
	//
	// This member is required.
	RevisionId *string
}

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

type ActionState 

type ActionState struct {

	// The name of the action.
	ActionName *string

	// Represents information about the version (or revision) of an action.
	CurrentRevision *ActionRevision

	// A URL link for more information about the state of the action, such as a
	// deployment group details page.
	EntityUrl *string

	// Represents information about the run of an action.
	LatestExecution *ActionExecution

	// A URL link for more information about the revision, such as a commit details
	// page.
	RevisionUrl *string
}

Represents information about the state of an action.

type ActionType 

type ActionType struct {

	// Represents information about an action type.
	//
	// This member is required.
	Id *ActionTypeId

	// The details of the input artifact for the action, such as its commit ID.
	//
	// This member is required.
	InputArtifactDetails *ArtifactDetails

	// The details of the output artifact of the action, such as its commit ID.
	//
	// This member is required.
	OutputArtifactDetails *ArtifactDetails

	// The configuration properties for the action type.
	ActionConfigurationProperties []ActionConfigurationProperty

	// The settings for the action type.
	Settings *ActionTypeSettings
}

Returns information about the details of an action type.

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
	// following values.
	//
	// * Source
	//
	// * Build
	//
	// * Test
	//
	// * Deploy
	//
	// * Invoke
	//
	// * Approval
	//
	// This member is required.
	Category ActionCategory

	// The creator of the action being called. There are three valid values for the
	// Owner field in the action category section within your pipeline structure: AWS,
	// ThirdParty, and Custom. For more information, see Valid Action Types and
	// Providers in CodePipeline
	// (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers).
	//
	// This member is required.
	Owner 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. For more information, see Valid Action Types and Providers in
	// CodePipeline
	// (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers).
	//
	// This member is required.
	Provider *string

	// A string that describes the action version.
	//
	// This member is required.
	Version *string
}

Represents information about an action type.

type ActionTypeNotFoundException 

type ActionTypeNotFoundException struct {
	Message *string
}

The specified action type cannot be found.

func (*ActionTypeNotFoundException) Error 

func (e *ActionTypeNotFoundException) Error() string

func (*ActionTypeNotFoundException) ErrorCode 

func (e *ActionTypeNotFoundException) ErrorCode() string

func (*ActionTypeNotFoundException) ErrorFault 

func (e *ActionTypeNotFoundException) ErrorFault() smithy.ErrorFault

func (*ActionTypeNotFoundException) ErrorMessage 

func (e *ActionTypeNotFoundException) ErrorMessage() string

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
	// in the pipeline.
	EntityUrlTemplate *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 the 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

	// 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

	// 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
}

Returns information about the settings for an action type.

type ApprovalAlreadyCompletedException 

type ApprovalAlreadyCompletedException struct {
	Message *string
}

The approval action has already been approved or rejected.

func (*ApprovalAlreadyCompletedException) Error 

func (e *ApprovalAlreadyCompletedException) Error() string

func (*ApprovalAlreadyCompletedException) ErrorCode 

func (e *ApprovalAlreadyCompletedException) ErrorCode() string

func (*ApprovalAlreadyCompletedException) ErrorFault 

func (e *ApprovalAlreadyCompletedException) ErrorFault() smithy.ErrorFault

func (*ApprovalAlreadyCompletedException) ErrorMessage 

func (e *ApprovalAlreadyCompletedException) ErrorMessage() string

type ApprovalResult 

type ApprovalResult struct {

	// The response submitted by a reviewer assigned to an approval action request.
	//
	// This member is required.
	Status ApprovalStatus

	// The summary of the current status of the approval request.
	//
	// This member is required.
	Summary *string
}

Represents information about the result of an approval request.

type ApprovalStatus 

type ApprovalStatus string
const (
	ApprovalStatusApproved ApprovalStatus = "Approved"
	ApprovalStatusRejected ApprovalStatus = "Rejected"
)

Enum values for ApprovalStatus

func (ApprovalStatus) Values added in v0.29.0 

func (ApprovalStatus) Values() []ApprovalStatus

Values returns all known values for ApprovalStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Artifact 

type Artifact struct {

	// The location of an artifact.
	Location *ArtifactLocation

	// The artifact's name.
	Name *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
}

Represents information about an artifact that is worked on by actions in the pipeline.

type ArtifactDetail 

type ArtifactDetail struct {

	// The artifact object name for the action execution.
	Name *string

	// The Amazon S3 artifact location for the action execution.
	S3location *S3Location
}

Artifact details for the action execution, such as the artifact location.

type ArtifactDetails 

type ArtifactDetails struct {

	// The maximum number of artifacts allowed for the action type.
	//
	// This member is required.
	MaximumCount int32

	// The minimum number of artifacts allowed for the action type.
	//
	// This member is required.
	MinimumCount int32
}

Returns information about the details of an artifact.

type ArtifactLocation 

type ArtifactLocation struct {

	// The S3 bucket that contains the artifact.
	S3Location *S3ArtifactLocation

	// The type of artifact in the location.
	Type ArtifactLocationType
}

Represents information about the location of an artifact.

type ArtifactLocationType 

type ArtifactLocationType string
const (
	ArtifactLocationTypeS3 ArtifactLocationType = "S3"
)

Enum values for ArtifactLocationType

func (ArtifactLocationType) Values added in v0.29.0 

func (ArtifactLocationType) Values() []ArtifactLocationType

Values returns all known values for ArtifactLocationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ArtifactRevision 

type ArtifactRevision struct {

	// The date and time when the most recent revision of the artifact was created, in
	// timestamp format.
	Created *time.Time

	// The name of an artifact. This name might be system-generated, such as "MyApp",
	// or defined by the user when an action is created.
	Name *string

	// An additional identifier for a revision, such as a commit date or, for artifacts
	// stored in Amazon S3 buckets, the ETag value.
	RevisionChangeIdentifier *string

	// The revision ID of the artifact.
	RevisionId *string

	// Summary information about the most recent revision of the artifact. For GitHub
	// and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or
	// actions, the user-provided content of a codepipeline-artifact-revision-summary
	// key specified in the object metadata.
	RevisionSummary *string

	// The commit ID for the artifact revision. For artifacts stored in GitHub or AWS
	// CodeCommit repositories, the commit ID is linked to a commit details page.
	RevisionUrl *string
}

Represents revision details of an artifact.

type ArtifactStore 

type ArtifactStore struct {

	// The S3 bucket used for storing the artifacts for a pipeline. You can specify the
	// name of an S3 bucket but not a folder in the bucket. A folder to contain the
	// pipeline artifacts is created for you based on the name of the pipeline. You can
	// use any S3 bucket in the same AWS Region as the pipeline to store your pipeline
	// artifacts.
	//
	// This member is required.
	Location *string

	// The type of the artifact store, such as S3.
	//
	// This member is required.
	Type ArtifactStoreType

	// 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
}

The S3 bucket where artifacts for the pipeline are stored. You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

type ArtifactStoreType 

type ArtifactStoreType string
const (
	ArtifactStoreTypeS3 ArtifactStoreType = "S3"
)

Enum values for ArtifactStoreType

func (ArtifactStoreType) Values added in v0.29.0 

func (ArtifactStoreType) Values() []ArtifactStoreType

Values returns all known values for ArtifactStoreType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BlockerDeclaration 

type BlockerDeclaration struct {

	// Reserved for future use.
	//
	// This member is required.
	Name *string

	// Reserved for future use.
	//
	// This member is required.
	Type BlockerType
}

Reserved for future use.

type BlockerType 

type BlockerType string
const (
	BlockerTypeSchedule BlockerType = "Schedule"
)

Enum values for BlockerType

func (BlockerType) Values added in v0.29.0 

func (BlockerType) Values() []BlockerType

Values returns all known values for BlockerType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ConcurrentModificationException 

type ConcurrentModificationException struct {
	Message *string
}

Unable to modify the tag due to a simultaneous update request.

func (*ConcurrentModificationException) Error 

func (e *ConcurrentModificationException) Error() string

func (*ConcurrentModificationException) ErrorCode 

func (e *ConcurrentModificationException) ErrorCode() string

func (*ConcurrentModificationException) ErrorFault 

func (e *ConcurrentModificationException) ErrorFault() smithy.ErrorFault

func (*ConcurrentModificationException) ErrorMessage 

func (e *ConcurrentModificationException) ErrorMessage() string

type ConflictException added in v0.30.0 

type ConflictException struct {
	Message *string
}

Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.

func (*ConflictException) Error added in v0.30.0 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode added in v0.30.0 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault added in v0.30.0 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage added in v0.30.0 

func (e *ConflictException) ErrorMessage() string

type CurrentRevision 

type CurrentRevision struct {

	// The change identifier for the current revision.
	//
	// This member is required.
	ChangeIdentifier *string

	// The revision ID of the current version of an artifact.
	//
	// This member is required.
	Revision *string

	// The date and time when the most recent revision of the artifact was created, in
	// timestamp format.
	Created *time.Time

	// The summary of the most recent revision of the artifact.
	RevisionSummary *string
}

Represents information about a current revision.

type DuplicatedStopRequestException 

type DuplicatedStopRequestException struct {
	Message *string
}

The pipeline execution is already in a Stopping state. If you already chose to stop and wait, you cannot make that request again. You can choose to stop and abandon now, but be aware that this option can lead to failed tasks or out of sequence tasks. If you already chose to stop and abandon, you cannot make that request again.

func (*DuplicatedStopRequestException) Error 

func (e *DuplicatedStopRequestException) Error() string

func (*DuplicatedStopRequestException) ErrorCode 

func (e *DuplicatedStopRequestException) ErrorCode() string

func (*DuplicatedStopRequestException) ErrorFault 

func (e *DuplicatedStopRequestException) ErrorFault() smithy.ErrorFault

func (*DuplicatedStopRequestException) ErrorMessage 

func (e *DuplicatedStopRequestException) ErrorMessage() string

type EncryptionKey 

type EncryptionKey struct {

	// The ID used to identify the key. For an AWS KMS key, you can use the key ID, the
	// key ARN, or the alias ARN. Aliases are recognized only in the account that
	// created the customer master key (CMK). For cross-account actions, you can only
	// use the key ID or key ARN to identify the key.
	//
	// This member is required.
	Id *string

	// 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'.
	//
	// This member is required.
	Type EncryptionKeyType
}

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

type EncryptionKeyType 

type EncryptionKeyType string
const (
	EncryptionKeyTypeKms EncryptionKeyType = "KMS"
)

Enum values for EncryptionKeyType

func (EncryptionKeyType) Values added in v0.29.0 

func (EncryptionKeyType) Values() []EncryptionKeyType

Values returns all known values for EncryptionKeyType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ErrorDetails 

type ErrorDetails struct {

	// The system ID or number code of the error.
	Code *string

	// The text of the error message.
	Message *string
}

Represents information about an error in AWS CodePipeline.

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

	// The percentage of work completed on the action, represented on a scale of 0 to
	// 100 percent.
	PercentComplete *int32

	// The summary of the current status of the actions.
	Summary *string
}

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

type ExecutionTrigger 

type ExecutionTrigger struct {

	// Detail related to the event that started a pipeline execution, such as the
	// webhook ARN of the webhook that triggered the pipeline execution or the user ARN
	// for a user-initiated start-pipeline-execution CLI command.
	TriggerDetail *string

	// The type of change-detection method, command, or user interaction that started a
	// pipeline execution.
	TriggerType TriggerType
}

The interaction or event that started a pipeline execution.

type FailureDetails 

type FailureDetails struct {

	// The message about the failure.
	//
	// This member is required.
	Message *string

	// The type of the failure.
	//
	// This member is required.
	Type FailureType

	// The external ID of the run of the action that failed.
	ExternalExecutionId *string
}

Represents information about failure details.

type FailureType 

type FailureType string
const (
	FailureTypeJobFailed           FailureType = "JobFailed"
	FailureTypeConfigurationError  FailureType = "ConfigurationError"
	FailureTypePermissionError     FailureType = "PermissionError"
	FailureTypeRevisionOutOfSync   FailureType = "RevisionOutOfSync"
	FailureTypeRevisionUnavailable FailureType = "RevisionUnavailable"
	FailureTypeSystemUnavailable   FailureType = "SystemUnavailable"
)

Enum values for FailureType

func (FailureType) Values added in v0.29.0 

func (FailureType) Values() []FailureType

Values returns all known values for FailureType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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.
	//
	// This member is required.
	Name *string
}

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

type InvalidActionDeclarationException 

type InvalidActionDeclarationException struct {
	Message *string
}

The action declaration was specified in an invalid format.

func (*InvalidActionDeclarationException) Error 

func (e *InvalidActionDeclarationException) Error() string

func (*InvalidActionDeclarationException) ErrorCode 

func (e *InvalidActionDeclarationException) ErrorCode() string

func (*InvalidActionDeclarationException) ErrorFault 

func (e *InvalidActionDeclarationException) ErrorFault() smithy.ErrorFault

func (*InvalidActionDeclarationException) ErrorMessage 

func (e *InvalidActionDeclarationException) ErrorMessage() string

type InvalidApprovalTokenException 

type InvalidApprovalTokenException struct {
	Message *string
}

The approval request already received a response or has expired.

func (*InvalidApprovalTokenException) Error 

func (e *InvalidApprovalTokenException) Error() string

func (*InvalidApprovalTokenException) ErrorCode 

func (e *InvalidApprovalTokenException) ErrorCode() string

func (*InvalidApprovalTokenException) ErrorFault 

func (e *InvalidApprovalTokenException) ErrorFault() smithy.ErrorFault

func (*InvalidApprovalTokenException) ErrorMessage 

func (e *InvalidApprovalTokenException) ErrorMessage() string

type InvalidArnException 

type InvalidArnException struct {
	Message *string
}

The specified resource ARN is invalid.

func (*InvalidArnException) Error 

func (e *InvalidArnException) Error() string

func (*InvalidArnException) ErrorCode 

func (e *InvalidArnException) ErrorCode() string

func (*InvalidArnException) ErrorFault 

func (e *InvalidArnException) ErrorFault() smithy.ErrorFault

func (*InvalidArnException) ErrorMessage 

func (e *InvalidArnException) ErrorMessage() string

type InvalidBlockerDeclarationException 

type InvalidBlockerDeclarationException struct {
	Message *string
}

Reserved for future use.

func (*InvalidBlockerDeclarationException) Error 

func (e *InvalidBlockerDeclarationException) Error() string

func (*InvalidBlockerDeclarationException) ErrorCode 

func (e *InvalidBlockerDeclarationException) ErrorCode() string

func (*InvalidBlockerDeclarationException) ErrorFault 

func (e *InvalidBlockerDeclarationException) ErrorFault() smithy.ErrorFault

func (*InvalidBlockerDeclarationException) ErrorMessage 

func (e *InvalidBlockerDeclarationException) ErrorMessage() string

type InvalidClientTokenException 

type InvalidClientTokenException struct {
	Message *string
}

The client token was specified in an invalid format

func (*InvalidClientTokenException) Error 

func (e *InvalidClientTokenException) Error() string

func (*InvalidClientTokenException) ErrorCode 

func (e *InvalidClientTokenException) ErrorCode() string

func (*InvalidClientTokenException) ErrorFault 

func (e *InvalidClientTokenException) ErrorFault() smithy.ErrorFault

func (*InvalidClientTokenException) ErrorMessage 

func (e *InvalidClientTokenException) ErrorMessage() string

type InvalidJobException 

type InvalidJobException struct {
	Message *string
}

The job was specified in an invalid format or cannot be found.

func (*InvalidJobException) Error 

func (e *InvalidJobException) Error() string

func (*InvalidJobException) ErrorCode 

func (e *InvalidJobException) ErrorCode() string

func (*InvalidJobException) ErrorFault 

func (e *InvalidJobException) ErrorFault() smithy.ErrorFault

func (*InvalidJobException) ErrorMessage 

func (e *InvalidJobException) ErrorMessage() string

type InvalidJobStateException 

type InvalidJobStateException struct {
	Message *string
}

The job state was specified in an invalid format.

func (*InvalidJobStateException) Error 

func (e *InvalidJobStateException) Error() string

func (*InvalidJobStateException) ErrorCode 

func (e *InvalidJobStateException) ErrorCode() string

func (*InvalidJobStateException) ErrorFault 

func (e *InvalidJobStateException) ErrorFault() smithy.ErrorFault

func (*InvalidJobStateException) ErrorMessage 

func (e *InvalidJobStateException) ErrorMessage() string

type InvalidNextTokenException 

type InvalidNextTokenException struct {
	Message *string
}

The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.

func (*InvalidNextTokenException) Error 

func (e *InvalidNextTokenException) Error() string

func (*InvalidNextTokenException) ErrorCode 

func (e *InvalidNextTokenException) ErrorCode() string

func (*InvalidNextTokenException) ErrorFault 

func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault

func (*InvalidNextTokenException) ErrorMessage 

func (e *InvalidNextTokenException) ErrorMessage() string

type InvalidNonceException 

type InvalidNonceException struct {
	Message *string
}

The nonce was specified in an invalid format.

func (*InvalidNonceException) Error 

func (e *InvalidNonceException) Error() string

func (*InvalidNonceException) ErrorCode 

func (e *InvalidNonceException) ErrorCode() string

func (*InvalidNonceException) ErrorFault 

func (e *InvalidNonceException) ErrorFault() smithy.ErrorFault

func (*InvalidNonceException) ErrorMessage 

func (e *InvalidNonceException) ErrorMessage() string

type InvalidStageDeclarationException 

type InvalidStageDeclarationException struct {
	Message *string
}

The stage declaration was specified in an invalid format.

func (*InvalidStageDeclarationException) Error 

func (e *InvalidStageDeclarationException) Error() string

func (*InvalidStageDeclarationException) ErrorCode 

func (e *InvalidStageDeclarationException) ErrorCode() string

func (*InvalidStageDeclarationException) ErrorFault 

func (e *InvalidStageDeclarationException) ErrorFault() smithy.ErrorFault

func (*InvalidStageDeclarationException) ErrorMessage 

func (e *InvalidStageDeclarationException) ErrorMessage() string

type InvalidStructureException 

type InvalidStructureException struct {
	Message *string
}

The structure was specified in an invalid format.

func (*InvalidStructureException) Error 

func (e *InvalidStructureException) Error() string

func (*InvalidStructureException) ErrorCode 

func (e *InvalidStructureException) ErrorCode() string

func (*InvalidStructureException) ErrorFault 

func (e *InvalidStructureException) ErrorFault() smithy.ErrorFault

func (*InvalidStructureException) ErrorMessage 

func (e *InvalidStructureException) ErrorMessage() string

type InvalidTagsException 

type InvalidTagsException struct {
	Message *string
}

The specified resource tags are invalid.

func (*InvalidTagsException) Error 

func (e *InvalidTagsException) Error() string

func (*InvalidTagsException) ErrorCode 

func (e *InvalidTagsException) ErrorCode() string

func (*InvalidTagsException) ErrorFault 

func (e *InvalidTagsException) ErrorFault() smithy.ErrorFault

func (*InvalidTagsException) ErrorMessage 

func (e *InvalidTagsException) ErrorMessage() string

type InvalidWebhookAuthenticationParametersException 

type InvalidWebhookAuthenticationParametersException struct {
	Message *string
}

The specified authentication type is in an invalid format.

func (*InvalidWebhookAuthenticationParametersException) Error 

func (e *InvalidWebhookAuthenticationParametersException) Error() string

func (*InvalidWebhookAuthenticationParametersException) ErrorCode 

func (e *InvalidWebhookAuthenticationParametersException) ErrorCode() string

func (*InvalidWebhookAuthenticationParametersException) ErrorFault 

func (e *InvalidWebhookAuthenticationParametersException) ErrorFault() smithy.ErrorFault

func (*InvalidWebhookAuthenticationParametersException) ErrorMessage 

func (e *InvalidWebhookAuthenticationParametersException) ErrorMessage() string

type InvalidWebhookFilterPatternException 

type InvalidWebhookFilterPatternException struct {
	Message *string
}

The specified event filter rule is in an invalid format.

func (*InvalidWebhookFilterPatternException) Error 

func (e *InvalidWebhookFilterPatternException) Error() string

func (*InvalidWebhookFilterPatternException) ErrorCode 

func (e *InvalidWebhookFilterPatternException) ErrorCode() string

func (*InvalidWebhookFilterPatternException) ErrorFault 

func (e *InvalidWebhookFilterPatternException) ErrorFault() smithy.ErrorFault

func (*InvalidWebhookFilterPatternException) ErrorMessage 

func (e *InvalidWebhookFilterPatternException) ErrorMessage() string

type Job 

type Job struct {

	// The ID of the AWS account to use when performing the job.
	AccountId *string

	// Other data about a job.
	Data *JobData

	// The unique system-generated ID of the job.
	Id *string

	// A system-generated random number that AWS CodePipeline uses to ensure that the
	// job is being worked on by only one job worker. Use this number in an
	// AcknowledgeJob request.
	Nonce *string
}

Represents information about a job.

type JobData 

type JobData struct {

	// Represents information about an action configuration.
	ActionConfiguration *ActionConfiguration

	// Represents information about an action type.
	ActionTypeId *ActionTypeId

	// 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 S3 bucket used to store artifacts
	// for the pipeline in AWS CodePipeline.
	ArtifactCredentials *AWSSessionCredentials

	// A system-generated token, such as a AWS CodeDeploy deployment ID, required by a
	// job to continue the job asynchronously.
	ContinuationToken *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

	// The artifact supplied to the job.
	InputArtifacts []Artifact

	// The output of the job.
	OutputArtifacts []Artifact

	// Represents information about a pipeline to a job worker. Includes pipelineArn
	// and pipelineExecutionId for custom jobs.
	PipelineContext *PipelineContext
}

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

type JobDetails 

type JobDetails struct {

	// The AWS account ID associated with the job.
	AccountId *string

	// Represents other information about a job required for a job worker to complete
	// the job.
	Data *JobData

	// The unique system-generated ID of the job.
	Id *string
}

Represents information about the details of a job.

type JobNotFoundException 

type JobNotFoundException struct {
	Message *string
}

The job was specified in an invalid format or cannot be found.

func (*JobNotFoundException) Error 

func (e *JobNotFoundException) Error() string

func (*JobNotFoundException) ErrorCode 

func (e *JobNotFoundException) ErrorCode() string

func (*JobNotFoundException) ErrorFault 

func (e *JobNotFoundException) ErrorFault() smithy.ErrorFault

func (*JobNotFoundException) ErrorMessage 

func (e *JobNotFoundException) ErrorMessage() string

type JobStatus 

type JobStatus string
const (
	JobStatusCreated    JobStatus = "Created"
	JobStatusQueued     JobStatus = "Queued"
	JobStatusDispatched JobStatus = "Dispatched"
	JobStatusInProgress JobStatus = "InProgress"
	JobStatusTimedOut   JobStatus = "TimedOut"
	JobStatusSucceeded  JobStatus = "Succeeded"
	JobStatusFailed     JobStatus = "Failed"
)

Enum values for JobStatus

func (JobStatus) Values added in v0.29.0 

func (JobStatus) Values() []JobStatus

Values returns all known values for JobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LimitExceededException 

type LimitExceededException struct {
	Message *string
}

The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type ListWebhookItem 

type ListWebhookItem struct {

	// The detail returned for each webhook, such as the webhook authentication type
	// and filter rules.
	//
	// This member is required.
	Definition *WebhookDefinition

	// A unique URL generated by CodePipeline. When a POST request is made to this URL,
	// the defined pipeline is started as long as the body of the post request
	// satisfies the defined authentication and filtering conditions. Deleting and
	// re-creating a webhook makes the old URL invalid and generates a new one.
	//
	// This member is required.
	Url *string

	// The Amazon Resource Name (ARN) of the webhook.
	Arn *string

	// The number code of the error.
	ErrorCode *string

	// The text of the error message about the webhook.
	ErrorMessage *string

	// The date and time a webhook was last successfully triggered, in timestamp
	// format.
	LastTriggered *time.Time

	// Specifies the tags applied to the webhook.
	Tags []Tag
}

The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.

type NotLatestPipelineExecutionException 

type NotLatestPipelineExecutionException struct {
	Message *string
}

The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.

func (*NotLatestPipelineExecutionException) Error 

func (e *NotLatestPipelineExecutionException) Error() string

func (*NotLatestPipelineExecutionException) ErrorCode 

func (e *NotLatestPipelineExecutionException) ErrorCode() string

func (*NotLatestPipelineExecutionException) ErrorFault 

func (e *NotLatestPipelineExecutionException) ErrorFault() smithy.ErrorFault

func (*NotLatestPipelineExecutionException) ErrorMessage 

func (e *NotLatestPipelineExecutionException) ErrorMessage() string

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.
	//
	// This member is required.
	Name *string
}

Represents information about the output of an action.

type OutputVariablesSizeExceededException 

type OutputVariablesSizeExceededException struct {
	Message *string
}

Exceeded the total size limit for all variables in the pipeline.

func (*OutputVariablesSizeExceededException) Error 

func (e *OutputVariablesSizeExceededException) Error() string

func (*OutputVariablesSizeExceededException) ErrorCode 

func (e *OutputVariablesSizeExceededException) ErrorCode() string

func (*OutputVariablesSizeExceededException) ErrorFault 

func (e *OutputVariablesSizeExceededException) ErrorFault() smithy.ErrorFault

func (*OutputVariablesSizeExceededException) ErrorMessage 

func (e *OutputVariablesSizeExceededException) ErrorMessage() string

type PipelineContext 

type PipelineContext struct {

	// The context of an action to a job worker in the stage of a pipeline.
	Action *ActionContext

	// The Amazon Resource Name (ARN) of the pipeline.
	PipelineArn *string

	// The execution ID of the pipeline.
	PipelineExecutionId *string

	// 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

	// The stage of the pipeline.
	Stage *StageContext
}

Represents information about a pipeline to a job worker. PipelineContext contains pipelineArn and pipelineExecutionId for custom action jobs. The pipelineArn and pipelineExecutionId fields are not populated for ThirdParty action jobs.

type PipelineDeclaration 

type PipelineDeclaration struct {

	// The name of the pipeline.
	//
	// This member is required.
	Name *string

	// 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.
	//
	// This member is required.
	RoleArn *string

	// The stage in which to perform the action.
	//
	// This member is required.
	Stages []StageDeclaration

	// Represents information about the S3 bucket where artifacts are stored for the
	// pipeline. You must include either artifactStore or artifactStores in your
	// pipeline, but you cannot use both. If you create a cross-region action in your
	// pipeline, you must use artifactStores.
	ArtifactStore *ArtifactStore

	// A mapping of artifactStore objects and their corresponding AWS Regions. There
	// must be an artifact store for the pipeline Region and for each cross-region
	// action in the pipeline. You must include either artifactStore or artifactStores
	// in your pipeline, but you cannot use both. If you create a cross-region action
	// in your pipeline, you must use artifactStores.
	ArtifactStores map[string]ArtifactStore

	// The version number of the pipeline. A new pipeline always has a version number
	// of 1. This number is incremented when a pipeline is updated.
	Version *int32
}

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

type PipelineExecution 

type PipelineExecution struct {

	// A list of ArtifactRevision objects included in a pipeline execution.
	ArtifactRevisions []ArtifactRevision

	// The ID of the pipeline execution.
	PipelineExecutionId *string

	// The name of the pipeline with the specified pipeline execution.
	PipelineName *string

	// The version number of the pipeline with the specified pipeline execution.
	PipelineVersion *int32

	// The status of the pipeline execution.
	//
	// * InProgress: The pipeline execution is
	// currently running.
	//
	// * Stopped: The pipeline execution was manually stopped. For
	// more information, see Stopped Executions
	// (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped).
	//
	// *
	// Stopping: The pipeline execution received a request to be manually stopped.
	// Depending on the selected stop mode, the execution is either completing or
	// abandoning in-progress actions. For more information, see Stopped Executions
	// (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped).
	//
	// *
	// Succeeded: The pipeline execution was completed successfully.
	//
	// * Superseded:
	// While this pipeline execution was waiting for the next stage to be completed, a
	// newer pipeline execution advanced and continued through the pipeline instead.
	// For more information, see Superseded Executions
	// (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-superseded).
	//
	// *
	// Failed: The pipeline execution was not completed successfully.
	Status PipelineExecutionStatus
}

Represents information about an execution of a pipeline.

type PipelineExecutionNotFoundException 

type PipelineExecutionNotFoundException struct {
	Message *string
}

The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.

func (*PipelineExecutionNotFoundException) Error 

func (e *PipelineExecutionNotFoundException) Error() string

func (*PipelineExecutionNotFoundException) ErrorCode 

func (e *PipelineExecutionNotFoundException) ErrorCode() string

func (*PipelineExecutionNotFoundException) ErrorFault 

func (e *PipelineExecutionNotFoundException) ErrorFault() smithy.ErrorFault

func (*PipelineExecutionNotFoundException) ErrorMessage 

func (e *PipelineExecutionNotFoundException) ErrorMessage() string

type PipelineExecutionNotStoppableException 

type PipelineExecutionNotStoppableException struct {
	Message *string
}

Unable to stop the pipeline execution. The execution might already be in a Stopped state, or it might no longer be in progress.

func (*PipelineExecutionNotStoppableException) Error 

func (e *PipelineExecutionNotStoppableException) Error() string

func (*PipelineExecutionNotStoppableException) ErrorCode 

func (e *PipelineExecutionNotStoppableException) ErrorCode() string

func (*PipelineExecutionNotStoppableException) ErrorFault 

func (e *PipelineExecutionNotStoppableException) ErrorFault() smithy.ErrorFault

func (*PipelineExecutionNotStoppableException) ErrorMessage 

func (e *PipelineExecutionNotStoppableException) ErrorMessage() string

type PipelineExecutionStatus 

type PipelineExecutionStatus string
const (
	PipelineExecutionStatusInProgress PipelineExecutionStatus = "InProgress"
	PipelineExecutionStatusStopped    PipelineExecutionStatus = "Stopped"
	PipelineExecutionStatusStopping   PipelineExecutionStatus = "Stopping"
	PipelineExecutionStatusSucceeded  PipelineExecutionStatus = "Succeeded"
	PipelineExecutionStatusSuperseded PipelineExecutionStatus = "Superseded"
	PipelineExecutionStatusFailed     PipelineExecutionStatus = "Failed"
)

Enum values for PipelineExecutionStatus

func (PipelineExecutionStatus) Values added in v0.29.0 

func (PipelineExecutionStatus) Values() []PipelineExecutionStatus

Values returns all known values for PipelineExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PipelineExecutionSummary 

type PipelineExecutionSummary struct {

	// The date and time of the last change to the pipeline execution, in timestamp
	// format.
	LastUpdateTime *time.Time

	// The ID of the pipeline execution.
	PipelineExecutionId *string

	// A list of the source artifact revisions that initiated a pipeline execution.
	SourceRevisions []SourceRevision

	// The date and time when the pipeline execution began, in timestamp format.
	StartTime *time.Time

	// The status of the pipeline execution.
	//
	// * InProgress: The pipeline execution is
	// currently running.
	//
	// * Stopped: The pipeline execution was manually stopped. For
	// more information, see Stopped Executions
	// (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped).
	//
	// *
	// Stopping: The pipeline execution received a request to be manually stopped.
	// Depending on the selected stop mode, the execution is either completing or
	// abandoning in-progress actions. For more information, see Stopped Executions
	// (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped).
	//
	// *
	// Succeeded: The pipeline execution was completed successfully.
	//
	// * Superseded:
	// While this pipeline execution was waiting for the next stage to be completed, a
	// newer pipeline execution advanced and continued through the pipeline instead.
	// For more information, see Superseded Executions
	// (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-superseded).
	//
	// *
	// Failed: The pipeline execution was not completed successfully.
	Status PipelineExecutionStatus

	// The interaction that stopped a pipeline execution.
	StopTrigger *StopExecutionTrigger

	// The interaction or event that started a pipeline execution, such as automated
	// change detection or a StartPipelineExecution API call.
	Trigger *ExecutionTrigger
}

Summary information about a pipeline execution.

type PipelineMetadata 

type PipelineMetadata struct {

	// The date and time the pipeline was created, in timestamp format.
	Created *time.Time

	// The Amazon Resource Name (ARN) of the pipeline.
	PipelineArn *string

	// The date and time the pipeline was last updated, in timestamp format.
	Updated *time.Time
}

Information about a pipeline.

type PipelineNameInUseException 

type PipelineNameInUseException struct {
	Message *string
}

The specified pipeline name is already in use.

func (*PipelineNameInUseException) Error 

func (e *PipelineNameInUseException) Error() string

func (*PipelineNameInUseException) ErrorCode 

func (e *PipelineNameInUseException) ErrorCode() string

func (*PipelineNameInUseException) ErrorFault 

func (e *PipelineNameInUseException) ErrorFault() smithy.ErrorFault

func (*PipelineNameInUseException) ErrorMessage 

func (e *PipelineNameInUseException) ErrorMessage() string

type PipelineNotFoundException 

type PipelineNotFoundException struct {
	Message *string
}

The pipeline was specified in an invalid format or cannot be found.

func (*PipelineNotFoundException) Error 

func (e *PipelineNotFoundException) Error() string

func (*PipelineNotFoundException) ErrorCode 

func (e *PipelineNotFoundException) ErrorCode() string

func (*PipelineNotFoundException) ErrorFault 

func (e *PipelineNotFoundException) ErrorFault() smithy.ErrorFault

func (*PipelineNotFoundException) ErrorMessage 

func (e *PipelineNotFoundException) ErrorMessage() string

type PipelineSummary 

type PipelineSummary struct {

	// The date and time the pipeline was created, in timestamp format.
	Created *time.Time

	// The name of the pipeline.
	Name *string

	// The date and time of the last update to the pipeline, in timestamp format.
	Updated *time.Time

	// The version number of the pipeline.
	Version *int32
}

Returns a summary of a pipeline.

type PipelineVersionNotFoundException 

type PipelineVersionNotFoundException struct {
	Message *string
}

The pipeline version was specified in an invalid format or cannot be found.

func (*PipelineVersionNotFoundException) Error 

func (e *PipelineVersionNotFoundException) Error() string

func (*PipelineVersionNotFoundException) ErrorCode 

func (e *PipelineVersionNotFoundException) ErrorCode() string

func (*PipelineVersionNotFoundException) ErrorFault 

func (e *PipelineVersionNotFoundException) ErrorFault() smithy.ErrorFault

func (*PipelineVersionNotFoundException) ErrorMessage 

func (e *PipelineVersionNotFoundException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string
}

The resource was specified in an invalid format.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type S3ArtifactLocation 

type S3ArtifactLocation struct {

	// The name of the S3 bucket.
	//
	// This member is required.
	BucketName *string

	// The key of the object in the S3 bucket, which uniquely identifies the object in
	// the bucket.
	//
	// This member is required.
	ObjectKey *string
}

The location of the S3 bucket that contains a revision.

type S3Location 

type S3Location struct {

	// The Amazon S3 artifact bucket for an action's artifacts.
	Bucket *string

	// The artifact name.
	Key *string
}

The Amazon S3 artifact location for an action's artifacts.

type SourceRevision 

type SourceRevision struct {

	// The name of the action that processed the revision to the source artifact.
	//
	// This member is required.
	ActionName *string

	// The system-generated unique ID that identifies the revision number of the
	// artifact.
	RevisionId *string

	// Summary information about the most recent revision of the artifact. For GitHub
	// and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or
	// actions, the user-provided content of a codepipeline-artifact-revision-summary
	// key specified in the object metadata.
	RevisionSummary *string

	// The commit ID for the artifact revision. For artifacts stored in GitHub or AWS
	// CodeCommit repositories, the commit ID is linked to a commit details page.
	RevisionUrl *string
}

Information about the version (or revision) of a source artifact that initiated a pipeline execution.

type StageContext 

type StageContext struct {

	// The name of the stage.
	Name *string
}

Represents information about a stage to a job worker.

type StageDeclaration 

type StageDeclaration struct {

	// The actions included in a stage.
	//
	// This member is required.
	Actions []ActionDeclaration

	// The name of the stage.
	//
	// This member is required.
	Name *string

	// Reserved for future use.
	Blockers []BlockerDeclaration
}

Represents information about a stage and its definition.

type StageExecution 

type StageExecution struct {

	// The ID of the pipeline execution associated with the stage.
	//
	// This member is required.
	PipelineExecutionId *string

	// The status of the stage, or for a completed stage, the last status of the stage.
	//
	// This member is required.
	Status StageExecutionStatus
}

Represents information about the run of a stage.

type StageExecutionStatus 

type StageExecutionStatus string
const (
	StageExecutionStatusInProgress StageExecutionStatus = "InProgress"
	StageExecutionStatusFailed     StageExecutionStatus = "Failed"
	StageExecutionStatusStopped    StageExecutionStatus = "Stopped"
	StageExecutionStatusStopping   StageExecutionStatus = "Stopping"
	StageExecutionStatusSucceeded  StageExecutionStatus = "Succeeded"
)

Enum values for StageExecutionStatus

func (StageExecutionStatus) Values added in v0.29.0 

func (StageExecutionStatus) Values() []StageExecutionStatus

Values returns all known values for StageExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type StageNotFoundException 

type StageNotFoundException struct {
	Message *string
}

The stage was specified in an invalid format or cannot be found.

func (*StageNotFoundException) Error 

func (e *StageNotFoundException) Error() string

func (*StageNotFoundException) ErrorCode 

func (e *StageNotFoundException) ErrorCode() string

func (*StageNotFoundException) ErrorFault 

func (e *StageNotFoundException) ErrorFault() smithy.ErrorFault

func (*StageNotFoundException) ErrorMessage 

func (e *StageNotFoundException) ErrorMessage() string

type StageNotRetryableException 

type StageNotRetryableException struct {
	Message *string
}

Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or the stage contains no failed actions.

func (*StageNotRetryableException) Error 

func (e *StageNotRetryableException) Error() string

func (*StageNotRetryableException) ErrorCode 

func (e *StageNotRetryableException) ErrorCode() string

func (*StageNotRetryableException) ErrorFault 

func (e *StageNotRetryableException) ErrorFault() smithy.ErrorFault

func (*StageNotRetryableException) ErrorMessage 

func (e *StageNotRetryableException) ErrorMessage() string

type StageRetryMode 

type StageRetryMode string
const (
	StageRetryModeFailedActions StageRetryMode = "FAILED_ACTIONS"
)

Enum values for StageRetryMode

func (StageRetryMode) Values added in v0.29.0 

func (StageRetryMode) Values() []StageRetryMode

Values returns all known values for StageRetryMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type StageState 

type StageState struct {

	// The state of the stage.
	ActionStates []ActionState

	// Represents information about the run of a stage.
	InboundExecution *StageExecution

	// The state of the inbound transition, which is either enabled or disabled.
	InboundTransitionState *TransitionState

	// Information about the latest execution in the stage, including its ID and
	// status.
	LatestExecution *StageExecution

	// The name of the stage.
	StageName *string
}

Represents information about the state of the stage.

type StageTransitionType 

type StageTransitionType string
const (
	StageTransitionTypeInbound  StageTransitionType = "Inbound"
	StageTransitionTypeOutbound StageTransitionType = "Outbound"
)

Enum values for StageTransitionType

func (StageTransitionType) Values added in v0.29.0 

func (StageTransitionType) Values() []StageTransitionType

Values returns all known values for StageTransitionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type StopExecutionTrigger 

type StopExecutionTrigger struct {

	// The user-specified reason the pipeline was stopped.
	Reason *string
}

The interaction that stopped a pipeline execution.

type Tag 

type Tag struct {

	// The tag's key.
	//
	// This member is required.
	Key *string

	// The tag's value.
	//
	// This member is required.
	Value *string
}

A tag is a key-value pair that is used to manage the resource.

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

	// The identifier used to identify the job in AWS CodePipeline.
	JobId *string
}

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

type ThirdPartyJobData 

type ThirdPartyJobData struct {

	// Represents information about an action configuration.
	ActionConfiguration *ActionConfiguration

	// Represents information about an action type.
	ActionTypeId *ActionTypeId

	// 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 S3 bucket used to store artifact for
	// the pipeline in AWS CodePipeline.
	ArtifactCredentials *AWSSessionCredentials

	// A system-generated token, such as a AWS CodeDeploy deployment ID, that a job
	// requires to continue the job asynchronously.
	ContinuationToken *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

	// The name of the artifact that is worked on by the action, if any. This name
	// might be system-generated, such as "MyApp", or it 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

	// The name of the artifact that is the result of the action, if any. This name
	// might be system-generated, such as "MyBuiltApp", or it might be defined by the
	// user when the action is created.
	OutputArtifacts []Artifact

	// Represents information about a pipeline to a job worker. Does not include
	// pipelineArn and pipelineExecutionId for ThirdParty jobs.
	PipelineContext *PipelineContext
}

Represents information about the job data for a partner action.

type ThirdPartyJobDetails 

type ThirdPartyJobDetails struct {

	// The data to be returned by the third party job worker.
	Data *ThirdPartyJobData

	// The identifier used to identify the job details in AWS CodePipeline.
	Id *string

	// A system-generated random number that AWS CodePipeline uses to ensure that the
	// job is being worked on by only one job worker. Use this number in an
	// AcknowledgeThirdPartyJob request.
	Nonce *string
}

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

type TooManyTagsException 

type TooManyTagsException struct {
	Message *string
}

The tags limit for a resource has been exceeded.

func (*TooManyTagsException) Error 

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode 

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault 

func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault

func (*TooManyTagsException) ErrorMessage 

func (e *TooManyTagsException) ErrorMessage() string

type TransitionState 

type TransitionState struct {

	// The user-specified reason why the transition between two stages of a pipeline
	// was disabled.
	DisabledReason *string

	// Whether the transition between stages is enabled (true) or disabled (false).
	Enabled bool

	// The timestamp when the transition state was last changed.
	LastChangedAt *time.Time

	// The ID of the user who last changed the transition state.
	LastChangedBy *string
}

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

type TriggerType 

type TriggerType string
const (
	TriggerTypeCreatePipeline         TriggerType = "CreatePipeline"
	TriggerTypeStartPipelineExecution TriggerType = "StartPipelineExecution"
	TriggerTypePollForSourceChanges   TriggerType = "PollForSourceChanges"
	TriggerTypeWebhook                TriggerType = "Webhook"
	TriggerTypeCloudWatchEvent        TriggerType = "CloudWatchEvent"
	TriggerTypePutActionRevision      TriggerType = "PutActionRevision"
)

Enum values for TriggerType

func (TriggerType) Values added in v0.29.0 

func (TriggerType) Values() []TriggerType

Values returns all known values for TriggerType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ValidationException 

type ValidationException struct {
	Message *string
}

The validation was specified in an invalid format.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type WebhookAuthConfiguration 

type WebhookAuthConfiguration struct {

	// The property used to configure acceptance of webhooks in an IP address range.
	// For IP, only the AllowedIPRange property must be set. This property must be set
	// to a valid CIDR range.
	AllowedIPRange *string

	// The property used to configure GitHub authentication. For GITHUB_HMAC, only the
	// SecretToken property must be set.
	SecretToken *string
}

The authentication applied to incoming webhook trigger requests.

type WebhookAuthenticationType 

type WebhookAuthenticationType string
const (
	WebhookAuthenticationTypeGithubHmac      WebhookAuthenticationType = "GITHUB_HMAC"
	WebhookAuthenticationTypeIp              WebhookAuthenticationType = "IP"
	WebhookAuthenticationTypeUnauthenticated WebhookAuthenticationType = "UNAUTHENTICATED"
)

Enum values for WebhookAuthenticationType

func (WebhookAuthenticationType) Values added in v0.29.0 

func (WebhookAuthenticationType) Values() []WebhookAuthenticationType

Values returns all known values for WebhookAuthenticationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type WebhookDefinition 

type WebhookDefinition struct {

	// Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
	//
	// * For information
	// about the authentication scheme implemented by GITHUB_HMAC, see Securing your
	// webhooks (https://developer.github.com/webhooks/securing/) on the GitHub
	// Developer website.
	//
	// * IP rejects webhooks trigger requests unless they originate
	// from an IP address in the IP range whitelisted in the authentication
	// configuration.
	//
	// * UNAUTHENTICATED accepts all webhook trigger requests
	// regardless of origin.
	//
	// This member is required.
	Authentication WebhookAuthenticationType

	// Properties that configure the authentication applied to incoming webhook trigger
	// requests. The required properties depend on the authentication type. For
	// GITHUB_HMAC, only the SecretToken property must be set. For IP, only the
	// AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED,
	// no properties can be set.
	//
	// This member is required.
	AuthenticationConfiguration *WebhookAuthConfiguration

	// A list of rules applied to the body/payload sent in the POST request to a
	// webhook URL. All defined rules must pass for the request to be accepted and the
	// pipeline started.
	//
	// This member is required.
	Filters []WebhookFilterRule

	// The name of the webhook.
	//
	// This member is required.
	Name *string

	// The name of the action in a pipeline you want to connect to the webhook. The
	// action must be from the source (first) stage of the pipeline.
	//
	// This member is required.
	TargetAction *string

	// The name of the pipeline you want to connect to the webhook.
	//
	// This member is required.
	TargetPipeline *string
}

Represents information about a webhook and its definition.

type WebhookFilterRule 

type WebhookFilterRule struct {

	// A JsonPath expression that is applied to the body/payload of the webhook. The
	// value selected by the JsonPath expression must match the value specified in the
	// MatchEquals field. Otherwise, the request is ignored. For more information, see
	// Java JsonPath implementation (https://github.com/json-path/JsonPath) in GitHub.
	//
	// This member is required.
	JsonPath *string

	// The value selected by the JsonPath expression must match what is supplied in the
	// MatchEquals field. Otherwise, the request is ignored. Properties from the target
	// action configuration can be included as placeholders in this value by
	// surrounding the action configuration key with curly brackets. For example, if
	// the value supplied here is "refs/heads/{Branch}" and the target action has an
	// action configuration property called "Branch" with a value of "master", the
	// MatchEquals value is evaluated as "refs/heads/master". For a list of action
	// configuration properties for built-in action types, see Pipeline Structure
	// Reference Action Requirements
	// (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements).
	MatchEquals *string
}

The event criteria that specify when a webhook notification is sent to your URL.

type WebhookNotFoundException 

type WebhookNotFoundException struct {
	Message *string
}

The specified webhook was entered in an invalid format or cannot be found.

func (*WebhookNotFoundException) Error 

func (e *WebhookNotFoundException) Error() string

func (*WebhookNotFoundException) ErrorCode 

func (e *WebhookNotFoundException) ErrorCode() string

func (*WebhookNotFoundException) ErrorFault 

func (e *WebhookNotFoundException) ErrorFault() smithy.ErrorFault

func (*WebhookNotFoundException) ErrorMessage 

func (e *WebhookNotFoundException) ErrorMessage() string

Source Files

View all Source files

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.