AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AcknowledgeJobRequest

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

Class AcknowledgeJobResponse

Represents the output of an AcknowledgeJob action.

Class AcknowledgeThirdPartyJobRequest

Container for the parameters to the AcknowledgeThirdPartyJob operation. Confirms a job worker has received the specified job. Only used for partner actions.

Class AcknowledgeThirdPartyJobResponse

Represents the output of an AcknowledgeThirdPartyJob action.

Class ActionConfiguration

Represents information about an action configuration.

Class ActionConfigurationProperty

Represents information about an action configuration property.

Class ActionContext

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

Class ActionDeclaration

Represents information about an action declaration.

Class ActionExecution

Represents information about the run of an action.

Class ActionNotFoundException

CodePipeline exception

Class ActionRevision

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

Class ActionState

Represents information about the state of an action.

Class ActionType

Returns information about the details of an action type.

Class ActionTypeId

Represents information about an action type.

Class ActionTypeNotFoundException

CodePipeline exception

Class ActionTypeSettings

Returns information about the settings for an action type.

Class ApprovalAlreadyCompletedException

CodePipeline exception

Class ApprovalResult

Represents information about the result of an approval request.

Class Artifact

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

Class ArtifactDetails

Returns information about the details of an artifact.

Class ArtifactLocation

Represents information about the location of an artifact.

Class ArtifactRevision

Represents revision details of an artifact.

Class ArtifactStore

The Amazon S3 bucket where artifacts are stored for the pipeline.

Class AWSSessionCredentials

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.

Class BlockerDeclaration

Reserved for future use.

Class CreateCustomActionTypeRequest

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

Class CreateCustomActionTypeResponse

Represents the output of a CreateCustomActionType operation.

Class CreatePipelineRequest

Container for the parameters to the CreatePipeline operation. Creates a pipeline.

Class CreatePipelineResponse

Represents the output of a CreatePipeline action.

Class CurrentRevision

Represents information about a current revision.

Class DeleteCustomActionTypeRequest

Container for the parameters to the DeleteCustomActionType operation. Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.

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

Class DeleteCustomActionTypeResponse

This is the response object from the DeleteCustomActionType operation.

Class DeletePipelineRequest

Container for the parameters to the DeletePipeline operation. Deletes the specified pipeline.

Class DeletePipelineResponse

This is the response object from the DeletePipeline operation.

Class DisableStageTransitionRequest

Container for the parameters to the DisableStageTransition operation. Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.

Class DisableStageTransitionResponse

This is the response object from the DisableStageTransition operation.

Class EnableStageTransitionRequest

Container for the parameters to the EnableStageTransition operation. Enables artifacts in a pipeline to transition to a stage in a pipeline.

Class EnableStageTransitionResponse

This is the response object from the EnableStageTransition operation.

Class EncryptionKey

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

Class ErrorDetails

Represents information about an error in AWS CodePipeline.

Class ExecutionDetails

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

Class FailureDetails

Represents information about failure details.

Class GetJobDetailsRequest

Container for the parameters to the GetJobDetails operation. Returns information about a job. Only used for custom actions.

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

Class GetJobDetailsResponse

Represents the output of a GetJobDetails action.

Class GetPipelineExecutionRequest

Container for the parameters to the GetPipelineExecution operation. 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.

Class GetPipelineExecutionResponse

Represents the output of a GetPipelineExecution action.

Class GetPipelineRequest

Container for the parameters to the GetPipeline operation. 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.

Class GetPipelineResponse

Represents the output of a GetPipeline action.

Class GetPipelineStateRequest

Container for the parameters to the GetPipelineState operation. Returns information about the state of a pipeline, including the stages and actions.

Class GetPipelineStateResponse

Represents the output of a GetPipelineState action.

Class GetThirdPartyJobDetailsRequest

Container for the parameters to the GetThirdPartyJobDetails operation. Requests the details of a job for a third party action. Only used for partner actions.

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

Class GetThirdPartyJobDetailsResponse

Represents the output of a GetThirdPartyJobDetails action.

Class InputArtifact

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

Class InvalidActionDeclarationException

CodePipeline exception

Class InvalidApprovalTokenException

CodePipeline exception

Class InvalidBlockerDeclarationException

CodePipeline exception

Class InvalidClientTokenException

CodePipeline exception

Class InvalidJobException

CodePipeline exception

Class InvalidJobStateException

CodePipeline exception

Class InvalidNextTokenException

CodePipeline exception

Class InvalidNonceException

CodePipeline exception

Class InvalidStageDeclarationException

CodePipeline exception

Class InvalidStructureException

CodePipeline exception

Class Job

Represents information about a job.

Class JobData

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

Class JobDetails

Represents information about the details of a job.

Class JobNotFoundException

CodePipeline exception

Class LimitExceededException

CodePipeline exception

Class ListActionTypesRequest

Container for the parameters to the ListActionTypes operation. Gets a summary of all AWS CodePipeline action types associated with your account.

Class ListActionTypesResponse

Represents the output of a ListActionTypes action.

Class ListPipelineExecutionsRequest

Container for the parameters to the ListPipelineExecutions operation. Gets a summary of the most recent executions for a pipeline.

Class ListPipelineExecutionsResponse

Represents the output of a ListPipelineExecutions action.

Class ListPipelinesRequest

Container for the parameters to the ListPipelines operation. Gets a summary of all of the pipelines associated with your account.

Class ListPipelinesResponse

Represents the output of a ListPipelines action.

Class NotLatestPipelineExecutionException

CodePipeline exception

Class OutputArtifact

Represents information about the output of an action.

Class PipelineContext

Represents information about a pipeline to a job worker.

Class PipelineDeclaration

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

Class PipelineExecution

Represents information about an execution of a pipeline.

Class PipelineExecutionNotFoundException

CodePipeline exception

Class PipelineExecutionSummary

Summary information about a pipeline execution.

Class PipelineMetadata

Information about a pipeline.

Class PipelineNameInUseException

CodePipeline exception

Class PipelineNotFoundException

CodePipeline exception

Class PipelineSummary

Returns a summary of a pipeline.

Class PipelineVersionNotFoundException

CodePipeline exception

Class PollForJobsRequest

Container for the parameters to the PollForJobs operation. Returns information about any jobs for AWS CodePipeline to act upon.

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

Class PollForJobsResponse

Represents the output of a PollForJobs action.

Class PollForThirdPartyJobsRequest

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

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

Class PollForThirdPartyJobsResponse

Represents the output of a PollForThirdPartyJobs action.

Class PutActionRevisionRequest

Container for the parameters to the PutActionRevision operation. Provides information to AWS CodePipeline about new revisions to a source.

Class PutActionRevisionResponse

Represents the output of a PutActionRevision action.

Class PutApprovalResultRequest

Container for the parameters to the PutApprovalResult operation. Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.

Class PutApprovalResultResponse

Represents the output of a PutApprovalResult action.

Class PutJobFailureResultRequest

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

Class PutJobFailureResultResponse

This is the response object from the PutJobFailureResult operation.

Class PutJobSuccessResultRequest

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

Class PutJobSuccessResultResponse

This is the response object from the PutJobSuccessResult operation.

Class PutThirdPartyJobFailureResultRequest

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

Class PutThirdPartyJobFailureResultResponse

This is the response object from the PutThirdPartyJobFailureResult operation.

Class PutThirdPartyJobSuccessResultRequest

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

Class PutThirdPartyJobSuccessResultResponse

This is the response object from the PutThirdPartyJobSuccessResult operation.

Class RetryStageExecutionRequest

Container for the parameters to the RetryStageExecution operation. Resumes the pipeline execution by retrying the last failed actions in a stage.

Class RetryStageExecutionResponse

Represents the output of a RetryStageExecution action.

Class S3ArtifactLocation

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

Class StageContext

Represents information about a stage to a job worker.

Class StageDeclaration

Represents information about a stage and its definition.

Class StageExecution

Represents information about the run of a stage.

Class StageNotFoundException

CodePipeline exception

Class StageNotRetryableException

CodePipeline exception

Class StageState

Represents information about the state of the stage.

Class StartPipelineExecutionRequest

Container for the parameters to the StartPipelineExecution operation. Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

Class StartPipelineExecutionResponse

Represents the output of a StartPipelineExecution action.

Class ThirdPartyJob

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

Class ThirdPartyJobData

Represents information about the job data for a partner action.

Class ThirdPartyJobDetails

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

Class TransitionState

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

Class UpdatePipelineRequest

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

Class UpdatePipelineResponse

Represents the output of an UpdatePipeline action.

Class ValidationException

CodePipeline exception