Documentation ¶
Overview ¶
Package codepipeline provides the client and types for making API requests to CodePipeline.
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 can only be configured through the API. For more information, see the AWS CodePipeline User Guide (https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html).
You can use the AWS CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
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 the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
GetPipelineExecution, which returns information about a specific execution of a pipeline.
GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.
ListPipelines, which gets a summary of all of the pipelines associated with your account.
ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
StartPipelineExecution, which runs 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. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun 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, see AWS CodePipeline Pipeline Structure Reference (https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html).
Pipeline stages include actions that are categorized into categories such as source or build actions performed in 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. Valid action categories are:
Source
Build
Test
Deploy
Approval
Invoke
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. To integrate with AWS CodePipeline, developers 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 on.
PutJobFailureResult, which provides details of a job failure.
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 on.
PutThirdPartyJobFailureResult, which provides details of a job failure.
PutThirdPartyJobSuccessResult, which provides details of a job success.
See https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09 for more information on this service.
See codepipeline package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/codepipeline/
Using the Client ¶
To use CodePipeline with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the CodePipeline client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/codepipeline/#New
Index ¶
- Constants
- type AWSSessionCredentials
- type AcknowledgeJobInput
- type AcknowledgeJobOutput
- type AcknowledgeJobRequest
- type AcknowledgeJobResponse
- type AcknowledgeThirdPartyJobInput
- type AcknowledgeThirdPartyJobOutput
- type AcknowledgeThirdPartyJobRequest
- type AcknowledgeThirdPartyJobResponse
- type ActionCategory
- type ActionConfiguration
- type ActionConfigurationProperty
- type ActionConfigurationPropertyType
- type ActionContext
- type ActionDeclaration
- type ActionExecution
- type ActionExecutionDetail
- type ActionExecutionFilter
- type ActionExecutionInput
- type ActionExecutionOutput
- type ActionExecutionResult
- type ActionExecutionStatus
- type ActionOwner
- type ActionRevision
- type ActionState
- type ActionType
- type ActionTypeId
- type ActionTypeSettings
- type ApprovalResult
- type ApprovalStatus
- type Artifact
- type ArtifactDetail
- type ArtifactDetails
- type ArtifactLocation
- type ArtifactLocationType
- type ArtifactRevision
- type ArtifactStore
- type ArtifactStoreType
- type BlockerDeclaration
- type BlockerType
- type Client
- func (c *Client) AcknowledgeJobRequest(input *AcknowledgeJobInput) AcknowledgeJobRequest
- func (c *Client) AcknowledgeThirdPartyJobRequest(input *AcknowledgeThirdPartyJobInput) AcknowledgeThirdPartyJobRequest
- func (c *Client) CreateCustomActionTypeRequest(input *CreateCustomActionTypeInput) CreateCustomActionTypeRequest
- func (c *Client) CreatePipelineRequest(input *CreatePipelineInput) CreatePipelineRequest
- func (c *Client) DeleteCustomActionTypeRequest(input *DeleteCustomActionTypeInput) DeleteCustomActionTypeRequest
- func (c *Client) DeletePipelineRequest(input *DeletePipelineInput) DeletePipelineRequest
- func (c *Client) DeleteWebhookRequest(input *DeleteWebhookInput) DeleteWebhookRequest
- func (c *Client) DeregisterWebhookWithThirdPartyRequest(input *DeregisterWebhookWithThirdPartyInput) DeregisterWebhookWithThirdPartyRequest
- func (c *Client) DisableStageTransitionRequest(input *DisableStageTransitionInput) DisableStageTransitionRequest
- func (c *Client) EnableStageTransitionRequest(input *EnableStageTransitionInput) EnableStageTransitionRequest
- func (c *Client) GetJobDetailsRequest(input *GetJobDetailsInput) GetJobDetailsRequest
- func (c *Client) GetPipelineExecutionRequest(input *GetPipelineExecutionInput) GetPipelineExecutionRequest
- func (c *Client) GetPipelineRequest(input *GetPipelineInput) GetPipelineRequest
- func (c *Client) GetPipelineStateRequest(input *GetPipelineStateInput) GetPipelineStateRequest
- func (c *Client) GetThirdPartyJobDetailsRequest(input *GetThirdPartyJobDetailsInput) GetThirdPartyJobDetailsRequest
- func (c *Client) ListActionExecutionsRequest(input *ListActionExecutionsInput) ListActionExecutionsRequest
- func (c *Client) ListActionTypesRequest(input *ListActionTypesInput) ListActionTypesRequest
- func (c *Client) ListPipelineExecutionsRequest(input *ListPipelineExecutionsInput) ListPipelineExecutionsRequest
- func (c *Client) ListPipelinesRequest(input *ListPipelinesInput) ListPipelinesRequest
- func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
- func (c *Client) ListWebhooksRequest(input *ListWebhooksInput) ListWebhooksRequest
- func (c *Client) PollForJobsRequest(input *PollForJobsInput) PollForJobsRequest
- func (c *Client) PollForThirdPartyJobsRequest(input *PollForThirdPartyJobsInput) PollForThirdPartyJobsRequest
- func (c *Client) PutActionRevisionRequest(input *PutActionRevisionInput) PutActionRevisionRequest
- func (c *Client) PutApprovalResultRequest(input *PutApprovalResultInput) PutApprovalResultRequest
- func (c *Client) PutJobFailureResultRequest(input *PutJobFailureResultInput) PutJobFailureResultRequest
- func (c *Client) PutJobSuccessResultRequest(input *PutJobSuccessResultInput) PutJobSuccessResultRequest
- func (c *Client) PutThirdPartyJobFailureResultRequest(input *PutThirdPartyJobFailureResultInput) PutThirdPartyJobFailureResultRequest
- func (c *Client) PutThirdPartyJobSuccessResultRequest(input *PutThirdPartyJobSuccessResultInput) PutThirdPartyJobSuccessResultRequest
- func (c *Client) PutWebhookRequest(input *PutWebhookInput) PutWebhookRequest
- func (c *Client) RegisterWebhookWithThirdPartyRequest(input *RegisterWebhookWithThirdPartyInput) RegisterWebhookWithThirdPartyRequest
- func (c *Client) RetryStageExecutionRequest(input *RetryStageExecutionInput) RetryStageExecutionRequest
- func (c *Client) StartPipelineExecutionRequest(input *StartPipelineExecutionInput) StartPipelineExecutionRequest
- func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
- func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
- func (c *Client) UpdatePipelineRequest(input *UpdatePipelineInput) UpdatePipelineRequest
- type CreateCustomActionTypeInput
- type CreateCustomActionTypeOutput
- type CreateCustomActionTypeRequest
- type CreateCustomActionTypeResponse
- type CreatePipelineInput
- type CreatePipelineOutput
- type CreatePipelineRequest
- type CreatePipelineResponse
- type CurrentRevision
- type DeleteCustomActionTypeInput
- type DeleteCustomActionTypeOutput
- type DeleteCustomActionTypeRequest
- type DeleteCustomActionTypeResponse
- type DeletePipelineInput
- type DeletePipelineOutput
- type DeletePipelineRequest
- type DeletePipelineResponse
- type DeleteWebhookInput
- type DeleteWebhookOutput
- type DeleteWebhookRequest
- type DeleteWebhookResponse
- type DeregisterWebhookWithThirdPartyInput
- type DeregisterWebhookWithThirdPartyOutput
- type DeregisterWebhookWithThirdPartyRequest
- type DeregisterWebhookWithThirdPartyResponse
- type DisableStageTransitionInput
- type DisableStageTransitionOutput
- type DisableStageTransitionRequest
- type DisableStageTransitionResponse
- type EnableStageTransitionInput
- type EnableStageTransitionOutput
- type EnableStageTransitionRequest
- type EnableStageTransitionResponse
- type EncryptionKey
- type EncryptionKeyType
- type ErrorDetails
- type ExecutionDetails
- type ExecutionTrigger
- type FailureDetails
- type FailureType
- type GetJobDetailsInput
- type GetJobDetailsOutput
- type GetJobDetailsRequest
- type GetJobDetailsResponse
- type GetPipelineExecutionInput
- type GetPipelineExecutionOutput
- type GetPipelineExecutionRequest
- type GetPipelineExecutionResponse
- type GetPipelineInput
- type GetPipelineOutput
- type GetPipelineRequest
- type GetPipelineResponse
- type GetPipelineStateInput
- type GetPipelineStateOutput
- type GetPipelineStateRequest
- type GetPipelineStateResponse
- type GetThirdPartyJobDetailsInput
- type GetThirdPartyJobDetailsOutput
- type GetThirdPartyJobDetailsRequest
- type GetThirdPartyJobDetailsResponse
- type InputArtifact
- type Job
- type JobData
- type JobDetails
- type JobStatus
- type ListActionExecutionsInput
- type ListActionExecutionsOutput
- type ListActionExecutionsPaginator
- type ListActionExecutionsRequest
- type ListActionExecutionsResponse
- type ListActionTypesInput
- type ListActionTypesOutput
- type ListActionTypesPaginator
- type ListActionTypesRequest
- type ListActionTypesResponse
- type ListPipelineExecutionsInput
- type ListPipelineExecutionsOutput
- type ListPipelineExecutionsPaginator
- type ListPipelineExecutionsRequest
- type ListPipelineExecutionsResponse
- type ListPipelinesInput
- type ListPipelinesOutput
- type ListPipelinesPaginator
- type ListPipelinesRequest
- type ListPipelinesResponse
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTagsForResourcePaginator
- type ListTagsForResourceRequest
- type ListTagsForResourceResponse
- type ListWebhookItem
- type ListWebhooksInput
- type ListWebhooksOutput
- type ListWebhooksPaginator
- type ListWebhooksRequest
- type ListWebhooksResponse
- type OutputArtifact
- type PipelineContext
- type PipelineDeclaration
- type PipelineExecution
- type PipelineExecutionStatus
- type PipelineExecutionSummary
- type PipelineMetadata
- type PipelineSummary
- type PollForJobsInput
- type PollForJobsOutput
- type PollForJobsRequest
- type PollForJobsResponse
- type PollForThirdPartyJobsInput
- type PollForThirdPartyJobsOutput
- type PollForThirdPartyJobsRequest
- type PollForThirdPartyJobsResponse
- type PutActionRevisionInput
- type PutActionRevisionOutput
- type PutActionRevisionRequest
- type PutActionRevisionResponse
- type PutApprovalResultInput
- type PutApprovalResultOutput
- type PutApprovalResultRequest
- type PutApprovalResultResponse
- type PutJobFailureResultInput
- type PutJobFailureResultOutput
- type PutJobFailureResultRequest
- type PutJobFailureResultResponse
- type PutJobSuccessResultInput
- type PutJobSuccessResultOutput
- type PutJobSuccessResultRequest
- type PutJobSuccessResultResponse
- type PutThirdPartyJobFailureResultInput
- type PutThirdPartyJobFailureResultOutput
- type PutThirdPartyJobFailureResultRequest
- type PutThirdPartyJobFailureResultResponse
- type PutThirdPartyJobSuccessResultInput
- type PutThirdPartyJobSuccessResultOutput
- type PutThirdPartyJobSuccessResultRequest
- type PutThirdPartyJobSuccessResultResponse
- type PutWebhookInput
- type PutWebhookOutput
- type PutWebhookRequest
- type PutWebhookResponse
- type RegisterWebhookWithThirdPartyInput
- type RegisterWebhookWithThirdPartyOutput
- type RegisterWebhookWithThirdPartyRequest
- type RegisterWebhookWithThirdPartyResponse
- type RetryStageExecutionInput
- type RetryStageExecutionOutput
- type RetryStageExecutionRequest
- type RetryStageExecutionResponse
- type S3ArtifactLocation
- type S3Location
- type SourceRevision
- type StageContext
- type StageDeclaration
- type StageExecution
- type StageExecutionStatus
- type StageRetryMode
- type StageState
- type StageTransitionType
- type StartPipelineExecutionInput
- type StartPipelineExecutionOutput
- type StartPipelineExecutionRequest
- type StartPipelineExecutionResponse
- type Tag
- type TagResourceInput
- type TagResourceOutput
- type TagResourceRequest
- type TagResourceResponse
- type ThirdPartyJob
- type ThirdPartyJobData
- type ThirdPartyJobDetails
- type TransitionState
- type TriggerType
- type UntagResourceInput
- type UntagResourceOutput
- type UntagResourceRequest
- type UntagResourceResponse
- type UpdatePipelineInput
- type UpdatePipelineOutput
- type UpdatePipelineRequest
- type UpdatePipelineResponse
- type WebhookAuthConfiguration
- type WebhookAuthenticationType
- type WebhookDefinition
- type WebhookFilterRule
Constants ¶
const ( ServiceName = "CodePipeline" // Service's name ServiceID = "CodePipeline" // Service's identifier EndpointsID = "codepipeline" // Service's Endpoint identifier )
const ( // ErrCodeActionNotFoundException for service response error code // "ActionNotFoundException". // // The specified action cannot be found. ErrCodeActionNotFoundException = "ActionNotFoundException" // ErrCodeActionTypeNotFoundException for service response error code // "ActionTypeNotFoundException". // // The specified action type cannot be found. ErrCodeActionTypeNotFoundException = "ActionTypeNotFoundException" // ErrCodeApprovalAlreadyCompletedException for service response error code // "ApprovalAlreadyCompletedException". // // The approval action has already been approved or rejected. ErrCodeApprovalAlreadyCompletedException = "ApprovalAlreadyCompletedException" // ErrCodeConcurrentModificationException for service response error code // "ConcurrentModificationException". // // Unable to modify the tag due to a simultaneous update request. ErrCodeConcurrentModificationException = "ConcurrentModificationException" // ErrCodeInvalidActionDeclarationException for service response error code // "InvalidActionDeclarationException". // // The action declaration was specified in an invalid format. ErrCodeInvalidActionDeclarationException = "InvalidActionDeclarationException" // ErrCodeInvalidApprovalTokenException for service response error code // "InvalidApprovalTokenException". // // The approval request already received a response or has expired. ErrCodeInvalidApprovalTokenException = "InvalidApprovalTokenException" // ErrCodeInvalidArnException for service response error code // "InvalidArnException". // // The specified resource ARN is invalid. ErrCodeInvalidArnException = "InvalidArnException" // ErrCodeInvalidBlockerDeclarationException for service response error code // "InvalidBlockerDeclarationException". // // Reserved for future use. ErrCodeInvalidBlockerDeclarationException = "InvalidBlockerDeclarationException" // ErrCodeInvalidClientTokenException for service response error code // "InvalidClientTokenException". // // The client token was specified in an invalid format ErrCodeInvalidClientTokenException = "InvalidClientTokenException" // ErrCodeInvalidJobException for service response error code // "InvalidJobException". // // The job was specified in an invalid format or cannot be found. ErrCodeInvalidJobException = "InvalidJobException" // ErrCodeInvalidJobStateException for service response error code // "InvalidJobStateException". // // The job state was specified in an invalid format. ErrCodeInvalidJobStateException = "InvalidJobStateException" // ErrCodeInvalidNextTokenException for service response error code // "InvalidNextTokenException". // // 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. ErrCodeInvalidNextTokenException = "InvalidNextTokenException" // ErrCodeInvalidNonceException for service response error code // "InvalidNonceException". // // The nonce was specified in an invalid format. ErrCodeInvalidNonceException = "InvalidNonceException" // ErrCodeInvalidStageDeclarationException for service response error code // "InvalidStageDeclarationException". // // The stage declaration was specified in an invalid format. ErrCodeInvalidStageDeclarationException = "InvalidStageDeclarationException" // ErrCodeInvalidStructureException for service response error code // "InvalidStructureException". // // The structure was specified in an invalid format. ErrCodeInvalidStructureException = "InvalidStructureException" // ErrCodeInvalidTagsException for service response error code // "InvalidTagsException". // // The specified resource tags are invalid. ErrCodeInvalidTagsException = "InvalidTagsException" // ErrCodeInvalidWebhookAuthenticationParametersException for service response error code // "InvalidWebhookAuthenticationParametersException". // // The specified authentication type is in an invalid format. ErrCodeInvalidWebhookAuthenticationParametersException = "InvalidWebhookAuthenticationParametersException" // ErrCodeInvalidWebhookFilterPatternException for service response error code // "InvalidWebhookFilterPatternException". // // The specified event filter rule is in an invalid format. ErrCodeInvalidWebhookFilterPatternException = "InvalidWebhookFilterPatternException" // ErrCodeJobNotFoundException for service response error code // "JobNotFoundException". // // The job was specified in an invalid format or cannot be found. ErrCodeJobNotFoundException = "JobNotFoundException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // // The number of pipelines associated with the AWS account has exceeded the // limit allowed for the account. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeNotLatestPipelineExecutionException for service response error code // "NotLatestPipelineExecutionException". // // The stage has failed in a later run of the pipeline and the pipelineExecutionId // associated with the request is out of date. ErrCodeNotLatestPipelineExecutionException = "NotLatestPipelineExecutionException" // ErrCodeOutputVariablesSizeExceededException for service response error code // "OutputVariablesSizeExceededException". // // Exceeded the total size limit for all variables in the pipeline. ErrCodeOutputVariablesSizeExceededException = "OutputVariablesSizeExceededException" // ErrCodePipelineExecutionNotFoundException for service response error code // "PipelineExecutionNotFoundException". // // The pipeline execution was specified in an invalid format or cannot be found, // or an execution ID does not belong to the specified pipeline. ErrCodePipelineExecutionNotFoundException = "PipelineExecutionNotFoundException" // ErrCodePipelineNameInUseException for service response error code // "PipelineNameInUseException". // // The specified pipeline name is already in use. ErrCodePipelineNameInUseException = "PipelineNameInUseException" // ErrCodePipelineNotFoundException for service response error code // "PipelineNotFoundException". // // The pipeline was specified in an invalid format or cannot be found. ErrCodePipelineNotFoundException = "PipelineNotFoundException" // ErrCodePipelineVersionNotFoundException for service response error code // "PipelineVersionNotFoundException". // // The pipeline version was specified in an invalid format or cannot be found. ErrCodePipelineVersionNotFoundException = "PipelineVersionNotFoundException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // The resource was specified in an invalid format. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeStageNotFoundException for service response error code // "StageNotFoundException". // // The stage was specified in an invalid format or cannot be found. ErrCodeStageNotFoundException = "StageNotFoundException" // ErrCodeStageNotRetryableException for service response error code // "StageNotRetryableException". // // Unable to retry. The pipeline structure or stage state might have changed // while actions awaited retry, or the stage contains no failed actions. ErrCodeStageNotRetryableException = "StageNotRetryableException" // ErrCodeTooManyTagsException for service response error code // "TooManyTagsException". // // The tags limit for a resource has been exceeded. ErrCodeTooManyTagsException = "TooManyTagsException" // ErrCodeValidationException for service response error code // "ValidationException". // // The validation was specified in an invalid format. ErrCodeValidationException = "ValidationException" // ErrCodeWebhookNotFoundException for service response error code // "WebhookNotFoundException". // // The specified webhook was entered in an invalid format or cannot be found. ErrCodeWebhookNotFoundException = "WebhookNotFoundException" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AWSSessionCredentials ¶
type AWSSessionCredentials struct { // The access key for the session. // // AccessKeyId is a required field AccessKeyId *string `locationName:"accessKeyId" type:"string" required:"true"` // The secret access key for the session. // // SecretAccessKey is a required field SecretAccessKey *string `locationName:"secretAccessKey" type:"string" required:"true"` // The token for the session. // // SessionToken is a required field 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) 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 is a required field 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. Get this number from the // response of the PollForJobs request that returned this job. // // Nonce is a required field Nonce *string `locationName:"nonce" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of an AcknowledgeJob action.
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 JobStatus `locationName:"status" type:"string" enum:"true"` // contains filtered or unexported fields }
Represents the output of an AcknowledgeJob action.
func (AcknowledgeJobOutput) String ¶
func (s AcknowledgeJobOutput) String() string
String returns the string representation
type AcknowledgeJobRequest ¶
type AcknowledgeJobRequest struct { *aws.Request Input *AcknowledgeJobInput Copy func(*AcknowledgeJobInput) AcknowledgeJobRequest }
AcknowledgeJobRequest is the request type for the AcknowledgeJob API operation.
func (AcknowledgeJobRequest) Send ¶
func (r AcknowledgeJobRequest) Send(ctx context.Context) (*AcknowledgeJobResponse, error)
Send marshals and sends the AcknowledgeJob API request.
type AcknowledgeJobResponse ¶ added in v0.9.0
type AcknowledgeJobResponse struct { *AcknowledgeJobOutput // contains filtered or unexported fields }
AcknowledgeJobResponse is the response type for the AcknowledgeJob API operation.
func (*AcknowledgeJobResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *AcknowledgeJobResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AcknowledgeJob request.
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 is a required field ClientToken *string `locationName:"clientToken" min:"1" type:"string" required:"true"` // The unique system-generated ID of the job. // // JobId is a required field 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. Get this number from the // response to a GetThirdPartyJobDetails request. // // Nonce is a required field Nonce *string `locationName:"nonce" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of an AcknowledgeThirdPartyJob action.
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 JobStatus `locationName:"status" type:"string" enum:"true"` // contains filtered or unexported fields }
Represents the output of an AcknowledgeThirdPartyJob action.
func (AcknowledgeThirdPartyJobOutput) String ¶
func (s AcknowledgeThirdPartyJobOutput) String() string
String returns the string representation
type AcknowledgeThirdPartyJobRequest ¶
type AcknowledgeThirdPartyJobRequest struct { *aws.Request Input *AcknowledgeThirdPartyJobInput Copy func(*AcknowledgeThirdPartyJobInput) AcknowledgeThirdPartyJobRequest }
AcknowledgeThirdPartyJobRequest is the request type for the AcknowledgeThirdPartyJob API operation.
func (AcknowledgeThirdPartyJobRequest) Send ¶
func (r AcknowledgeThirdPartyJobRequest) Send(ctx context.Context) (*AcknowledgeThirdPartyJobResponse, error)
Send marshals and sends the AcknowledgeThirdPartyJob API request.
type AcknowledgeThirdPartyJobResponse ¶ added in v0.9.0
type AcknowledgeThirdPartyJobResponse struct { *AcknowledgeThirdPartyJobOutput // contains filtered or unexported fields }
AcknowledgeThirdPartyJobResponse is the response type for the AcknowledgeThirdPartyJob API operation.
func (*AcknowledgeThirdPartyJobResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *AcknowledgeThirdPartyJobResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AcknowledgeThirdPartyJob request.
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) MarshalValue ¶ added in v0.3.0
func (enum ActionCategory) MarshalValue() (string, error)
func (ActionCategory) MarshalValueBuf ¶ added in v0.3.0
func (enum ActionCategory) MarshalValueBuf(b []byte) ([]byte, error)
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) String ¶
func (s ActionConfiguration) String() string
String returns the string representation
type ActionConfigurationProperty ¶
type ActionConfigurationProperty struct { // The description of the action configuration property that is displayed to // users. Description *string `locationName:"description" min:"1" type:"string"` // Whether the configuration property is a key. // // Key is a required field Key *bool `locationName:"key" type:"boolean" required:"true"` // The name of the action configuration property. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // 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 `locationName:"queryable" type:"boolean"` // Whether the configuration property is a required value. // // Required is a required field 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 preserves the previous value of the secret. // // Secret is a required field Secret *bool `locationName:"secret" type:"boolean" required:"true"` // The type of the configuration property. Type ActionConfigurationPropertyType `locationName:"type" type:"string" enum:"true"` // contains filtered or unexported fields }
Represents information about an action configuration property.
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 ActionConfigurationPropertyType ¶
type ActionConfigurationPropertyType string
const ( ActionConfigurationPropertyTypeString ActionConfigurationPropertyType = "String" ActionConfigurationPropertyTypeNumber ActionConfigurationPropertyType = "Number" ActionConfigurationPropertyTypeBoolean ActionConfigurationPropertyType = "Boolean" )
Enum values for ActionConfigurationPropertyType
func (ActionConfigurationPropertyType) MarshalValue ¶ added in v0.3.0
func (enum ActionConfigurationPropertyType) MarshalValue() (string, error)
func (ActionConfigurationPropertyType) MarshalValueBuf ¶ added in v0.3.0
func (enum ActionConfigurationPropertyType) MarshalValueBuf(b []byte) ([]byte, error)
type ActionContext ¶
type ActionContext struct { // The system-generated unique ID that corresponds to an action's execution. ActionExecutionId *string `locationName:"actionExecutionId" type:"string"` // The name of the action in the context of a job. Name *string `locationName:"name" min:"1" type:"string"` // contains filtered or unexported fields }
Represents the context of an action in the stage of a pipeline to a job worker.
func (ActionContext) String ¶
func (s ActionContext) String() string
String returns the string representation
type ActionDeclaration ¶
type ActionDeclaration struct { // Specifies the action type and the provider of the action. // // ActionTypeId is a required field ActionTypeId *ActionTypeId `locationName:"actionTypeId" type:"structure" required:"true"` // 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 `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 is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The variable namespace associated with the action. All variables produced // as output by this action fall under this namespace. Namespace *string `locationName:"namespace" min:"1" type:"string"` // 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 action declaration's AWS Region, such as us-east-1. Region *string `locationName:"region" min:"4" type:"string"` // The ARN of the IAM service role that performs 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) 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 is 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"` // The ARN of the user who last changed the pipeline. LastUpdatedBy *string `locationName:"lastUpdatedBy" type:"string"` // 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 ActionExecutionStatus `locationName:"status" type:"string" enum:"true"` // A summary of the run of the action. Summary *string `locationName:"summary" min:"1" type:"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 `locationName:"token" type:"string"` // contains filtered or unexported fields }
Represents information about the run of an action.
func (ActionExecution) String ¶
func (s ActionExecution) String() string
String returns the string representation
type ActionExecutionDetail ¶ added in v0.8.0
type ActionExecutionDetail struct { // The action execution ID. ActionExecutionId *string `locationName:"actionExecutionId" type:"string"` // The name of the action. ActionName *string `locationName:"actionName" min:"1" type:"string"` // Input details for the action execution, such as role ARN, Region, and input // artifacts. Input *ActionExecutionInput `locationName:"input" type:"structure"` // The last update time of the action execution. LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"` // Output details for the action execution, such as the action execution result. Output *ActionExecutionOutput `locationName:"output" type:"structure"` // The pipeline execution ID for the action execution. PipelineExecutionId *string `locationName:"pipelineExecutionId" type:"string"` // The version of the pipeline where the action was run. PipelineVersion *int64 `locationName:"pipelineVersion" min:"1" type:"integer"` // The name of the stage that contains the action. StageName *string `locationName:"stageName" min:"1" type:"string"` // The start time of the action execution. StartTime *time.Time `locationName:"startTime" type:"timestamp"` // The status of the action execution. Status categories are InProgress, Succeeded, // and Failed. Status ActionExecutionStatus `locationName:"status" type:"string" enum:"true"` // contains filtered or unexported fields }
Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action.
func (ActionExecutionDetail) String ¶ added in v0.8.0
func (s ActionExecutionDetail) String() string
String returns the string representation
type ActionExecutionFilter ¶ added in v0.8.0
type ActionExecutionFilter struct { // The pipeline execution ID used to filter action execution history. PipelineExecutionId *string `locationName:"pipelineExecutionId" type:"string"` // contains filtered or unexported fields }
Filter values for the action execution.
func (ActionExecutionFilter) String ¶ added in v0.8.0
func (s ActionExecutionFilter) String() string
String returns the string representation
type ActionExecutionInput ¶ added in v0.8.0
type ActionExecutionInput struct { // Represents information about an action type. ActionTypeId *ActionTypeId `locationName:"actionTypeId" type:"structure"` // Configuration data for an action execution. Configuration map[string]string `locationName:"configuration" type:"map"` // Details of input artifacts of the action that correspond to the action execution. InputArtifacts []ArtifactDetail `locationName:"inputArtifacts" type:"list"` // The variable namespace associated with the action. All variables produced // as output by this action fall under this namespace. Namespace *string `locationName:"namespace" min:"1" type:"string"` // The AWS Region for the action, such as us-east-1. Region *string `locationName:"region" min:"4" type:"string"` // Configuration data for an action execution with all variable references replaced // with their real values for the execution. ResolvedConfiguration map[string]string `locationName:"resolvedConfiguration" type:"map"` // The ARN of the IAM service role that performs the declared action. This is // assumed through the roleArn for the pipeline. RoleArn *string `locationName:"roleArn" type:"string"` // contains filtered or unexported fields }
Input information used for an action execution.
func (ActionExecutionInput) String ¶ added in v0.8.0
func (s ActionExecutionInput) String() string
String returns the string representation
type ActionExecutionOutput ¶ added in v0.8.0
type ActionExecutionOutput struct { // Execution result information listed in the output details for an action execution. ExecutionResult *ActionExecutionResult `locationName:"executionResult" type:"structure"` // Details of output artifacts of the action that correspond to the action execution. OutputArtifacts []ArtifactDetail `locationName:"outputArtifacts" type:"list"` // The outputVariables field shows the key-value pairs that were output as part // of that execution. OutputVariables map[string]string `locationName:"outputVariables" type:"map"` // contains filtered or unexported fields }
Output details listed for an action execution, such as the action execution result.
func (ActionExecutionOutput) String ¶ added in v0.8.0
func (s ActionExecutionOutput) String() string
String returns the string representation
type ActionExecutionResult ¶ added in v0.8.0
type ActionExecutionResult struct { // The action provider's external ID for the action execution. ExternalExecutionId *string `locationName:"externalExecutionId" type:"string"` // The action provider's summary for the action execution. ExternalExecutionSummary *string `locationName:"externalExecutionSummary" type:"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 `locationName:"externalExecutionUrl" min:"1" type:"string"` // contains filtered or unexported fields }
Execution result information, such as the external execution ID.
func (ActionExecutionResult) String ¶ added in v0.8.0
func (s ActionExecutionResult) String() string
String returns the string representation
type ActionExecutionStatus ¶
type ActionExecutionStatus string
const ( ActionExecutionStatusInProgress ActionExecutionStatus = "InProgress" ActionExecutionStatusSucceeded ActionExecutionStatus = "Succeeded" ActionExecutionStatusFailed ActionExecutionStatus = "Failed" )
Enum values for ActionExecutionStatus
func (ActionExecutionStatus) MarshalValue ¶ added in v0.3.0
func (enum ActionExecutionStatus) MarshalValue() (string, error)
func (ActionExecutionStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum ActionExecutionStatus) MarshalValueBuf(b []byte) ([]byte, error)
type ActionOwner ¶
type ActionOwner string
const ( ActionOwnerAws ActionOwner = "AWS" ActionOwnerThirdParty ActionOwner = "ThirdParty" ActionOwnerCustom ActionOwner = "Custom" )
Enum values for ActionOwner
func (ActionOwner) MarshalValue ¶ added in v0.3.0
func (enum ActionOwner) MarshalValue() (string, error)
func (ActionOwner) MarshalValueBuf ¶ added in v0.3.0
func (enum ActionOwner) MarshalValueBuf(b []byte) ([]byte, error)
type ActionRevision ¶
type ActionRevision struct { // The date and time when the most recent version of the action was created, // in timestamp format. // // Created is a required field Created *time.Time `locationName:"created" type:"timestamp" required:"true"` // The unique identifier of the change that set the state to this revision (for // example, a deployment ID or timestamp). // // RevisionChangeId is a required field RevisionChangeId *string `locationName:"revisionChangeId" min:"1" type:"string" required:"true"` // The system-generated unique ID that identifies the revision number of the // action. // // RevisionId is a required field 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) 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 the run of an action. 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) 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 is a required field Id *ActionTypeId `locationName:"id" type:"structure" required:"true"` // The details of the input artifact for the action, such as its commit ID. // // InputArtifactDetails is a required field InputArtifactDetails *ArtifactDetails `locationName:"inputArtifactDetails" type:"structure" required:"true"` // The details of the output artifact of the action, such as its commit ID. // // OutputArtifactDetails is a required field 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) 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 following values. // // Category is a required field Category ActionCategory `locationName:"category" type:"string" required:"true" enum:"true"` // The creator of the action being called. // // Owner is a required field Owner ActionOwner `locationName:"owner" type:"string" required:"true" enum:"true"` // 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). // // Provider is a required field Provider *string `locationName:"provider" min:"1" type:"string" required:"true"` // A string that describes the action version. // // Version is a required field Version *string `locationName:"version" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents information about an action type.
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 in 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 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 `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) 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 ApprovalResult ¶
type ApprovalResult struct { // The response submitted by a reviewer assigned to an approval action request. // // Status is a required field Status ApprovalStatus `locationName:"status" type:"string" required:"true" enum:"true"` // The summary of the current status of the approval request. // // Summary is a required field Summary *string `locationName:"summary" type:"string" required:"true"` // contains filtered or unexported fields }
Represents information about the result of an approval request.
func (ApprovalResult) String ¶
func (s ApprovalResult) String() string
String returns the string representation
func (*ApprovalResult) Validate ¶
func (s *ApprovalResult) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ApprovalStatus ¶
type ApprovalStatus string
const ( ApprovalStatusApproved ApprovalStatus = "Approved" ApprovalStatusRejected ApprovalStatus = "Rejected" )
Enum values for ApprovalStatus
func (ApprovalStatus) MarshalValue ¶ added in v0.3.0
func (enum ApprovalStatus) MarshalValue() (string, error)
func (ApprovalStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum ApprovalStatus) MarshalValueBuf(b []byte) ([]byte, error)
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 is worked on by actions in the pipeline.
type ArtifactDetail ¶ added in v0.8.0
type ArtifactDetail struct { // The artifact object name for the action execution. Name *string `locationName:"name" min:"1" type:"string"` // The Amazon S3 artifact location for the action execution. S3location *S3Location `locationName:"s3location" type:"structure"` // contains filtered or unexported fields }
Artifact details for the action execution, such as the artifact location.
func (ArtifactDetail) String ¶ added in v0.8.0
func (s ArtifactDetail) String() string
String returns the string representation
type ArtifactDetails ¶
type ArtifactDetails struct { // The maximum number of artifacts allowed for the action type. // // MaximumCount is a required field MaximumCount *int64 `locationName:"maximumCount" type:"integer" required:"true"` // The minimum number of artifacts allowed for the action type. // // MinimumCount is a required field MinimumCount *int64 `locationName:"minimumCount" type:"integer" required:"true"` // contains filtered or unexported fields }
Returns information about the details of an artifact.
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 ArtifactLocationType `locationName:"type" type:"string" enum:"true"` // contains filtered or unexported fields }
Represents information about the location of an artifact.
func (ArtifactLocation) String ¶
func (s ArtifactLocation) String() string
String returns the string representation
type ArtifactLocationType ¶
type ArtifactLocationType string
const (
ArtifactLocationTypeS3 ArtifactLocationType = "S3"
)
Enum values for ArtifactLocationType
func (ArtifactLocationType) MarshalValue ¶ added in v0.3.0
func (enum ArtifactLocationType) MarshalValue() (string, error)
func (ArtifactLocationType) MarshalValueBuf ¶ added in v0.3.0
func (enum ArtifactLocationType) MarshalValueBuf(b []byte) ([]byte, error)
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 `locationName:"created" type:"timestamp"` // 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 `locationName:"name" min:"1" type:"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 `locationName:"revisionChangeIdentifier" min:"1" type:"string"` // The revision ID of the artifact. RevisionId *string `locationName:"revisionId" min:"1" type:"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 `locationName:"revisionSummary" min:"1" type:"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 `locationName:"revisionUrl" min:"1" type:"string"` // contains filtered or unexported fields }
Represents revision details of an artifact.
func (ArtifactRevision) String ¶
func (s ArtifactRevision) 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 Amazon 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 Amazon S3 bucket in the same AWS Region as // the pipeline to store your pipeline artifacts. // // Location is a required field Location *string `locationName:"location" min:"3" type:"string" required:"true"` // The type of the artifact store, such as S3. // // Type is a required field Type ArtifactStoreType `locationName:"type" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
The Amazon 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.
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 ArtifactStoreType ¶
type ArtifactStoreType string
const (
ArtifactStoreTypeS3 ArtifactStoreType = "S3"
)
Enum values for ArtifactStoreType
func (ArtifactStoreType) MarshalValue ¶ added in v0.3.0
func (enum ArtifactStoreType) MarshalValue() (string, error)
func (ArtifactStoreType) MarshalValueBuf ¶ added in v0.3.0
func (enum ArtifactStoreType) MarshalValueBuf(b []byte) ([]byte, error)
type BlockerDeclaration ¶
type BlockerDeclaration struct { // Reserved for future use. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // Reserved for future use. // // Type is a required field Type BlockerType `locationName:"type" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Reserved for future use.
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 BlockerType ¶
type BlockerType string
const (
BlockerTypeSchedule BlockerType = "Schedule"
)
Enum values for BlockerType
func (BlockerType) MarshalValue ¶ added in v0.3.0
func (enum BlockerType) MarshalValue() (string, error)
func (BlockerType) MarshalValueBuf ¶ added in v0.3.0
func (enum BlockerType) MarshalValueBuf(b []byte) ([]byte, error)
type Client ¶ added in v0.9.0
Client provides the API operation methods for making requests to CodePipeline. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := codepipeline.New(myConfig)
func (*Client) AcknowledgeJobRequest ¶ added in v0.9.0
func (c *Client) AcknowledgeJobRequest(input *AcknowledgeJobInput) AcknowledgeJobRequest
AcknowledgeJobRequest returns a request value for making API operation for AWS CodePipeline.
Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
// Example sending a request using AcknowledgeJobRequest. req := client.AcknowledgeJobRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/AcknowledgeJob
func (*Client) AcknowledgeThirdPartyJobRequest ¶ added in v0.9.0
func (c *Client) AcknowledgeThirdPartyJobRequest(input *AcknowledgeThirdPartyJobInput) AcknowledgeThirdPartyJobRequest
AcknowledgeThirdPartyJobRequest returns a request value for making API operation for AWS CodePipeline.
Confirms a job worker has received the specified job. Used for partner actions only.
// Example sending a request using AcknowledgeThirdPartyJobRequest. req := client.AcknowledgeThirdPartyJobRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/AcknowledgeThirdPartyJob
func (*Client) CreateCustomActionTypeRequest ¶ added in v0.9.0
func (c *Client) CreateCustomActionTypeRequest(input *CreateCustomActionTypeInput) CreateCustomActionTypeRequest
CreateCustomActionTypeRequest returns a request value for making API operation for AWS CodePipeline.
Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
// Example sending a request using CreateCustomActionTypeRequest. req := client.CreateCustomActionTypeRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/CreateCustomActionType
func (*Client) CreatePipelineRequest ¶ added in v0.9.0
func (c *Client) CreatePipelineRequest(input *CreatePipelineInput) CreatePipelineRequest
CreatePipelineRequest returns a request value for making API operation for AWS CodePipeline.
Creates a pipeline.
In the pipeline structure, 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.
// Example sending a request using CreatePipelineRequest. req := client.CreatePipelineRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/CreatePipeline
func (*Client) DeleteCustomActionTypeRequest ¶ added in v0.9.0
func (c *Client) DeleteCustomActionTypeRequest(input *DeleteCustomActionTypeInput) DeleteCustomActionTypeRequest
DeleteCustomActionTypeRequest returns a request value for making API operation for AWS CodePipeline.
Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only.
To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
// Example sending a request using DeleteCustomActionTypeRequest. req := client.DeleteCustomActionTypeRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/DeleteCustomActionType
func (*Client) DeletePipelineRequest ¶ added in v0.9.0
func (c *Client) DeletePipelineRequest(input *DeletePipelineInput) DeletePipelineRequest
DeletePipelineRequest returns a request value for making API operation for AWS CodePipeline.
Deletes the specified pipeline.
// Example sending a request using DeletePipelineRequest. req := client.DeletePipelineRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/DeletePipeline
func (*Client) DeleteWebhookRequest ¶ added in v0.9.0
func (c *Client) DeleteWebhookRequest(input *DeleteWebhookInput) DeleteWebhookRequest
DeleteWebhookRequest returns a request value for making API operation for AWS CodePipeline.
Deletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
// Example sending a request using DeleteWebhookRequest. req := client.DeleteWebhookRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/DeleteWebhook
func (*Client) DeregisterWebhookWithThirdPartyRequest ¶ added in v0.9.0
func (c *Client) DeregisterWebhookWithThirdPartyRequest(input *DeregisterWebhookWithThirdPartyInput) DeregisterWebhookWithThirdPartyRequest
DeregisterWebhookWithThirdPartyRequest returns a request value for making API operation for AWS CodePipeline.
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
// Example sending a request using DeregisterWebhookWithThirdPartyRequest. req := client.DeregisterWebhookWithThirdPartyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/DeregisterWebhookWithThirdParty
func (*Client) DisableStageTransitionRequest ¶ added in v0.9.0
func (c *Client) DisableStageTransitionRequest(input *DisableStageTransitionInput) DisableStageTransitionRequest
DisableStageTransitionRequest returns a request value for making API operation for AWS CodePipeline.
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
// Example sending a request using DisableStageTransitionRequest. req := client.DisableStageTransitionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/DisableStageTransition
func (*Client) EnableStageTransitionRequest ¶ added in v0.9.0
func (c *Client) EnableStageTransitionRequest(input *EnableStageTransitionInput) EnableStageTransitionRequest
EnableStageTransitionRequest returns a request value for making API operation for AWS CodePipeline.
Enables artifacts in a pipeline to transition to a stage in a pipeline.
// Example sending a request using EnableStageTransitionRequest. req := client.EnableStageTransitionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/EnableStageTransition
func (*Client) GetJobDetailsRequest ¶ added in v0.9.0
func (c *Client) GetJobDetailsRequest(input *GetJobDetailsInput) GetJobDetailsRequest
GetJobDetailsRequest returns a request value for making API operation for AWS CodePipeline.
Returns information about a job. Used for custom actions only.
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. This API also returns any secret values defined for the action.
// Example sending a request using GetJobDetailsRequest. req := client.GetJobDetailsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/GetJobDetails
func (*Client) GetPipelineExecutionRequest ¶ added in v0.9.0
func (c *Client) GetPipelineExecutionRequest(input *GetPipelineExecutionInput) GetPipelineExecutionRequest
GetPipelineExecutionRequest returns a request value for making API operation for AWS CodePipeline.
Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
// Example sending a request using GetPipelineExecutionRequest. req := client.GetPipelineExecutionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/GetPipelineExecution
func (*Client) GetPipelineRequest ¶ added in v0.9.0
func (c *Client) GetPipelineRequest(input *GetPipelineInput) GetPipelineRequest
GetPipelineRequest returns a request value for making API operation for AWS CodePipeline.
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 sending a request using GetPipelineRequest. req := client.GetPipelineRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/GetPipeline
func (*Client) GetPipelineStateRequest ¶ added in v0.9.0
func (c *Client) GetPipelineStateRequest(input *GetPipelineStateInput) GetPipelineStateRequest
GetPipelineStateRequest returns a request value for making API operation for AWS CodePipeline.
Returns information about the state of a pipeline, including the stages and actions.
Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.
// Example sending a request using GetPipelineStateRequest. req := client.GetPipelineStateRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/GetPipelineState
func (*Client) GetThirdPartyJobDetailsRequest ¶ added in v0.9.0
func (c *Client) GetThirdPartyJobDetailsRequest(input *GetThirdPartyJobDetailsInput) GetThirdPartyJobDetailsRequest
GetThirdPartyJobDetailsRequest returns a request value for making API operation for AWS CodePipeline.
Requests the details of a job for a third party action. Used for partner actions only.
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. This API also returns any secret values defined for the action.
// Example sending a request using GetThirdPartyJobDetailsRequest. req := client.GetThirdPartyJobDetailsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/GetThirdPartyJobDetails
func (*Client) ListActionExecutionsRequest ¶ added in v0.9.0
func (c *Client) ListActionExecutionsRequest(input *ListActionExecutionsInput) ListActionExecutionsRequest
ListActionExecutionsRequest returns a request value for making API operation for AWS CodePipeline.
Lists the action executions that have occurred in a pipeline.
// Example sending a request using ListActionExecutionsRequest. req := client.ListActionExecutionsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ListActionExecutions
func (*Client) ListActionTypesRequest ¶ added in v0.9.0
func (c *Client) ListActionTypesRequest(input *ListActionTypesInput) ListActionTypesRequest
ListActionTypesRequest returns a request value for making API operation for AWS CodePipeline.
Gets a summary of all AWS CodePipeline action types associated with your account.
// Example sending a request using ListActionTypesRequest. req := client.ListActionTypesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ListActionTypes
func (*Client) ListPipelineExecutionsRequest ¶ added in v0.9.0
func (c *Client) ListPipelineExecutionsRequest(input *ListPipelineExecutionsInput) ListPipelineExecutionsRequest
ListPipelineExecutionsRequest returns a request value for making API operation for AWS CodePipeline.
Gets a summary of the most recent executions for a pipeline.
// Example sending a request using ListPipelineExecutionsRequest. req := client.ListPipelineExecutionsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ListPipelineExecutions
func (*Client) ListPipelinesRequest ¶ added in v0.9.0
func (c *Client) ListPipelinesRequest(input *ListPipelinesInput) ListPipelinesRequest
ListPipelinesRequest returns a request value for making API operation for AWS CodePipeline.
Gets a summary of all of the pipelines associated with your account.
// Example sending a request using ListPipelinesRequest. req := client.ListPipelinesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ListPipelines
func (*Client) ListTagsForResourceRequest ¶ added in v0.9.0
func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
ListTagsForResourceRequest returns a request value for making API operation for AWS CodePipeline.
Gets the set of key-value pairs (metadata) that are used to manage the resource.
// Example sending a request using ListTagsForResourceRequest. req := client.ListTagsForResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ListTagsForResource
func (*Client) ListWebhooksRequest ¶ added in v0.9.0
func (c *Client) ListWebhooksRequest(input *ListWebhooksInput) ListWebhooksRequest
ListWebhooksRequest returns a request value for making API operation for AWS CodePipeline.
Gets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
// Example sending a request using ListWebhooksRequest. req := client.ListWebhooksRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ListWebhooks
func (*Client) PollForJobsRequest ¶ added in v0.9.0
func (c *Client) PollForJobsRequest(input *PollForJobsInput) PollForJobsRequest
PollForJobsRequest returns a request value for making API operation for AWS CodePipeline.
Returns information about any jobs for AWS CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains "AWS" or "ThirdParty" in the owner field, the PollForJobs action returns an error.
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. This API also returns any secret values defined for the action.
// Example sending a request using PollForJobsRequest. req := client.PollForJobsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/PollForJobs
func (*Client) PollForThirdPartyJobsRequest ¶ added in v0.9.0
func (c *Client) PollForThirdPartyJobsRequest(input *PollForThirdPartyJobsInput) PollForThirdPartyJobsRequest
PollForThirdPartyJobsRequest returns a request value for making API operation for AWS CodePipeline.
Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.
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 sending a request using PollForThirdPartyJobsRequest. req := client.PollForThirdPartyJobsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/PollForThirdPartyJobs
func (*Client) PutActionRevisionRequest ¶ added in v0.9.0
func (c *Client) PutActionRevisionRequest(input *PutActionRevisionInput) PutActionRevisionRequest
PutActionRevisionRequest returns a request value for making API operation for AWS CodePipeline.
Provides information to AWS CodePipeline about new revisions to a source.
// Example sending a request using PutActionRevisionRequest. req := client.PutActionRevisionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/PutActionRevision
func (*Client) PutApprovalResultRequest ¶ added in v0.9.0
func (c *Client) PutApprovalResultRequest(input *PutApprovalResultInput) PutApprovalResultRequest
PutApprovalResultRequest returns a request value for making API operation for AWS CodePipeline.
Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
// Example sending a request using PutApprovalResultRequest. req := client.PutApprovalResultRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/PutApprovalResult
func (*Client) PutJobFailureResultRequest ¶ added in v0.9.0
func (c *Client) PutJobFailureResultRequest(input *PutJobFailureResultInput) PutJobFailureResultRequest
PutJobFailureResultRequest returns a request value for making API operation for AWS CodePipeline.
Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
// Example sending a request using PutJobFailureResultRequest. req := client.PutJobFailureResultRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/PutJobFailureResult
func (*Client) PutJobSuccessResultRequest ¶ added in v0.9.0
func (c *Client) PutJobSuccessResultRequest(input *PutJobSuccessResultInput) PutJobSuccessResultRequest
PutJobSuccessResultRequest returns a request value for making API operation for AWS CodePipeline.
Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
// Example sending a request using PutJobSuccessResultRequest. req := client.PutJobSuccessResultRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/PutJobSuccessResult
func (*Client) PutThirdPartyJobFailureResultRequest ¶ added in v0.9.0
func (c *Client) PutThirdPartyJobFailureResultRequest(input *PutThirdPartyJobFailureResultInput) PutThirdPartyJobFailureResultRequest
PutThirdPartyJobFailureResultRequest returns a request value for making API operation for AWS CodePipeline.
Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
// Example sending a request using PutThirdPartyJobFailureResultRequest. req := client.PutThirdPartyJobFailureResultRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/PutThirdPartyJobFailureResult
func (*Client) PutThirdPartyJobSuccessResultRequest ¶ added in v0.9.0
func (c *Client) PutThirdPartyJobSuccessResultRequest(input *PutThirdPartyJobSuccessResultInput) PutThirdPartyJobSuccessResultRequest
PutThirdPartyJobSuccessResultRequest returns a request value for making API operation for AWS CodePipeline.
Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
// Example sending a request using PutThirdPartyJobSuccessResultRequest. req := client.PutThirdPartyJobSuccessResultRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/PutThirdPartyJobSuccessResult
func (*Client) PutWebhookRequest ¶ added in v0.9.0
func (c *Client) PutWebhookRequest(input *PutWebhookInput) PutWebhookRequest
PutWebhookRequest returns a request value for making API operation for AWS CodePipeline.
Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
// Example sending a request using PutWebhookRequest. req := client.PutWebhookRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/PutWebhook
func (*Client) RegisterWebhookWithThirdPartyRequest ¶ added in v0.9.0
func (c *Client) RegisterWebhookWithThirdPartyRequest(input *RegisterWebhookWithThirdPartyInput) RegisterWebhookWithThirdPartyRequest
RegisterWebhookWithThirdPartyRequest returns a request value for making API operation for AWS CodePipeline.
Configures a connection between the webhook that was created and the external tool with events to be detected.
// Example sending a request using RegisterWebhookWithThirdPartyRequest. req := client.RegisterWebhookWithThirdPartyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RegisterWebhookWithThirdParty
func (*Client) RetryStageExecutionRequest ¶ added in v0.9.0
func (c *Client) RetryStageExecutionRequest(input *RetryStageExecutionInput) RetryStageExecutionRequest
RetryStageExecutionRequest returns a request value for making API operation for AWS CodePipeline.
Resumes the pipeline execution by retrying the last failed actions in a stage. You can retry a stage immediately if any of the actions in the stage fail. When you retry, all actions that are still in progress continue working, and failed actions are triggered again.
// Example sending a request using RetryStageExecutionRequest. req := client.RetryStageExecutionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RetryStageExecution
func (*Client) StartPipelineExecutionRequest ¶ added in v0.9.0
func (c *Client) StartPipelineExecutionRequest(input *StartPipelineExecutionInput) StartPipelineExecutionRequest
StartPipelineExecutionRequest returns a request value for making API operation for AWS CodePipeline.
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
// Example sending a request using StartPipelineExecutionRequest. req := client.StartPipelineExecutionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/StartPipelineExecution
func (*Client) TagResourceRequest ¶ added in v0.9.0
func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
TagResourceRequest returns a request value for making API operation for AWS CodePipeline.
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
// Example sending a request using TagResourceRequest. req := client.TagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/TagResource
func (*Client) UntagResourceRequest ¶ added in v0.9.0
func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
UntagResourceRequest returns a request value for making API operation for AWS CodePipeline.
Removes tags from an AWS resource.
// Example sending a request using UntagResourceRequest. req := client.UntagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/UntagResource
func (*Client) UpdatePipelineRequest ¶ added in v0.9.0
func (c *Client) UpdatePipelineRequest(input *UpdatePipelineInput) UpdatePipelineRequest
UpdatePipelineRequest returns a request value for making API operation for AWS CodePipeline.
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
// Example sending a request using UpdatePipelineRequest. req := client.UpdatePipelineRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/UpdatePipeline
type CreateCustomActionTypeInput ¶
type CreateCustomActionTypeInput struct { // The category of the custom action, such as a build action or a test action. // // Although Source and Approval are listed as valid values, they are not currently // functional. These values are reserved for future use. // // Category is a required field Category ActionCategory `locationName:"category" type:"string" required:"true" enum:"true"` // 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 (https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html). ConfigurationProperties []ActionConfigurationProperty `locationName:"configurationProperties" type:"list"` // The details of the input artifact for the action, such as its commit ID. // // InputArtifactDetails is a required field InputArtifactDetails *ArtifactDetails `locationName:"inputArtifactDetails" type:"structure" required:"true"` // The details of the output artifact of the action, such as its commit ID. // // OutputArtifactDetails is a required field OutputArtifactDetails *ArtifactDetails `locationName:"outputArtifactDetails" type:"structure" required:"true"` // The provider of the service used in the custom action, such as AWS CodeDeploy. // // Provider is a required field Provider *string `locationName:"provider" min:"1" type:"string" required:"true"` // URLs that provide users information about this custom action. Settings *ActionTypeSettings `locationName:"settings" type:"structure"` // The tags for the custom action. Tags []Tag `locationName:"tags" type:"list"` // The version identifier of the custom action. // // Version is a required field Version *string `locationName:"version" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a CreateCustomActionType operation.
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 is a required field ActionType *ActionType `locationName:"actionType" type:"structure" required:"true"` // Specifies the tags applied to the custom action. Tags []Tag `locationName:"tags" type:"list"` // contains filtered or unexported fields }
Represents the output of a CreateCustomActionType operation.
func (CreateCustomActionTypeOutput) String ¶
func (s CreateCustomActionTypeOutput) String() string
String returns the string representation
type CreateCustomActionTypeRequest ¶
type CreateCustomActionTypeRequest struct { *aws.Request Input *CreateCustomActionTypeInput Copy func(*CreateCustomActionTypeInput) CreateCustomActionTypeRequest }
CreateCustomActionTypeRequest is the request type for the CreateCustomActionType API operation.
func (CreateCustomActionTypeRequest) Send ¶
func (r CreateCustomActionTypeRequest) Send(ctx context.Context) (*CreateCustomActionTypeResponse, error)
Send marshals and sends the CreateCustomActionType API request.
type CreateCustomActionTypeResponse ¶ added in v0.9.0
type CreateCustomActionTypeResponse struct { *CreateCustomActionTypeOutput // contains filtered or unexported fields }
CreateCustomActionTypeResponse is the response type for the CreateCustomActionType API operation.
func (*CreateCustomActionTypeResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateCustomActionTypeResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateCustomActionType request.
type CreatePipelineInput ¶
type CreatePipelineInput struct { // Represents the structure of actions and stages to be performed in the pipeline. // // Pipeline is a required field Pipeline *PipelineDeclaration `locationName:"pipeline" type:"structure" required:"true"` // The tags for the pipeline. Tags []Tag `locationName:"tags" type:"list"` // contains filtered or unexported fields }
Represents the input of a CreatePipeline action.
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"` // Specifies the tags applied to the pipeline. Tags []Tag `locationName:"tags" type:"list"` // contains filtered or unexported fields }
Represents the output of a CreatePipeline action.
func (CreatePipelineOutput) String ¶
func (s CreatePipelineOutput) String() string
String returns the string representation
type CreatePipelineRequest ¶
type CreatePipelineRequest struct { *aws.Request Input *CreatePipelineInput Copy func(*CreatePipelineInput) CreatePipelineRequest }
CreatePipelineRequest is the request type for the CreatePipeline API operation.
func (CreatePipelineRequest) Send ¶
func (r CreatePipelineRequest) Send(ctx context.Context) (*CreatePipelineResponse, error)
Send marshals and sends the CreatePipeline API request.
type CreatePipelineResponse ¶ added in v0.9.0
type CreatePipelineResponse struct { *CreatePipelineOutput // contains filtered or unexported fields }
CreatePipelineResponse is the response type for the CreatePipeline API operation.
func (*CreatePipelineResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreatePipelineResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreatePipeline request.
type CurrentRevision ¶
type CurrentRevision struct { // The change identifier for the current revision. // // ChangeIdentifier is a required field ChangeIdentifier *string `locationName:"changeIdentifier" min:"1" type:"string" required:"true"` // The date and time when the most recent revision of the artifact was created, // in timestamp format. Created *time.Time `locationName:"created" type:"timestamp"` // The revision ID of the current version of an artifact. // // Revision is a required field Revision *string `locationName:"revision" min:"1" type:"string" required:"true"` // The summary of the most recent revision of the artifact. RevisionSummary *string `locationName:"revisionSummary" min:"1" type:"string"` // contains filtered or unexported fields }
Represents information about a current revision.
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 is a required field Category ActionCategory `locationName:"category" type:"string" required:"true" enum:"true"` // The provider of the service used in the custom action, such as AWS CodeDeploy. // // Provider is a required field Provider *string `locationName:"provider" min:"1" type:"string" required:"true"` // The version of the custom action to delete. // // Version is a required field Version *string `locationName:"version" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a DeleteCustomActionType operation. The custom action will be marked as deleted.
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) String ¶
func (s DeleteCustomActionTypeOutput) String() string
String returns the string representation
type DeleteCustomActionTypeRequest ¶
type DeleteCustomActionTypeRequest struct { *aws.Request Input *DeleteCustomActionTypeInput Copy func(*DeleteCustomActionTypeInput) DeleteCustomActionTypeRequest }
DeleteCustomActionTypeRequest is the request type for the DeleteCustomActionType API operation.
func (DeleteCustomActionTypeRequest) Send ¶
func (r DeleteCustomActionTypeRequest) Send(ctx context.Context) (*DeleteCustomActionTypeResponse, error)
Send marshals and sends the DeleteCustomActionType API request.
type DeleteCustomActionTypeResponse ¶ added in v0.9.0
type DeleteCustomActionTypeResponse struct { *DeleteCustomActionTypeOutput // contains filtered or unexported fields }
DeleteCustomActionTypeResponse is the response type for the DeleteCustomActionType API operation.
func (*DeleteCustomActionTypeResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteCustomActionTypeResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteCustomActionType request.
type DeletePipelineInput ¶
type DeletePipelineInput struct { // The name of the pipeline to be deleted. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a DeletePipeline action.
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) String ¶
func (s DeletePipelineOutput) String() string
String returns the string representation
type DeletePipelineRequest ¶
type DeletePipelineRequest struct { *aws.Request Input *DeletePipelineInput Copy func(*DeletePipelineInput) DeletePipelineRequest }
DeletePipelineRequest is the request type for the DeletePipeline API operation.
func (DeletePipelineRequest) Send ¶
func (r DeletePipelineRequest) Send(ctx context.Context) (*DeletePipelineResponse, error)
Send marshals and sends the DeletePipeline API request.
type DeletePipelineResponse ¶ added in v0.9.0
type DeletePipelineResponse struct { *DeletePipelineOutput // contains filtered or unexported fields }
DeletePipelineResponse is the response type for the DeletePipeline API operation.
func (*DeletePipelineResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeletePipelineResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeletePipeline request.
type DeleteWebhookInput ¶ added in v0.4.0
type DeleteWebhookInput struct { // The name of the webhook you want to delete. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteWebhookInput) String ¶ added in v0.4.0
func (s DeleteWebhookInput) String() string
String returns the string representation
func (*DeleteWebhookInput) Validate ¶ added in v0.4.0
func (s *DeleteWebhookInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteWebhookOutput ¶ added in v0.4.0
type DeleteWebhookOutput struct {
// contains filtered or unexported fields
}
func (DeleteWebhookOutput) String ¶ added in v0.4.0
func (s DeleteWebhookOutput) String() string
String returns the string representation
type DeleteWebhookRequest ¶ added in v0.4.0
type DeleteWebhookRequest struct { *aws.Request Input *DeleteWebhookInput Copy func(*DeleteWebhookInput) DeleteWebhookRequest }
DeleteWebhookRequest is the request type for the DeleteWebhook API operation.
func (DeleteWebhookRequest) Send ¶ added in v0.4.0
func (r DeleteWebhookRequest) Send(ctx context.Context) (*DeleteWebhookResponse, error)
Send marshals and sends the DeleteWebhook API request.
type DeleteWebhookResponse ¶ added in v0.9.0
type DeleteWebhookResponse struct { *DeleteWebhookOutput // contains filtered or unexported fields }
DeleteWebhookResponse is the response type for the DeleteWebhook API operation.
func (*DeleteWebhookResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteWebhookResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteWebhook request.
type DeregisterWebhookWithThirdPartyInput ¶ added in v0.4.0
type DeregisterWebhookWithThirdPartyInput struct { // The name of the webhook you want to deregister. WebhookName *string `locationName:"webhookName" min:"1" type:"string"` // contains filtered or unexported fields }
func (DeregisterWebhookWithThirdPartyInput) String ¶ added in v0.4.0
func (s DeregisterWebhookWithThirdPartyInput) String() string
String returns the string representation
func (*DeregisterWebhookWithThirdPartyInput) Validate ¶ added in v0.4.0
func (s *DeregisterWebhookWithThirdPartyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeregisterWebhookWithThirdPartyOutput ¶ added in v0.4.0
type DeregisterWebhookWithThirdPartyOutput struct {
// contains filtered or unexported fields
}
func (DeregisterWebhookWithThirdPartyOutput) String ¶ added in v0.4.0
func (s DeregisterWebhookWithThirdPartyOutput) String() string
String returns the string representation
type DeregisterWebhookWithThirdPartyRequest ¶ added in v0.4.0
type DeregisterWebhookWithThirdPartyRequest struct { *aws.Request Input *DeregisterWebhookWithThirdPartyInput Copy func(*DeregisterWebhookWithThirdPartyInput) DeregisterWebhookWithThirdPartyRequest }
DeregisterWebhookWithThirdPartyRequest is the request type for the DeregisterWebhookWithThirdParty API operation.
func (DeregisterWebhookWithThirdPartyRequest) Send ¶ added in v0.4.0
func (r DeregisterWebhookWithThirdPartyRequest) Send(ctx context.Context) (*DeregisterWebhookWithThirdPartyResponse, error)
Send marshals and sends the DeregisterWebhookWithThirdParty API request.
type DeregisterWebhookWithThirdPartyResponse ¶ added in v0.9.0
type DeregisterWebhookWithThirdPartyResponse struct { *DeregisterWebhookWithThirdPartyOutput // contains filtered or unexported fields }
DeregisterWebhookWithThirdPartyResponse is the response type for the DeregisterWebhookWithThirdParty API operation.
func (*DeregisterWebhookWithThirdPartyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeregisterWebhookWithThirdPartyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeregisterWebhookWithThirdParty request.
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 is a required field PipelineName *string `locationName:"pipelineName" min:"1" type:"string" required:"true"` // The reason given to the user that a stage is disabled, such as waiting for // manual approval or manual tests. This message is displayed in the pipeline // console UI. // // Reason is a required field 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 is a required field StageName *string `locationName:"stageName" min:"1" type:"string" required:"true"` // Specifies whether artifacts are 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 is a required field TransitionType StageTransitionType `locationName:"transitionType" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Represents the input of a DisableStageTransition action.
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) String ¶
func (s DisableStageTransitionOutput) String() string
String returns the string representation
type DisableStageTransitionRequest ¶
type DisableStageTransitionRequest struct { *aws.Request Input *DisableStageTransitionInput Copy func(*DisableStageTransitionInput) DisableStageTransitionRequest }
DisableStageTransitionRequest is the request type for the DisableStageTransition API operation.
func (DisableStageTransitionRequest) Send ¶
func (r DisableStageTransitionRequest) Send(ctx context.Context) (*DisableStageTransitionResponse, error)
Send marshals and sends the DisableStageTransition API request.
type DisableStageTransitionResponse ¶ added in v0.9.0
type DisableStageTransitionResponse struct { *DisableStageTransitionOutput // contains filtered or unexported fields }
DisableStageTransitionResponse is the response type for the DisableStageTransition API operation.
func (*DisableStageTransitionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DisableStageTransitionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DisableStageTransition request.
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 is a required field 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 is a required field StageName *string `locationName:"stageName" min:"1" type:"string" required:"true"` // Specifies whether artifacts are allowed to enter the stage and be processed // by the actions in that stage (inbound) or whether already processed artifacts // are allowed to transition to the next stage (outbound). // // TransitionType is a required field TransitionType StageTransitionType `locationName:"transitionType" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Represents the input of an EnableStageTransition action.
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) String ¶
func (s EnableStageTransitionOutput) String() string
String returns the string representation
type EnableStageTransitionRequest ¶
type EnableStageTransitionRequest struct { *aws.Request Input *EnableStageTransitionInput Copy func(*EnableStageTransitionInput) EnableStageTransitionRequest }
EnableStageTransitionRequest is the request type for the EnableStageTransition API operation.
func (EnableStageTransitionRequest) Send ¶
func (r EnableStageTransitionRequest) Send(ctx context.Context) (*EnableStageTransitionResponse, error)
Send marshals and sends the EnableStageTransition API request.
type EnableStageTransitionResponse ¶ added in v0.9.0
type EnableStageTransitionResponse struct { *EnableStageTransitionOutput // contains filtered or unexported fields }
EnableStageTransitionResponse is the response type for the EnableStageTransition API operation.
func (*EnableStageTransitionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *EnableStageTransitionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the EnableStageTransition request.
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. // // Id is a required field 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 is a required field Type EncryptionKeyType `locationName:"type" type:"string" required:"true" enum:"true"` // 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) 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 EncryptionKeyType ¶
type EncryptionKeyType string
const (
EncryptionKeyTypeKms EncryptionKeyType = "KMS"
)
Enum values for EncryptionKeyType
func (EncryptionKeyType) MarshalValue ¶ added in v0.3.0
func (enum EncryptionKeyType) MarshalValue() (string, error)
func (EncryptionKeyType) MarshalValueBuf ¶ added in v0.3.0
func (enum EncryptionKeyType) MarshalValueBuf(b []byte) ([]byte, error)
type ErrorDetails ¶
type ErrorDetails struct { // The system ID or number code of the error. Code *string `locationName:"code" type:"string"` // The text of the error message. Message *string `locationName:"message" min:"1" type:"string"` // contains filtered or unexported fields }
Represents information about an error in AWS CodePipeline.
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 // 0 to 100 percent. PercentComplete *int64 `locationName:"percentComplete" type:"integer"` // The summary of the current status of the actions. Summary *string `locationName:"summary" min:"1" 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) 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 ExecutionTrigger ¶ added in v0.12.0
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 `locationName:"triggerDetail" type:"string"` // The type of change-detection method, command, or user interaction that started // a pipeline execution. TriggerType TriggerType `locationName:"triggerType" type:"string" enum:"true"` // contains filtered or unexported fields }
The interaction or event that started a pipeline execution.
func (ExecutionTrigger) String ¶ added in v0.12.0
func (s ExecutionTrigger) String() string
String returns the string representation
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 is a required field Message *string `locationName:"message" min:"1" type:"string" required:"true"` // The type of the failure. // // Type is a required field Type FailureType `locationName:"type" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Represents information about failure details.
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 FailureType ¶
type FailureType string
const ( FailureTypeJobFailed FailureType = "JobFailed" FailureTypeConfigurationError FailureType = "ConfigurationError" FailureTypePermissionError FailureType = "PermissionError" FailureTypeRevisionOutOfSync FailureType = "RevisionOutOfSync" )
Enum values for FailureType
func (FailureType) MarshalValue ¶ added in v0.3.0
func (enum FailureType) MarshalValue() (string, error)
func (FailureType) MarshalValueBuf ¶ added in v0.3.0
func (enum FailureType) MarshalValueBuf(b []byte) ([]byte, error)
type GetJobDetailsInput ¶
type GetJobDetailsInput struct { // The unique system-generated ID for the job. // // JobId is a required field JobId *string `locationName:"jobId" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a GetJobDetails action.
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 GetJobDetails action.
func (GetJobDetailsOutput) String ¶
func (s GetJobDetailsOutput) String() string
String returns the string representation
type GetJobDetailsRequest ¶
type GetJobDetailsRequest struct { *aws.Request Input *GetJobDetailsInput Copy func(*GetJobDetailsInput) GetJobDetailsRequest }
GetJobDetailsRequest is the request type for the GetJobDetails API operation.
func (GetJobDetailsRequest) Send ¶
func (r GetJobDetailsRequest) Send(ctx context.Context) (*GetJobDetailsResponse, error)
Send marshals and sends the GetJobDetails API request.
type GetJobDetailsResponse ¶ added in v0.9.0
type GetJobDetailsResponse struct { *GetJobDetailsOutput // contains filtered or unexported fields }
GetJobDetailsResponse is the response type for the GetJobDetails API operation.
func (*GetJobDetailsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetJobDetailsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetJobDetails request.
type GetPipelineExecutionInput ¶
type GetPipelineExecutionInput struct { // The ID of the pipeline execution about which you want to get execution details. // // PipelineExecutionId is a required field PipelineExecutionId *string `locationName:"pipelineExecutionId" type:"string" required:"true"` // The name of the pipeline about which you want to get execution details. // // PipelineName is a required field PipelineName *string `locationName:"pipelineName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a GetPipelineExecution action.
func (GetPipelineExecutionInput) String ¶
func (s GetPipelineExecutionInput) String() string
String returns the string representation
func (*GetPipelineExecutionInput) Validate ¶
func (s *GetPipelineExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetPipelineExecutionOutput ¶
type GetPipelineExecutionOutput struct { // Represents information about the execution of a pipeline. PipelineExecution *PipelineExecution `locationName:"pipelineExecution" type:"structure"` // contains filtered or unexported fields }
Represents the output of a GetPipelineExecution action.
func (GetPipelineExecutionOutput) String ¶
func (s GetPipelineExecutionOutput) String() string
String returns the string representation
type GetPipelineExecutionRequest ¶
type GetPipelineExecutionRequest struct { *aws.Request Input *GetPipelineExecutionInput Copy func(*GetPipelineExecutionInput) GetPipelineExecutionRequest }
GetPipelineExecutionRequest is the request type for the GetPipelineExecution API operation.
func (GetPipelineExecutionRequest) Send ¶
func (r GetPipelineExecutionRequest) Send(ctx context.Context) (*GetPipelineExecutionResponse, error)
Send marshals and sends the GetPipelineExecution API request.
type GetPipelineExecutionResponse ¶ added in v0.9.0
type GetPipelineExecutionResponse struct { *GetPipelineExecutionOutput // contains filtered or unexported fields }
GetPipelineExecutionResponse is the response type for the GetPipelineExecution API operation.
func (*GetPipelineExecutionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetPipelineExecutionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetPipelineExecution request.
type GetPipelineInput ¶
type GetPipelineInput struct { // The name of the pipeline for which you want to get information. Pipeline // names must be unique under an AWS user account. // // Name is a required field 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 current version. Version *int64 `locationName:"version" min:"1" type:"integer"` // contains filtered or unexported fields }
Represents the input of a GetPipeline action.
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 pipeline metadata information returned as part of the output // of a GetPipeline action. Metadata *PipelineMetadata `locationName:"metadata" type:"structure"` // 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 GetPipeline action.
func (GetPipelineOutput) String ¶
func (s GetPipelineOutput) String() string
String returns the string representation
type GetPipelineRequest ¶
type GetPipelineRequest struct { *aws.Request Input *GetPipelineInput Copy func(*GetPipelineInput) GetPipelineRequest }
GetPipelineRequest is the request type for the GetPipeline API operation.
func (GetPipelineRequest) Send ¶
func (r GetPipelineRequest) Send(ctx context.Context) (*GetPipelineResponse, error)
Send marshals and sends the GetPipeline API request.
type GetPipelineResponse ¶ added in v0.9.0
type GetPipelineResponse struct { *GetPipelineOutput // contains filtered or unexported fields }
GetPipelineResponse is the response type for the GetPipeline API operation.
func (*GetPipelineResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetPipelineResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetPipeline request.
type GetPipelineStateInput ¶
type GetPipelineStateInput struct { // The name of the pipeline about which you want to get information. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a GetPipelineState action.
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"` // 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"` // contains filtered or unexported fields }
Represents the output of a GetPipelineState action.
func (GetPipelineStateOutput) String ¶
func (s GetPipelineStateOutput) String() string
String returns the string representation
type GetPipelineStateRequest ¶
type GetPipelineStateRequest struct { *aws.Request Input *GetPipelineStateInput Copy func(*GetPipelineStateInput) GetPipelineStateRequest }
GetPipelineStateRequest is the request type for the GetPipelineState API operation.
func (GetPipelineStateRequest) Send ¶
func (r GetPipelineStateRequest) Send(ctx context.Context) (*GetPipelineStateResponse, error)
Send marshals and sends the GetPipelineState API request.
type GetPipelineStateResponse ¶ added in v0.9.0
type GetPipelineStateResponse struct { *GetPipelineStateOutput // contains filtered or unexported fields }
GetPipelineStateResponse is the response type for the GetPipelineState API operation.
func (*GetPipelineStateResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetPipelineStateResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetPipelineState request.
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 is a required field ClientToken *string `locationName:"clientToken" min:"1" type:"string" required:"true"` // The unique system-generated ID used for identifying the job. // // JobId is a required field JobId *string `locationName:"jobId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a GetThirdPartyJobDetails action.
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 GetThirdPartyJobDetails action.
func (GetThirdPartyJobDetailsOutput) String ¶
func (s GetThirdPartyJobDetailsOutput) String() string
String returns the string representation
type GetThirdPartyJobDetailsRequest ¶
type GetThirdPartyJobDetailsRequest struct { *aws.Request Input *GetThirdPartyJobDetailsInput Copy func(*GetThirdPartyJobDetailsInput) GetThirdPartyJobDetailsRequest }
GetThirdPartyJobDetailsRequest is the request type for the GetThirdPartyJobDetails API operation.
func (GetThirdPartyJobDetailsRequest) Send ¶
func (r GetThirdPartyJobDetailsRequest) Send(ctx context.Context) (*GetThirdPartyJobDetailsResponse, error)
Send marshals and sends the GetThirdPartyJobDetails API request.
type GetThirdPartyJobDetailsResponse ¶ added in v0.9.0
type GetThirdPartyJobDetailsResponse struct { *GetThirdPartyJobDetailsOutput // contains filtered or unexported fields }
GetThirdPartyJobDetailsResponse is the response type for the GetThirdPartyJobDetails API operation.
func (*GetThirdPartyJobDetailsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetThirdPartyJobDetailsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetThirdPartyJobDetails request.
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 is a required field 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) 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"` // Other 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. Use this number in an // AcknowledgeJob request. Nonce *string `locationName:"nonce" min:"1" type:"string"` // contains filtered or unexported fields }
Represents information about a job.
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 artifacts for the pipeline in AWS CodePipeline. ArtifactCredentials *AWSSessionCredentials `locationName:"artifactCredentials" type:"structure" sensitive:"true"` // A system-generated token, such as a AWS CodeDeploy deployment ID, required // by a job to continue the job asynchronously. ContinuationToken *string `locationName:"continuationToken" min:"1" 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. // // Includes pipelineArn and pipelineExecutionId for custom jobs. PipelineContext *PipelineContext `locationName:"pipelineContext" type:"structure"` // contains filtered or unexported fields }
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 `locationName:"accountId" type:"string"` // Represents other 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) String ¶
func (s JobDetails) String() string
String returns the string representation
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) MarshalValue ¶ added in v0.3.0
type ListActionExecutionsInput ¶ added in v0.8.0
type ListActionExecutionsInput struct { // Input information used to filter action execution history. Filter *ActionExecutionFilter `locationName:"filter" type:"structure"` // The maximum number of results to return in a single call. To retrieve the // remaining results, make another call with the returned nextToken value. Action // execution history is retained for up to 12 months, based on action execution // start times. Default value is 100. // // Detailed execution history is available for executions run on or after February // 21, 2019. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` // The token that was returned from the previous ListActionExecutions call, // which can be used to return the next set of action executions in the list. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // The name of the pipeline for which you want to list action execution history. // // PipelineName is a required field PipelineName *string `locationName:"pipelineName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListActionExecutionsInput) String ¶ added in v0.8.0
func (s ListActionExecutionsInput) String() string
String returns the string representation
func (*ListActionExecutionsInput) Validate ¶ added in v0.8.0
func (s *ListActionExecutionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListActionExecutionsOutput ¶ added in v0.8.0
type ListActionExecutionsOutput struct { // The details for a list of recent executions, such as action execution ID. ActionExecutionDetails []ActionExecutionDetail `locationName:"actionExecutionDetails" type:"list"` // If the amount of returned information is significantly large, an identifier // is also returned and can be used in a subsequent ListActionExecutions call // to return the next set of action executions in the list. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (ListActionExecutionsOutput) String ¶ added in v0.8.0
func (s ListActionExecutionsOutput) String() string
String returns the string representation
type ListActionExecutionsPaginator ¶ added in v0.9.0
ListActionExecutionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListActionExecutionsPaginator ¶ added in v0.9.0
func NewListActionExecutionsPaginator(req ListActionExecutionsRequest) ListActionExecutionsPaginator
NewListActionExecutionsRequestPaginator returns a paginator for ListActionExecutions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListActionExecutionsRequest(input) p := codepipeline.NewListActionExecutionsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListActionExecutionsPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListActionExecutionsPaginator) CurrentPage() *ListActionExecutionsOutput
type ListActionExecutionsRequest ¶ added in v0.8.0
type ListActionExecutionsRequest struct { *aws.Request Input *ListActionExecutionsInput Copy func(*ListActionExecutionsInput) ListActionExecutionsRequest }
ListActionExecutionsRequest is the request type for the ListActionExecutions API operation.
func (ListActionExecutionsRequest) Send ¶ added in v0.8.0
func (r ListActionExecutionsRequest) Send(ctx context.Context) (*ListActionExecutionsResponse, error)
Send marshals and sends the ListActionExecutions API request.
type ListActionExecutionsResponse ¶ added in v0.9.0
type ListActionExecutionsResponse struct { *ListActionExecutionsOutput // contains filtered or unexported fields }
ListActionExecutionsResponse is the response type for the ListActionExecutions API operation.
func (*ListActionExecutionsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListActionExecutionsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListActionExecutions request.
type ListActionTypesInput ¶
type ListActionTypesInput struct { // Filters the list of action types to those created by a specified entity. ActionOwnerFilter ActionOwner `locationName:"actionOwnerFilter" type:"string" enum:"true"` // 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" min:"1" type:"string"` // contains filtered or unexported fields }
Represents the input of a ListActionTypes action.
func (ListActionTypesInput) String ¶
func (s ListActionTypesInput) String() string
String returns the string representation
func (*ListActionTypesInput) Validate ¶
func (s *ListActionTypesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListActionTypesOutput ¶
type ListActionTypesOutput struct { // Provides details of the action types. // // ActionTypes is a required field ActionTypes []ActionType `locationName:"actionTypes" type:"list" required:"true"` // If the amount of returned information is significantly large, an identifier // is also returned. It 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" min:"1" type:"string"` // contains filtered or unexported fields }
Represents the output of a ListActionTypes action.
func (ListActionTypesOutput) String ¶
func (s ListActionTypesOutput) String() string
String returns the string representation
type ListActionTypesPaginator ¶ added in v0.9.0
ListActionTypesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListActionTypesPaginator ¶ added in v0.9.0
func NewListActionTypesPaginator(req ListActionTypesRequest) ListActionTypesPaginator
NewListActionTypesRequestPaginator returns a paginator for ListActionTypes. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListActionTypesRequest(input) p := codepipeline.NewListActionTypesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListActionTypesPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListActionTypesPaginator) CurrentPage() *ListActionTypesOutput
type ListActionTypesRequest ¶
type ListActionTypesRequest struct { *aws.Request Input *ListActionTypesInput Copy func(*ListActionTypesInput) ListActionTypesRequest }
ListActionTypesRequest is the request type for the ListActionTypes API operation.
func (ListActionTypesRequest) Send ¶
func (r ListActionTypesRequest) Send(ctx context.Context) (*ListActionTypesResponse, error)
Send marshals and sends the ListActionTypes API request.
type ListActionTypesResponse ¶ added in v0.9.0
type ListActionTypesResponse struct { *ListActionTypesOutput // contains filtered or unexported fields }
ListActionTypesResponse is the response type for the ListActionTypes API operation.
func (*ListActionTypesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListActionTypesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListActionTypes request.
type ListPipelineExecutionsInput ¶
type ListPipelineExecutionsInput struct { // The maximum number of results to return in a single call. To retrieve the // remaining results, make another call with the returned nextToken value. Pipeline // history is limited to the most recent 12 months, based on pipeline execution // start times. Default value is 100. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` // The token that was returned from the previous ListPipelineExecutions call, // which can be used to return the next set of pipeline executions in the list. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // The name of the pipeline for which you want to get execution summary information. // // PipelineName is a required field PipelineName *string `locationName:"pipelineName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a ListPipelineExecutions action.
func (ListPipelineExecutionsInput) String ¶
func (s ListPipelineExecutionsInput) String() string
String returns the string representation
func (*ListPipelineExecutionsInput) Validate ¶
func (s *ListPipelineExecutionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListPipelineExecutionsOutput ¶
type ListPipelineExecutionsOutput struct { // A token that can be used in the next ListPipelineExecutions call. To view // all items in the list, continue to call this operation with each subsequent // token until no more nextToken values are returned. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // A list of executions in the history of a pipeline. PipelineExecutionSummaries []PipelineExecutionSummary `locationName:"pipelineExecutionSummaries" type:"list"` // contains filtered or unexported fields }
Represents the output of a ListPipelineExecutions action.
func (ListPipelineExecutionsOutput) String ¶
func (s ListPipelineExecutionsOutput) String() string
String returns the string representation
type ListPipelineExecutionsPaginator ¶ added in v0.9.0
ListPipelineExecutionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListPipelineExecutionsPaginator ¶ added in v0.9.0
func NewListPipelineExecutionsPaginator(req ListPipelineExecutionsRequest) ListPipelineExecutionsPaginator
NewListPipelineExecutionsRequestPaginator returns a paginator for ListPipelineExecutions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListPipelineExecutionsRequest(input) p := codepipeline.NewListPipelineExecutionsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListPipelineExecutionsPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListPipelineExecutionsPaginator) CurrentPage() *ListPipelineExecutionsOutput
type ListPipelineExecutionsRequest ¶
type ListPipelineExecutionsRequest struct { *aws.Request Input *ListPipelineExecutionsInput Copy func(*ListPipelineExecutionsInput) ListPipelineExecutionsRequest }
ListPipelineExecutionsRequest is the request type for the ListPipelineExecutions API operation.
func (ListPipelineExecutionsRequest) Send ¶
func (r ListPipelineExecutionsRequest) Send(ctx context.Context) (*ListPipelineExecutionsResponse, error)
Send marshals and sends the ListPipelineExecutions API request.
type ListPipelineExecutionsResponse ¶ added in v0.9.0
type ListPipelineExecutionsResponse struct { *ListPipelineExecutionsOutput // contains filtered or unexported fields }
ListPipelineExecutionsResponse is the response type for the ListPipelineExecutions API operation.
func (*ListPipelineExecutionsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListPipelineExecutionsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListPipelineExecutions request.
type ListPipelinesInput ¶
type ListPipelinesInput struct { // An identifier that was returned from the previous list pipelines call. It // can be used to return the next set of pipelines in the list. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
Represents the input of a ListPipelines action.
func (ListPipelinesInput) String ¶
func (s ListPipelinesInput) String() string
String returns the string representation
func (*ListPipelinesInput) Validate ¶
func (s *ListPipelinesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListPipelinesOutput ¶
type ListPipelinesOutput struct { // If the amount of returned information is significantly large, an identifier // is also returned. It can be used in a subsequent list pipelines call to return // the next set of pipelines in the list. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // The list of pipelines. Pipelines []PipelineSummary `locationName:"pipelines" type:"list"` // contains filtered or unexported fields }
Represents the output of a ListPipelines action.
func (ListPipelinesOutput) String ¶
func (s ListPipelinesOutput) String() string
String returns the string representation
type ListPipelinesPaginator ¶ added in v0.9.0
ListPipelinesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListPipelinesPaginator ¶ added in v0.9.0
func NewListPipelinesPaginator(req ListPipelinesRequest) ListPipelinesPaginator
NewListPipelinesRequestPaginator returns a paginator for ListPipelines. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListPipelinesRequest(input) p := codepipeline.NewListPipelinesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListPipelinesPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListPipelinesPaginator) CurrentPage() *ListPipelinesOutput
type ListPipelinesRequest ¶
type ListPipelinesRequest struct { *aws.Request Input *ListPipelinesInput Copy func(*ListPipelinesInput) ListPipelinesRequest }
ListPipelinesRequest is the request type for the ListPipelines API operation.
func (ListPipelinesRequest) Send ¶
func (r ListPipelinesRequest) Send(ctx context.Context) (*ListPipelinesResponse, error)
Send marshals and sends the ListPipelines API request.
type ListPipelinesResponse ¶ added in v0.9.0
type ListPipelinesResponse struct { *ListPipelinesOutput // contains filtered or unexported fields }
ListPipelinesResponse is the response type for the ListPipelines API operation.
func (*ListPipelinesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListPipelinesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListPipelines request.
type ListTagsForResourceInput ¶ added in v0.9.0
type ListTagsForResourceInput struct { // The maximum number of results to return in a single call. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` // The token that was returned from the previous API call, which would be used // to return the next page of the list. The ListTagsforResource call lists all // available tags in one call and does not use pagination. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // The Amazon Resource Name (ARN) of the resource to get tags for. // // ResourceArn is a required field ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceInput) String ¶ added in v0.9.0
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (*ListTagsForResourceInput) Validate ¶ added in v0.9.0
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶ added in v0.9.0
type ListTagsForResourceOutput struct { // If the amount of returned information is significantly large, an identifier // is also returned and can be used in a subsequent API call to return the next // page of the list. The ListTagsforResource call lists all available tags in // one call and does not use pagination. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // The tags for the resource. Tags []Tag `locationName:"tags" type:"list"` // contains filtered or unexported fields }
func (ListTagsForResourceOutput) String ¶ added in v0.9.0
func (s ListTagsForResourceOutput) String() string
String returns the string representation
type ListTagsForResourcePaginator ¶ added in v0.9.0
ListTagsForResourcePaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListTagsForResourcePaginator ¶ added in v0.9.0
func NewListTagsForResourcePaginator(req ListTagsForResourceRequest) ListTagsForResourcePaginator
NewListTagsForResourceRequestPaginator returns a paginator for ListTagsForResource. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListTagsForResourceRequest(input) p := codepipeline.NewListTagsForResourceRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListTagsForResourcePaginator) CurrentPage ¶ added in v0.9.0
func (p *ListTagsForResourcePaginator) CurrentPage() *ListTagsForResourceOutput
type ListTagsForResourceRequest ¶ added in v0.9.0
type ListTagsForResourceRequest struct { *aws.Request Input *ListTagsForResourceInput Copy func(*ListTagsForResourceInput) ListTagsForResourceRequest }
ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.
func (ListTagsForResourceRequest) Send ¶ added in v0.9.0
func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)
Send marshals and sends the ListTagsForResource API request.
type ListTagsForResourceResponse ¶ added in v0.9.0
type ListTagsForResourceResponse struct { *ListTagsForResourceOutput // contains filtered or unexported fields }
ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.
func (*ListTagsForResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListTagsForResource request.
type ListWebhookItem ¶ added in v0.4.0
type ListWebhookItem struct { // The Amazon Resource Name (ARN) of the webhook. Arn *string `locationName:"arn" type:"string"` // The detail returned for each webhook, such as the webhook authentication // type and filter rules. // // Definition is a required field Definition *WebhookDefinition `locationName:"definition" type:"structure" required:"true"` // The number code of the error. ErrorCode *string `locationName:"errorCode" type:"string"` // The text of the error message about the webhook. ErrorMessage *string `locationName:"errorMessage" type:"string"` // The date and time a webhook was last successfully triggered, in timestamp // format. LastTriggered *time.Time `locationName:"lastTriggered" type:"timestamp"` // Specifies the tags applied to the webhook. Tags []Tag `locationName:"tags" type:"list"` // 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. // // Url is a required field Url *string `locationName:"url" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.
func (ListWebhookItem) String ¶ added in v0.4.0
func (s ListWebhookItem) String() string
String returns the string representation
type ListWebhooksInput ¶ added in v0.4.0
type ListWebhooksInput struct { // The maximum number of results to return in a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int64 `min:"1" type:"integer"` // The token that was returned from the previous ListWebhooks call, which can // be used to return the next set of webhooks in the list. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (ListWebhooksInput) String ¶ added in v0.4.0
func (s ListWebhooksInput) String() string
String returns the string representation
func (*ListWebhooksInput) Validate ¶ added in v0.4.0
func (s *ListWebhooksInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListWebhooksOutput ¶ added in v0.4.0
type ListWebhooksOutput struct { // If the amount of returned information is significantly large, an identifier // is also returned and can be used in a subsequent ListWebhooks call to return // the next set of webhooks in the list. NextToken *string `min:"1" type:"string"` // The JSON detail returned for each webhook in the list output for the ListWebhooks // call. Webhooks []ListWebhookItem `locationName:"webhooks" type:"list"` // contains filtered or unexported fields }
func (ListWebhooksOutput) String ¶ added in v0.4.0
func (s ListWebhooksOutput) String() string
String returns the string representation
type ListWebhooksPaginator ¶ added in v0.9.0
ListWebhooksPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListWebhooksPaginator ¶ added in v0.9.0
func NewListWebhooksPaginator(req ListWebhooksRequest) ListWebhooksPaginator
NewListWebhooksRequestPaginator returns a paginator for ListWebhooks. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListWebhooksRequest(input) p := codepipeline.NewListWebhooksRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListWebhooksPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListWebhooksPaginator) CurrentPage() *ListWebhooksOutput
type ListWebhooksRequest ¶ added in v0.4.0
type ListWebhooksRequest struct { *aws.Request Input *ListWebhooksInput Copy func(*ListWebhooksInput) ListWebhooksRequest }
ListWebhooksRequest is the request type for the ListWebhooks API operation.
func (ListWebhooksRequest) Send ¶ added in v0.4.0
func (r ListWebhooksRequest) Send(ctx context.Context) (*ListWebhooksResponse, error)
Send marshals and sends the ListWebhooks API request.
type ListWebhooksResponse ¶ added in v0.9.0
type ListWebhooksResponse struct { *ListWebhooksOutput // contains filtered or unexported fields }
ListWebhooksResponse is the response type for the ListWebhooks API operation.
func (*ListWebhooksResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListWebhooksResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListWebhooks request.
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 is a required field 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) 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 { // The context of an action to a job worker in the stage of a pipeline. Action *ActionContext `locationName:"action" type:"structure"` // The Amazon Resource Name (ARN) of the pipeline. PipelineArn *string `locationName:"pipelineArn" type:"string"` // The execution ID of the pipeline. PipelineExecutionId *string `locationName:"pipelineExecutionId" type:"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 `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.
PipelineContext contains pipelineArn and pipelineExecutionId for custom action jobs. The pipelineArn and pipelineExecutionId fields are not populated for ThirdParty action jobs.
func (PipelineContext) String ¶
func (s PipelineContext) String() string
String returns the string representation
type PipelineDeclaration ¶
type PipelineDeclaration struct { // Represents information about the Amazon 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 `locationName:"artifactStore" type:"structure"` // 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 `locationName:"artifactStores" type:"map"` // The name of the action to be performed. // // Name is a required field 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 is a required field RoleArn *string `locationName:"roleArn" type:"string" required:"true"` // The stage in which to perform the action. // // Stages is a required field 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 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) 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 PipelineExecution ¶
type PipelineExecution struct { // A list of ArtifactRevision objects included in a pipeline execution. ArtifactRevisions []ArtifactRevision `locationName:"artifactRevisions" type:"list"` // The ID of the pipeline execution. PipelineExecutionId *string `locationName:"pipelineExecutionId" type:"string"` // The name of the pipeline that was executed. PipelineName *string `locationName:"pipelineName" min:"1" type:"string"` // The version number of the pipeline that was executed. PipelineVersion *int64 `locationName:"pipelineVersion" min:"1" type:"integer"` // The status of the pipeline execution. // // * InProgress: The pipeline execution is currently running. // // * 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. // // * Failed: The pipeline execution was not completed successfully. Status PipelineExecutionStatus `locationName:"status" type:"string" enum:"true"` // contains filtered or unexported fields }
Represents information about an execution of a pipeline.
func (PipelineExecution) String ¶
func (s PipelineExecution) String() string
String returns the string representation
type PipelineExecutionStatus ¶
type PipelineExecutionStatus string
const ( PipelineExecutionStatusInProgress PipelineExecutionStatus = "InProgress" PipelineExecutionStatusSucceeded PipelineExecutionStatus = "Succeeded" PipelineExecutionStatusSuperseded PipelineExecutionStatus = "Superseded" PipelineExecutionStatusFailed PipelineExecutionStatus = "Failed" )
Enum values for PipelineExecutionStatus
func (PipelineExecutionStatus) MarshalValue ¶ added in v0.3.0
func (enum PipelineExecutionStatus) MarshalValue() (string, error)
func (PipelineExecutionStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum PipelineExecutionStatus) MarshalValueBuf(b []byte) ([]byte, error)
type PipelineExecutionSummary ¶
type PipelineExecutionSummary struct { // The date and time of the last change to the pipeline execution, in timestamp // format. LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"` // The ID of the pipeline execution. PipelineExecutionId *string `locationName:"pipelineExecutionId" type:"string"` // A list of the source artifact revisions that initiated a pipeline execution. SourceRevisions []SourceRevision `locationName:"sourceRevisions" type:"list"` // The date and time when the pipeline execution began, in timestamp format. StartTime *time.Time `locationName:"startTime" type:"timestamp"` // The status of the pipeline execution. // // * InProgress: The pipeline execution is currently running. // // * 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. // // * Failed: The pipeline execution was not completed successfully. Status PipelineExecutionStatus `locationName:"status" type:"string" enum:"true"` // The interaction or event that started a pipeline execution, such as automated // change detection or a StartPipelineExecution API call. Trigger *ExecutionTrigger `locationName:"trigger" type:"structure"` // contains filtered or unexported fields }
Summary information about a pipeline execution.
func (PipelineExecutionSummary) String ¶
func (s PipelineExecutionSummary) String() string
String returns the string representation
type PipelineMetadata ¶
type PipelineMetadata struct { // The date and time the pipeline was created, in timestamp format. Created *time.Time `locationName:"created" type:"timestamp"` // The Amazon Resource Name (ARN) of the pipeline. PipelineArn *string `locationName:"pipelineArn" type:"string"` // The date and time the pipeline was last updated, in timestamp format. Updated *time.Time `locationName:"updated" type:"timestamp"` // contains filtered or unexported fields }
Information about a pipeline.
func (PipelineMetadata) String ¶
func (s PipelineMetadata) String() string
String returns the string representation
type PipelineSummary ¶
type PipelineSummary struct { // The date and time the pipeline was created, in timestamp format. Created *time.Time `locationName:"created" type:"timestamp"` // 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"` // 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) String ¶
func (s PipelineSummary) String() string
String returns the string representation
type PollForJobsInput ¶
type PollForJobsInput struct { // Represents information about an action type. // // ActionTypeId is a required field 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 are returned. QueryParam map[string]string `locationName:"queryParam" type:"map"` // contains filtered or unexported fields }
Represents the input of a PollForJobs action.
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 PollForJobs action.
func (PollForJobsOutput) String ¶
func (s PollForJobsOutput) String() string
String returns the string representation
type PollForJobsRequest ¶
type PollForJobsRequest struct { *aws.Request Input *PollForJobsInput Copy func(*PollForJobsInput) PollForJobsRequest }
PollForJobsRequest is the request type for the PollForJobs API operation.
func (PollForJobsRequest) Send ¶
func (r PollForJobsRequest) Send(ctx context.Context) (*PollForJobsResponse, error)
Send marshals and sends the PollForJobs API request.
type PollForJobsResponse ¶ added in v0.9.0
type PollForJobsResponse struct { *PollForJobsOutput // contains filtered or unexported fields }
PollForJobsResponse is the response type for the PollForJobs API operation.
func (*PollForJobsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PollForJobsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PollForJobs request.
type PollForThirdPartyJobsInput ¶
type PollForThirdPartyJobsInput struct { // Represents information about an action type. // // ActionTypeId is a required field 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 PollForThirdPartyJobs action.
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 PollForThirdPartyJobs action.
func (PollForThirdPartyJobsOutput) String ¶
func (s PollForThirdPartyJobsOutput) String() string
String returns the string representation
type PollForThirdPartyJobsRequest ¶
type PollForThirdPartyJobsRequest struct { *aws.Request Input *PollForThirdPartyJobsInput Copy func(*PollForThirdPartyJobsInput) PollForThirdPartyJobsRequest }
PollForThirdPartyJobsRequest is the request type for the PollForThirdPartyJobs API operation.
func (PollForThirdPartyJobsRequest) Send ¶
func (r PollForThirdPartyJobsRequest) Send(ctx context.Context) (*PollForThirdPartyJobsResponse, error)
Send marshals and sends the PollForThirdPartyJobs API request.
type PollForThirdPartyJobsResponse ¶ added in v0.9.0
type PollForThirdPartyJobsResponse struct { *PollForThirdPartyJobsOutput // contains filtered or unexported fields }
PollForThirdPartyJobsResponse is the response type for the PollForThirdPartyJobs API operation.
func (*PollForThirdPartyJobsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PollForThirdPartyJobsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PollForThirdPartyJobs request.
type PutActionRevisionInput ¶
type PutActionRevisionInput struct { // The name of the action that processes the revision. // // ActionName is a required field ActionName *string `locationName:"actionName" min:"1" type:"string" required:"true"` // Represents information about the version (or revision) of an action. // // ActionRevision is a required field ActionRevision *ActionRevision `locationName:"actionRevision" type:"structure" required:"true"` // The name of the pipeline that starts processing the revision to the source. // // PipelineName is a required field PipelineName *string `locationName:"pipelineName" min:"1" type:"string" required:"true"` // The name of the stage that contains the action that acts on the revision. // // StageName is a required field StageName *string `locationName:"stageName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a PutActionRevision action.
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 { // Indicates whether the artifact revision was previously used in an execution // of the specified pipeline. 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 PutActionRevision action.
func (PutActionRevisionOutput) String ¶
func (s PutActionRevisionOutput) String() string
String returns the string representation
type PutActionRevisionRequest ¶
type PutActionRevisionRequest struct { *aws.Request Input *PutActionRevisionInput Copy func(*PutActionRevisionInput) PutActionRevisionRequest }
PutActionRevisionRequest is the request type for the PutActionRevision API operation.
func (PutActionRevisionRequest) Send ¶
func (r PutActionRevisionRequest) Send(ctx context.Context) (*PutActionRevisionResponse, error)
Send marshals and sends the PutActionRevision API request.
type PutActionRevisionResponse ¶ added in v0.9.0
type PutActionRevisionResponse struct { *PutActionRevisionOutput // contains filtered or unexported fields }
PutActionRevisionResponse is the response type for the PutActionRevision API operation.
func (*PutActionRevisionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutActionRevisionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutActionRevision request.
type PutApprovalResultInput ¶
type PutApprovalResultInput struct { // The name of the action for which approval is requested. // // ActionName is a required field ActionName *string `locationName:"actionName" min:"1" type:"string" required:"true"` // The name of the pipeline that contains the action. // // PipelineName is a required field PipelineName *string `locationName:"pipelineName" min:"1" type:"string" required:"true"` // Represents information about the result of the approval request. // // Result is a required field Result *ApprovalResult `locationName:"result" type:"structure" required:"true"` // The name of the stage that contains the action. // // StageName is a required field StageName *string `locationName:"stageName" min:"1" type:"string" required:"true"` // The system-generated token used to identify a unique approval request. The // token for each open approval request can be obtained using the GetPipelineState // action. It is used to validate that the approval request corresponding to // this token is still valid. // // Token is a required field Token *string `locationName:"token" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a PutApprovalResult action.
func (PutApprovalResultInput) String ¶
func (s PutApprovalResultInput) String() string
String returns the string representation
func (*PutApprovalResultInput) Validate ¶
func (s *PutApprovalResultInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutApprovalResultOutput ¶
type PutApprovalResultOutput struct { // The timestamp showing when the approval or rejection was submitted. ApprovedAt *time.Time `locationName:"approvedAt" type:"timestamp"` // contains filtered or unexported fields }
Represents the output of a PutApprovalResult action.
func (PutApprovalResultOutput) String ¶
func (s PutApprovalResultOutput) String() string
String returns the string representation
type PutApprovalResultRequest ¶
type PutApprovalResultRequest struct { *aws.Request Input *PutApprovalResultInput Copy func(*PutApprovalResultInput) PutApprovalResultRequest }
PutApprovalResultRequest is the request type for the PutApprovalResult API operation.
func (PutApprovalResultRequest) Send ¶
func (r PutApprovalResultRequest) Send(ctx context.Context) (*PutApprovalResultResponse, error)
Send marshals and sends the PutApprovalResult API request.
type PutApprovalResultResponse ¶ added in v0.9.0
type PutApprovalResultResponse struct { *PutApprovalResultOutput // contains filtered or unexported fields }
PutApprovalResultResponse is the response type for the PutApprovalResult API operation.
func (*PutApprovalResultResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutApprovalResultResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutApprovalResult request.
type PutJobFailureResultInput ¶
type PutJobFailureResultInput struct { // The details about the failure of a job. // // FailureDetails is a required field 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 is a required field JobId *string `locationName:"jobId" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a PutJobFailureResult action.
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) String ¶
func (s PutJobFailureResultOutput) String() string
String returns the string representation
type PutJobFailureResultRequest ¶
type PutJobFailureResultRequest struct { *aws.Request Input *PutJobFailureResultInput Copy func(*PutJobFailureResultInput) PutJobFailureResultRequest }
PutJobFailureResultRequest is the request type for the PutJobFailureResult API operation.
func (PutJobFailureResultRequest) Send ¶
func (r PutJobFailureResultRequest) Send(ctx context.Context) (*PutJobFailureResultResponse, error)
Send marshals and sends the PutJobFailureResult API request.
type PutJobFailureResultResponse ¶ added in v0.9.0
type PutJobFailureResultResponse struct { *PutJobFailureResultOutput // contains filtered or unexported fields }
PutJobFailureResultResponse is the response type for the PutJobFailureResult API operation.
func (*PutJobFailureResultResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutJobFailureResultResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutJobFailureResult request.
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 use this token to identify the running instance of the action. It can // be reused to return more information about the progress of the custom action. // When the action is complete, no continuation token should be supplied. ContinuationToken *string `locationName:"continuationToken" min:"1" type:"string"` // The ID of the current revision of the artifact successfully worked on 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 is a required field JobId *string `locationName:"jobId" type:"string" required:"true"` // Key-value pairs produced as output by a job worker that can be made available // to a downstream action configuration. outputVariables can be included only // when there is no continuation token on the request. OutputVariables map[string]string `locationName:"outputVariables" type:"map"` // contains filtered or unexported fields }
Represents the input of a PutJobSuccessResult action.
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) String ¶
func (s PutJobSuccessResultOutput) String() string
String returns the string representation
type PutJobSuccessResultRequest ¶
type PutJobSuccessResultRequest struct { *aws.Request Input *PutJobSuccessResultInput Copy func(*PutJobSuccessResultInput) PutJobSuccessResultRequest }
PutJobSuccessResultRequest is the request type for the PutJobSuccessResult API operation.
func (PutJobSuccessResultRequest) Send ¶
func (r PutJobSuccessResultRequest) Send(ctx context.Context) (*PutJobSuccessResultResponse, error)
Send marshals and sends the PutJobSuccessResult API request.
type PutJobSuccessResultResponse ¶ added in v0.9.0
type PutJobSuccessResultResponse struct { *PutJobSuccessResultOutput // contains filtered or unexported fields }
PutJobSuccessResultResponse is the response type for the PutJobSuccessResult API operation.
func (*PutJobSuccessResultResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutJobSuccessResultResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutJobSuccessResult request.
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 is a required field ClientToken *string `locationName:"clientToken" min:"1" type:"string" required:"true"` // Represents information about failure details. // // FailureDetails is a required field FailureDetails *FailureDetails `locationName:"failureDetails" type:"structure" required:"true"` // The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs. // // JobId is a required field JobId *string `locationName:"jobId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a PutThirdPartyJobFailureResult action.
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) String ¶
func (s PutThirdPartyJobFailureResultOutput) String() string
String returns the string representation
type PutThirdPartyJobFailureResultRequest ¶
type PutThirdPartyJobFailureResultRequest struct { *aws.Request Input *PutThirdPartyJobFailureResultInput Copy func(*PutThirdPartyJobFailureResultInput) PutThirdPartyJobFailureResultRequest }
PutThirdPartyJobFailureResultRequest is the request type for the PutThirdPartyJobFailureResult API operation.
func (PutThirdPartyJobFailureResultRequest) Send ¶
func (r PutThirdPartyJobFailureResultRequest) Send(ctx context.Context) (*PutThirdPartyJobFailureResultResponse, error)
Send marshals and sends the PutThirdPartyJobFailureResult API request.
type PutThirdPartyJobFailureResultResponse ¶ added in v0.9.0
type PutThirdPartyJobFailureResultResponse struct { *PutThirdPartyJobFailureResultOutput // contains filtered or unexported fields }
PutThirdPartyJobFailureResultResponse is the response type for the PutThirdPartyJobFailureResult API operation.
func (*PutThirdPartyJobFailureResultResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutThirdPartyJobFailureResultResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutThirdPartyJobFailureResult request.
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 is a required field ClientToken *string `locationName:"clientToken" min:"1" 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 use this token to identify the running instance of the action. // It can be reused to return more information about the progress of the partner // action. When the action is complete, no continuation token should be supplied. ContinuationToken *string `locationName:"continuationToken" min:"1" 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 is a required field JobId *string `locationName:"jobId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a PutThirdPartyJobSuccessResult action.
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) String ¶
func (s PutThirdPartyJobSuccessResultOutput) String() string
String returns the string representation
type PutThirdPartyJobSuccessResultRequest ¶
type PutThirdPartyJobSuccessResultRequest struct { *aws.Request Input *PutThirdPartyJobSuccessResultInput Copy func(*PutThirdPartyJobSuccessResultInput) PutThirdPartyJobSuccessResultRequest }
PutThirdPartyJobSuccessResultRequest is the request type for the PutThirdPartyJobSuccessResult API operation.
func (PutThirdPartyJobSuccessResultRequest) Send ¶
func (r PutThirdPartyJobSuccessResultRequest) Send(ctx context.Context) (*PutThirdPartyJobSuccessResultResponse, error)
Send marshals and sends the PutThirdPartyJobSuccessResult API request.
type PutThirdPartyJobSuccessResultResponse ¶ added in v0.9.0
type PutThirdPartyJobSuccessResultResponse struct { *PutThirdPartyJobSuccessResultOutput // contains filtered or unexported fields }
PutThirdPartyJobSuccessResultResponse is the response type for the PutThirdPartyJobSuccessResult API operation.
func (*PutThirdPartyJobSuccessResultResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutThirdPartyJobSuccessResultResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutThirdPartyJobSuccessResult request.
type PutWebhookInput ¶ added in v0.4.0
type PutWebhookInput struct { // The tags for the webhook. Tags []Tag `locationName:"tags" type:"list"` // The detail provided in an input file to create the webhook, such as the webhook // name, the pipeline name, and the action name. Give the webhook a unique name // that helps you identify it. You might name the webhook after the pipeline // and action it targets so that you can easily recognize what it's used for // later. // // Webhook is a required field Webhook *WebhookDefinition `locationName:"webhook" type:"structure" required:"true"` // contains filtered or unexported fields }
func (PutWebhookInput) String ¶ added in v0.4.0
func (s PutWebhookInput) String() string
String returns the string representation
func (*PutWebhookInput) Validate ¶ added in v0.4.0
func (s *PutWebhookInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutWebhookOutput ¶ added in v0.4.0
type PutWebhookOutput struct { // The detail returned from creating the webhook, such as the webhook name, // webhook URL, and webhook ARN. Webhook *ListWebhookItem `locationName:"webhook" type:"structure"` // contains filtered or unexported fields }
func (PutWebhookOutput) String ¶ added in v0.4.0
func (s PutWebhookOutput) String() string
String returns the string representation
type PutWebhookRequest ¶ added in v0.4.0
type PutWebhookRequest struct { *aws.Request Input *PutWebhookInput Copy func(*PutWebhookInput) PutWebhookRequest }
PutWebhookRequest is the request type for the PutWebhook API operation.
func (PutWebhookRequest) Send ¶ added in v0.4.0
func (r PutWebhookRequest) Send(ctx context.Context) (*PutWebhookResponse, error)
Send marshals and sends the PutWebhook API request.
type PutWebhookResponse ¶ added in v0.9.0
type PutWebhookResponse struct { *PutWebhookOutput // contains filtered or unexported fields }
PutWebhookResponse is the response type for the PutWebhook API operation.
func (*PutWebhookResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutWebhookResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutWebhook request.
type RegisterWebhookWithThirdPartyInput ¶ added in v0.4.0
type RegisterWebhookWithThirdPartyInput struct { // The name of an existing webhook created with PutWebhook to register with // a supported third party. WebhookName *string `locationName:"webhookName" min:"1" type:"string"` // contains filtered or unexported fields }
func (RegisterWebhookWithThirdPartyInput) String ¶ added in v0.4.0
func (s RegisterWebhookWithThirdPartyInput) String() string
String returns the string representation
func (*RegisterWebhookWithThirdPartyInput) Validate ¶ added in v0.4.0
func (s *RegisterWebhookWithThirdPartyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RegisterWebhookWithThirdPartyOutput ¶ added in v0.4.0
type RegisterWebhookWithThirdPartyOutput struct {
// contains filtered or unexported fields
}
func (RegisterWebhookWithThirdPartyOutput) String ¶ added in v0.4.0
func (s RegisterWebhookWithThirdPartyOutput) String() string
String returns the string representation
type RegisterWebhookWithThirdPartyRequest ¶ added in v0.4.0
type RegisterWebhookWithThirdPartyRequest struct { *aws.Request Input *RegisterWebhookWithThirdPartyInput Copy func(*RegisterWebhookWithThirdPartyInput) RegisterWebhookWithThirdPartyRequest }
RegisterWebhookWithThirdPartyRequest is the request type for the RegisterWebhookWithThirdParty API operation.
func (RegisterWebhookWithThirdPartyRequest) Send ¶ added in v0.4.0
func (r RegisterWebhookWithThirdPartyRequest) Send(ctx context.Context) (*RegisterWebhookWithThirdPartyResponse, error)
Send marshals and sends the RegisterWebhookWithThirdParty API request.
type RegisterWebhookWithThirdPartyResponse ¶ added in v0.9.0
type RegisterWebhookWithThirdPartyResponse struct { *RegisterWebhookWithThirdPartyOutput // contains filtered or unexported fields }
RegisterWebhookWithThirdPartyResponse is the response type for the RegisterWebhookWithThirdParty API operation.
func (*RegisterWebhookWithThirdPartyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *RegisterWebhookWithThirdPartyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the RegisterWebhookWithThirdParty request.
type RetryStageExecutionInput ¶
type RetryStageExecutionInput struct { // The ID of the pipeline execution in the failed stage to be retried. Use the // GetPipelineState action to retrieve the current pipelineExecutionId of the // failed stage // // PipelineExecutionId is a required field PipelineExecutionId *string `locationName:"pipelineExecutionId" type:"string" required:"true"` // The name of the pipeline that contains the failed stage. // // PipelineName is a required field PipelineName *string `locationName:"pipelineName" min:"1" type:"string" required:"true"` // The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS. // // RetryMode is a required field RetryMode StageRetryMode `locationName:"retryMode" type:"string" required:"true" enum:"true"` // The name of the failed stage to be retried. // // StageName is a required field StageName *string `locationName:"stageName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a RetryStageExecution action.
func (RetryStageExecutionInput) String ¶
func (s RetryStageExecutionInput) String() string
String returns the string representation
func (*RetryStageExecutionInput) Validate ¶
func (s *RetryStageExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RetryStageExecutionOutput ¶
type RetryStageExecutionOutput struct { // The ID of the current workflow execution in the failed stage. PipelineExecutionId *string `locationName:"pipelineExecutionId" type:"string"` // contains filtered or unexported fields }
Represents the output of a RetryStageExecution action.
func (RetryStageExecutionOutput) String ¶
func (s RetryStageExecutionOutput) String() string
String returns the string representation
type RetryStageExecutionRequest ¶
type RetryStageExecutionRequest struct { *aws.Request Input *RetryStageExecutionInput Copy func(*RetryStageExecutionInput) RetryStageExecutionRequest }
RetryStageExecutionRequest is the request type for the RetryStageExecution API operation.
func (RetryStageExecutionRequest) Send ¶
func (r RetryStageExecutionRequest) Send(ctx context.Context) (*RetryStageExecutionResponse, error)
Send marshals and sends the RetryStageExecution API request.
type RetryStageExecutionResponse ¶ added in v0.9.0
type RetryStageExecutionResponse struct { *RetryStageExecutionOutput // contains filtered or unexported fields }
RetryStageExecutionResponse is the response type for the RetryStageExecution API operation.
func (*RetryStageExecutionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *RetryStageExecutionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the RetryStageExecution request.
type S3ArtifactLocation ¶
type S3ArtifactLocation struct { // The name of the Amazon S3 bucket. // // BucketName is a required field 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 is a required field 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) String ¶
func (s S3ArtifactLocation) String() string
String returns the string representation
type S3Location ¶ added in v0.8.0
type S3Location struct { // The Amazon S3 artifact bucket for an action's artifacts. Bucket *string `locationName:"bucket" min:"3" type:"string"` // The artifact name. Key *string `locationName:"key" min:"1" type:"string"` // contains filtered or unexported fields }
The Amazon S3 artifact location for an action's artifacts.
func (S3Location) String ¶ added in v0.8.0
func (s S3Location) String() string
String returns the string representation
type SourceRevision ¶ added in v0.4.0
type SourceRevision struct { // The name of the action that processed the revision to the source artifact. // // ActionName is a required field ActionName *string `locationName:"actionName" min:"1" type:"string" required:"true"` // The system-generated unique ID that identifies the revision number of the // artifact. RevisionId *string `locationName:"revisionId" min:"1" type:"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 `locationName:"revisionSummary" min:"1" type:"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 `locationName:"revisionUrl" min:"1" type:"string"` // contains filtered or unexported fields }
Information about the version (or revision) of a source artifact that initiated a pipeline execution.
func (SourceRevision) String ¶ added in v0.4.0
func (s SourceRevision) 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) String ¶
func (s StageContext) String() string
String returns the string representation
type StageDeclaration ¶
type StageDeclaration struct { // The actions included in a stage. // // Actions is a required field Actions []ActionDeclaration `locationName:"actions" type:"list" required:"true"` // Reserved for future use. Blockers []BlockerDeclaration `locationName:"blockers" type:"list"` // The name of the stage. // // Name is a required field 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) 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 StageExecution ¶
type StageExecution struct { // The ID of the pipeline execution associated with the stage. // // PipelineExecutionId is a required field PipelineExecutionId *string `locationName:"pipelineExecutionId" type:"string" required:"true"` // The status of the stage, or for a completed stage, the last status of the // stage. // // Status is a required field Status StageExecutionStatus `locationName:"status" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Represents information about the run of a stage.
func (StageExecution) String ¶
func (s StageExecution) String() string
String returns the string representation
type StageExecutionStatus ¶
type StageExecutionStatus string
const ( StageExecutionStatusInProgress StageExecutionStatus = "InProgress" StageExecutionStatusFailed StageExecutionStatus = "Failed" StageExecutionStatusSucceeded StageExecutionStatus = "Succeeded" )
Enum values for StageExecutionStatus
func (StageExecutionStatus) MarshalValue ¶ added in v0.3.0
func (enum StageExecutionStatus) MarshalValue() (string, error)
func (StageExecutionStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum StageExecutionStatus) MarshalValueBuf(b []byte) ([]byte, error)
type StageRetryMode ¶
type StageRetryMode string
const (
StageRetryModeFailedActions StageRetryMode = "FAILED_ACTIONS"
)
Enum values for StageRetryMode
func (StageRetryMode) MarshalValue ¶ added in v0.3.0
func (enum StageRetryMode) MarshalValue() (string, error)
func (StageRetryMode) MarshalValueBuf ¶ added in v0.3.0
func (enum StageRetryMode) MarshalValueBuf(b []byte) ([]byte, error)
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"` // Information about the latest execution in the stage, including its ID and // status. LatestExecution *StageExecution `locationName:"latestExecution" 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) String ¶
func (s StageState) String() string
String returns the string representation
type StageTransitionType ¶
type StageTransitionType string
const ( StageTransitionTypeInbound StageTransitionType = "Inbound" StageTransitionTypeOutbound StageTransitionType = "Outbound" )
Enum values for StageTransitionType
func (StageTransitionType) MarshalValue ¶ added in v0.3.0
func (enum StageTransitionType) MarshalValue() (string, error)
func (StageTransitionType) MarshalValueBuf ¶ added in v0.3.0
func (enum StageTransitionType) MarshalValueBuf(b []byte) ([]byte, error)
type StartPipelineExecutionInput ¶
type StartPipelineExecutionInput struct { // The system-generated unique ID used to identify a unique execution request. ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string" idempotencyToken:"true"` // The name of the pipeline to start. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a StartPipelineExecution action.
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 execution that was started. PipelineExecutionId *string `locationName:"pipelineExecutionId" type:"string"` // contains filtered or unexported fields }
Represents the output of a StartPipelineExecution action.
func (StartPipelineExecutionOutput) String ¶
func (s StartPipelineExecutionOutput) String() string
String returns the string representation
type StartPipelineExecutionRequest ¶
type StartPipelineExecutionRequest struct { *aws.Request Input *StartPipelineExecutionInput Copy func(*StartPipelineExecutionInput) StartPipelineExecutionRequest }
StartPipelineExecutionRequest is the request type for the StartPipelineExecution API operation.
func (StartPipelineExecutionRequest) Send ¶
func (r StartPipelineExecutionRequest) Send(ctx context.Context) (*StartPipelineExecutionResponse, error)
Send marshals and sends the StartPipelineExecution API request.
type StartPipelineExecutionResponse ¶ added in v0.9.0
type StartPipelineExecutionResponse struct { *StartPipelineExecutionOutput // contains filtered or unexported fields }
StartPipelineExecutionResponse is the response type for the StartPipelineExecution API operation.
func (*StartPipelineExecutionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *StartPipelineExecutionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the StartPipelineExecution request.
type Tag ¶ added in v0.9.0
type Tag struct { // The tag's key. // // Key is a required field Key *string `locationName:"key" min:"1" type:"string" required:"true"` // The tag's value. // // Value is a required field Value *string `locationName:"value" type:"string" required:"true"` // contains filtered or unexported fields }
A tag is a key-value pair that is used to manage the resource.
type TagResourceInput ¶ added in v0.9.0
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource you want to add tags to. // // ResourceArn is a required field ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"` // The tags you want to modify or add to the resource. // // Tags is a required field Tags []Tag `locationName:"tags" type:"list" required:"true"` // contains filtered or unexported fields }
func (TagResourceInput) String ¶ added in v0.9.0
func (s TagResourceInput) String() string
String returns the string representation
func (*TagResourceInput) Validate ¶ added in v0.9.0
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶ added in v0.9.0
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (TagResourceOutput) String ¶ added in v0.9.0
func (s TagResourceOutput) String() string
String returns the string representation
type TagResourceRequest ¶ added in v0.9.0
type TagResourceRequest struct { *aws.Request Input *TagResourceInput Copy func(*TagResourceInput) TagResourceRequest }
TagResourceRequest is the request type for the TagResource API operation.
func (TagResourceRequest) Send ¶ added in v0.9.0
func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)
Send marshals and sends the TagResource API request.
type TagResourceResponse ¶ added in v0.9.0
type TagResourceResponse struct { *TagResourceOutput // contains filtered or unexported fields }
TagResourceResponse is the response type for the TagResource API operation.
func (*TagResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the TagResource request.
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 on by a partner action.
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" sensitive:"true"` // A system-generated token, such as a AWS CodeDeploy deployment ID, that a // job requires to continue the job asynchronously. ContinuationToken *string `locationName:"continuationToken" min:"1" 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 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 `locationName:"inputArtifacts" type:"list"` // 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 `locationName:"outputArtifacts" type:"list"` // Represents information about a pipeline to a job worker. // // Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs. PipelineContext *PipelineContext `locationName:"pipelineContext" type:"structure"` // contains filtered or unexported fields }
Represents information about the job data for a partner action.
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. Use this number in an // AcknowledgeThirdPartyJob request. Nonce *string `locationName:"nonce" min:"1" type:"string"` // contains filtered or unexported fields }
The details of a job sent in response to a GetThirdPartyJobDetails request.
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"` // 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) String ¶
func (s TransitionState) String() string
String returns the string representation
type TriggerType ¶ added in v0.12.0
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) MarshalValue ¶ added in v0.12.0
func (enum TriggerType) MarshalValue() (string, error)
func (TriggerType) MarshalValueBuf ¶ added in v0.12.0
func (enum TriggerType) MarshalValueBuf(b []byte) ([]byte, error)
type UntagResourceInput ¶ added in v0.9.0
type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource to remove tags from. // // ResourceArn is a required field ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"` // The list of keys for the tags to be removed from the resource. // // TagKeys is a required field TagKeys []string `locationName:"tagKeys" type:"list" required:"true"` // contains filtered or unexported fields }
func (UntagResourceInput) String ¶ added in v0.9.0
func (s UntagResourceInput) String() string
String returns the string representation
func (*UntagResourceInput) Validate ¶ added in v0.9.0
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶ added in v0.9.0
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (UntagResourceOutput) String ¶ added in v0.9.0
func (s UntagResourceOutput) String() string
String returns the string representation
type UntagResourceRequest ¶ added in v0.9.0
type UntagResourceRequest struct { *aws.Request Input *UntagResourceInput Copy func(*UntagResourceInput) UntagResourceRequest }
UntagResourceRequest is the request type for the UntagResource API operation.
func (UntagResourceRequest) Send ¶ added in v0.9.0
func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)
Send marshals and sends the UntagResource API request.
type UntagResourceResponse ¶ added in v0.9.0
type UntagResourceResponse struct { *UntagResourceOutput // contains filtered or unexported fields }
UntagResourceResponse is the response type for the UntagResource API operation.
func (*UntagResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UntagResource request.
type UpdatePipelineInput ¶
type UpdatePipelineInput struct { // The name of the pipeline to be updated. // // Pipeline is a required field Pipeline *PipelineDeclaration `locationName:"pipeline" type:"structure" required:"true"` // contains filtered or unexported fields }
Represents the input of an UpdatePipeline action.
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 UpdatePipeline action.
func (UpdatePipelineOutput) String ¶
func (s UpdatePipelineOutput) String() string
String returns the string representation
type UpdatePipelineRequest ¶
type UpdatePipelineRequest struct { *aws.Request Input *UpdatePipelineInput Copy func(*UpdatePipelineInput) UpdatePipelineRequest }
UpdatePipelineRequest is the request type for the UpdatePipeline API operation.
func (UpdatePipelineRequest) Send ¶
func (r UpdatePipelineRequest) Send(ctx context.Context) (*UpdatePipelineResponse, error)
Send marshals and sends the UpdatePipeline API request.
type UpdatePipelineResponse ¶ added in v0.9.0
type UpdatePipelineResponse struct { *UpdatePipelineOutput // contains filtered or unexported fields }
UpdatePipelineResponse is the response type for the UpdatePipeline API operation.
func (*UpdatePipelineResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdatePipelineResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdatePipeline request.
type WebhookAuthConfiguration ¶ added in v0.4.0
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 `min:"1" type:"string"` // The property used to configure GitHub authentication. For GITHUB_HMAC, only // the SecretToken property must be set. SecretToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
The authentication applied to incoming webhook trigger requests.
func (WebhookAuthConfiguration) String ¶ added in v0.4.0
func (s WebhookAuthConfiguration) String() string
String returns the string representation
func (*WebhookAuthConfiguration) Validate ¶ added in v0.4.0
func (s *WebhookAuthConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type WebhookAuthenticationType ¶ added in v0.4.0
type WebhookAuthenticationType string
const ( WebhookAuthenticationTypeGithubHmac WebhookAuthenticationType = "GITHUB_HMAC" WebhookAuthenticationTypeIp WebhookAuthenticationType = "IP" WebhookAuthenticationTypeUnauthenticated WebhookAuthenticationType = "UNAUTHENTICATED" )
Enum values for WebhookAuthenticationType
func (WebhookAuthenticationType) MarshalValue ¶ added in v0.4.0
func (enum WebhookAuthenticationType) MarshalValue() (string, error)
func (WebhookAuthenticationType) MarshalValueBuf ¶ added in v0.4.0
func (enum WebhookAuthenticationType) MarshalValueBuf(b []byte) ([]byte, error)
type WebhookDefinition ¶ added in v0.4.0
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. // // Authentication is a required field Authentication WebhookAuthenticationType `locationName:"authentication" type:"string" required:"true" enum:"true"` // 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. // // AuthenticationConfiguration is a required field AuthenticationConfiguration *WebhookAuthConfiguration `locationName:"authenticationConfiguration" type:"structure" required:"true"` // 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. // // Filters is a required field Filters []WebhookFilterRule `locationName:"filters" type:"list" required:"true"` // The name of the webhook. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // 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. // // TargetAction is a required field TargetAction *string `locationName:"targetAction" min:"1" type:"string" required:"true"` // The name of the pipeline you want to connect to the webhook. // // TargetPipeline is a required field TargetPipeline *string `locationName:"targetPipeline" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents information about a webhook and its definition.
func (WebhookDefinition) String ¶ added in v0.4.0
func (s WebhookDefinition) String() string
String returns the string representation
func (*WebhookDefinition) Validate ¶ added in v0.4.0
func (s *WebhookDefinition) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type WebhookFilterRule ¶ added in v0.4.0
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. // // JsonPath is a required field JsonPath *string `locationName:"jsonPath" min:"1" type:"string" required:"true"` // 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 `locationName:"matchEquals" min:"1" type:"string"` // contains filtered or unexported fields }
The event criteria that specify when a webhook notification is sent to your URL.
func (WebhookFilterRule) String ¶ added in v0.4.0
func (s WebhookFilterRule) String() string
String returns the string representation
func (*WebhookFilterRule) Validate ¶ added in v0.4.0
func (s *WebhookFilterRule) Validate() error
Validate inspects the fields of the type to determine if they are valid.
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_AcknowledgeJob.go
- api_op_AcknowledgeThirdPartyJob.go
- api_op_CreateCustomActionType.go
- api_op_CreatePipeline.go
- api_op_DeleteCustomActionType.go
- api_op_DeletePipeline.go
- api_op_DeleteWebhook.go
- api_op_DeregisterWebhookWithThirdParty.go
- api_op_DisableStageTransition.go
- api_op_EnableStageTransition.go
- api_op_GetJobDetails.go
- api_op_GetPipeline.go
- api_op_GetPipelineExecution.go
- api_op_GetPipelineState.go
- api_op_GetThirdPartyJobDetails.go
- api_op_ListActionExecutions.go
- api_op_ListActionTypes.go
- api_op_ListPipelineExecutions.go
- api_op_ListPipelines.go
- api_op_ListTagsForResource.go
- api_op_ListWebhooks.go
- api_op_PollForJobs.go
- api_op_PollForThirdPartyJobs.go
- api_op_PutActionRevision.go
- api_op_PutApprovalResult.go
- api_op_PutJobFailureResult.go
- api_op_PutJobSuccessResult.go
- api_op_PutThirdPartyJobFailureResult.go
- api_op_PutThirdPartyJobSuccessResult.go
- api_op_PutWebhook.go
- api_op_RegisterWebhookWithThirdParty.go
- api_op_RetryStageExecution.go
- api_op_StartPipelineExecution.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdatePipeline.go
- api_types.go
Directories ¶
Path | Synopsis |
---|---|
Package codepipelineiface provides an interface to enable mocking the AWS CodePipeline service client for testing your code.
|
Package codepipelineiface provides an interface to enable mocking the AWS CodePipeline service client for testing your code. |