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. Used for custom actions only.

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. Used for partner actions only.

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 in 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 ActionExecutionDetail

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

Class ActionExecutionFilter

Filter values for the action execution.

Class ActionExecutionInput

Input information used for an action execution.

Class ActionExecutionOutput

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

Class ActionExecutionResult

Execution result information, such as the external execution ID.

Class ActionNotFoundException

The specified action cannot be found.

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 ActionTypeArtifactDetails

Information about parameters for artifacts associated with the action type, such as the minimum and maximum artifacts allowed.

Class ActionTypeDeclaration

The parameters for the action type definition that are provided when the action type is created or updated.

Class ActionTypeExecutor

The action engine, or executor, for an action type created for a provider, where the action is to be used by customers of the provider. The action engine is associated with the model used to create and update the action, such as the Lambda integration model.

Class ActionTypeId

Represents information about an action type.

Class ActionTypeIdentifier

Specifies the category, owner, provider, and version of the action type.

Class ActionTypeNotFoundException

The specified action type cannot be found.

Class ActionTypePermissions

Details identifying the users with permissions to use the action type.

Class ActionTypeProperty

Represents information about each property specified in the action configuration, such as the description and key name that display for the customer using the action type.

Class ActionTypeSettings

Returns information about the settings for an action type.

Class ActionTypeUrls

Returns information about URLs for web pages that display to customers as links on the pipeline view, such as an external configuration page for the action type.

Class ApprovalAlreadyCompletedException

The approval action has already been approved or rejected.

Class ApprovalResult

Represents information about the result of an approval request.

Class Artifact

Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip

Class ArtifactDetail

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

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

Class AWSSessionCredentials

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

Class BlockerDeclaration

Reserved for future use.

Class CodePipelinePaginatorFactory

Paginators for the CodePipeline service

Class ConcurrentModificationException

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

Class ConcurrentPipelineExecutionsLimitExceededException

The pipeline has reached the limit for concurrent pipeline executions.

Class ConflictException

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

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 Amazon Web Services 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.

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.

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

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 DeleteWebhookRequest

Container for the parameters to the DeleteWebhook operation. Deletes a previously created webhook by name. Deleting the webhook stops 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.

Class DeleteWebhookResponse

This is the response object from the DeleteWebhook operation.

Class DeregisterWebhookWithThirdPartyRequest

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

Class DeregisterWebhookWithThirdPartyResponse

This is the response object from the DeregisterWebhookWithThirdParty 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 DuplicatedStopRequestException

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

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 Amazon Web Services Key Management Service (Key Management Service) key.

Class ErrorDetails

Represents information about an error in CodePipeline.

Class ExecutionDetails

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

Class ExecutionTrigger

The interaction or event that started a pipeline execution.

Class ExecutorConfiguration

The action engine, or executor, related to the supported integration model used to create and update the action type. The available executor types are Lambda and JobWorker.

Class FailureDetails

Represents information about failure details.

Class GetActionTypeRequest

Container for the parameters to the GetActionType operation. Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.

Class GetActionTypeResponse

This is the response object from the GetActionType operation.

Class GetJobDetailsRequest

Container for the parameters to the GetJobDetails operation. Returns information about a job. Used for custom actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also 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.

Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.

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. Used for partner actions only.

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

Class GetThirdPartyJobDetailsResponse

Represents the output of a GetThirdPartyJobDetails action.

Class GitBranchFilterCriteria

The Git repository branches specified as filter criteria to start the pipeline.

Class GitConfiguration

A type of trigger configuration for Git-based source actions.

You can specify the Git configuration trigger type for all third-party Git-based source actions that are supported by the CodeStarSourceConnection action type.

Class GitFilePathFilterCriteria

The Git repository file paths specified as filter criteria to start the pipeline.

Class GitPullRequestFilter

The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.

Class GitPushFilter

The event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude.

Class GitTagFilterCriteria

The Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline.

Class InputArtifact

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

Class InvalidActionDeclarationException

The action declaration was specified in an invalid format.

Class InvalidApprovalTokenException

The approval request already received a response or has expired.

Class InvalidArnException

The specified resource ARN is invalid.

Class InvalidBlockerDeclarationException

Reserved for future use.

Class InvalidClientTokenException

The client token was specified in an invalid format

Class InvalidJobException

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

Class InvalidJobStateException

The job state was specified in an invalid format.

Class 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.

Class InvalidNonceException

The nonce was specified in an invalid format.

Class InvalidStageDeclarationException

The stage declaration was specified in an invalid format.

Class InvalidStructureException

The structure was specified in an invalid format.

Class InvalidTagsException

The specified resource tags are invalid.

Class InvalidWebhookAuthenticationParametersException

The specified authentication type is in an invalid format.

Class InvalidWebhookFilterPatternException

The specified event filter rule is in an invalid format.

Class Job

Represents information about a job.

Class JobData

Represents other 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

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

Class JobWorkerExecutorConfiguration

Details about the polling configuration for the JobWorker action engine, or executor.

Class LambdaExecutorConfiguration

Details about the configuration for the Lambda action engine, or executor.

Class LatestInPipelineExecutionFilter

The field that specifies to filter on the latest execution in the pipeline.

Filtering on the latest execution is available for executions run on or after February 08, 2024.

Class LimitExceededException

The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.

Class ListActionExecutionsRequest

Container for the parameters to the ListActionExecutions operation. Lists the action executions that have occurred in a pipeline.

Class ListActionExecutionsResponse

This is the response object from the ListActionExecutions operation.

Class ListActionTypesRequest

Container for the parameters to the ListActionTypes operation. Gets a summary of all 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 ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Gets the set of key-value pairs (metadata) that are used to manage the resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class ListWebhookItem

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

Class ListWebhooksRequest

Container for the parameters to the ListWebhooks operation. Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.

Class ListWebhooksResponse

This is the response object from the ListWebhooks operation.

Class NotLatestPipelineExecutionException

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

Class OutputArtifact

Represents information about the output of an action.

Class OutputVariablesSizeExceededException

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

Class PipelineContext

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.

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

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

Class PipelineExecutionNotStoppableException

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

Class PipelineExecutionSummary

Summary information about a pipeline execution.

Class PipelineMetadata

Information about a pipeline.

Class PipelineNameInUseException

The specified pipeline name is already in use.

Class PipelineNotFoundException

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

Class PipelineSummary

Returns a summary of a pipeline.

Class PipelineTriggerDeclaration

Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.

This is only supported for the CodeStarSourceConnection action type.

When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

Class PipelineVariable

A pipeline-level variable used for a pipeline execution.

Class PipelineVariableDeclaration

A variable declared at the pipeline level.

Class PipelineVersionNotFoundException

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

Class PollForJobsRequest

Container for the parameters to the PollForJobs operation. Returns information about any jobs for 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, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also 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. Used for partner actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that 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 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 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. Used for custom actions only.

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. Used for custom actions only.

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. Used for partner actions only.

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. Used for partner actions only.

Class PutThirdPartyJobSuccessResultResponse

This is the response object from the PutThirdPartyJobSuccessResult operation.

Class PutWebhookRequest

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

Class PutWebhookResponse

This is the response object from the PutWebhook operation.

Class RegisterWebhookWithThirdPartyRequest

Container for the parameters to the RegisterWebhookWithThirdParty operation. Configures a connection between the webhook that was created and the external tool with events to be detected.

Class RegisterWebhookWithThirdPartyResponse

This is the response object from the RegisterWebhookWithThirdParty operation.

Class RequestFailedException

The request failed because of an unknown error, exception, or failure.

Class ResolvedPipelineVariable

A pipeline-level variable used for a pipeline execution.

Class ResourceNotFoundException

The resource was specified in an invalid format.

Class RetryStageExecutionRequest

Container for the parameters to the RetryStageExecution operation. You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.

Class RetryStageExecutionResponse

Represents the output of a RetryStageExecution action.

Class S3ArtifactLocation

The location of the S3 bucket that contains a revision.

Class S3Location

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

Class SourceRevision

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

Class SourceRevisionOverride

A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.

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

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

Class StageNotRetryableException

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

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 StopExecutionTrigger

The interaction that stopped a pipeline execution.

Class StopPipelineExecutionRequest

Container for the parameters to the StopPipelineExecution operation. Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.

Class StopPipelineExecutionResponse

This is the response object from the StopPipelineExecution operation.

Class Tag

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

Class TagResourceRequest

Container for the parameters to the TagResource operation. Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class ThirdPartyJob

A response to a PollForThirdPartyJobs request returned by CodePipeline when there is a job to be worked on 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 TooManyTagsException

The tags limit for a resource has been exceeded.

Class TransitionState

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

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes tags from an Amazon Web Services resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateActionTypeRequest

Container for the parameters to the UpdateActionType operation. Updates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider. Use a JSON file with the action definition and UpdateActionType to provide the full structure.

Class UpdateActionTypeResponse

This is the response object from the UpdateActionType operation.

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

The validation was specified in an invalid format.

Class WebhookAuthConfiguration

The authentication applied to incoming webhook trigger requests.

Class WebhookDefinition

Represents information about a webhook and its definition.

Class WebhookFilterRule

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

Class WebhookNotFoundException

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

Interfaces

NameDescription
Interface ICodePipelinePaginatorFactory

Paginators for the CodePipeline service

Interface IListActionExecutionsPaginator

Paginator for the ListActionExecutions operation

Interface IListActionTypesPaginator

Paginator for the ListActionTypes operation

Interface IListPipelineExecutionsPaginator

Paginator for the ListPipelineExecutions operation

Interface IListPipelinesPaginator

Paginator for the ListPipelines operation

Interface IListTagsForResourcePaginator

Paginator for the ListTagsForResource operation

Interface IListWebhooksPaginator

Paginator for the ListWebhooks operation