import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CodePipelineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodePipelineClient"; import type { GetPipelineStateInput, GetPipelineStateOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetPipelineStateCommand}. */ export interface GetPipelineStateCommandInput extends GetPipelineStateInput { } /** * @public * * The output of {@link GetPipelineStateCommand}. */ export interface GetPipelineStateCommandOutput extends GetPipelineStateOutput, __MetadataBearer { } declare const GetPipelineStateCommand_base: { new (input: GetPipelineStateCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: GetPipelineStateCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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 * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CodePipelineClient, GetPipelineStateCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import * // const { CodePipelineClient, GetPipelineStateCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import * // import type { CodePipelineClientConfig } from "@aws-sdk/client-codepipeline"; * const config = {}; // type is CodePipelineClientConfig * const client = new CodePipelineClient(config); * const input = { // GetPipelineStateInput * name: "STRING_VALUE", // required * }; * const command = new GetPipelineStateCommand(input); * const response = await client.send(command); * // { // GetPipelineStateOutput * // pipelineName: "STRING_VALUE", * // pipelineVersion: Number("int"), * // stageStates: [ // StageStateList * // { // StageState * // stageName: "STRING_VALUE", * // inboundExecution: { // StageExecution * // pipelineExecutionId: "STRING_VALUE", // required * // status: "Cancelled" || "InProgress" || "Failed" || "Stopped" || "Stopping" || "Succeeded" || "Skipped", // required * // type: "STANDARD" || "ROLLBACK", * // }, * // inboundExecutions: [ // StageExecutionList * // { * // pipelineExecutionId: "STRING_VALUE", // required * // status: "Cancelled" || "InProgress" || "Failed" || "Stopped" || "Stopping" || "Succeeded" || "Skipped", // required * // type: "STANDARD" || "ROLLBACK", * // }, * // ], * // inboundTransitionState: { // TransitionState * // enabled: true || false, * // lastChangedBy: "STRING_VALUE", * // lastChangedAt: new Date("TIMESTAMP"), * // disabledReason: "STRING_VALUE", * // }, * // actionStates: [ // ActionStateList * // { // ActionState * // actionName: "STRING_VALUE", * // currentRevision: { // ActionRevision * // revisionId: "STRING_VALUE", // required * // revisionChangeId: "STRING_VALUE", // required * // created: new Date("TIMESTAMP"), // required * // }, * // latestExecution: { // ActionExecution * // actionExecutionId: "STRING_VALUE", * // status: "InProgress" || "Abandoned" || "Succeeded" || "Failed", * // summary: "STRING_VALUE", * // lastStatusChange: new Date("TIMESTAMP"), * // token: "STRING_VALUE", * // lastUpdatedBy: "STRING_VALUE", * // externalExecutionId: "STRING_VALUE", * // externalExecutionUrl: "STRING_VALUE", * // percentComplete: Number("int"), * // errorDetails: { // ErrorDetails * // code: "STRING_VALUE", * // message: "STRING_VALUE", * // }, * // logStreamARN: "STRING_VALUE", * // }, * // entityUrl: "STRING_VALUE", * // revisionUrl: "STRING_VALUE", * // }, * // ], * // latestExecution: { * // pipelineExecutionId: "STRING_VALUE", // required * // status: "Cancelled" || "InProgress" || "Failed" || "Stopped" || "Stopping" || "Succeeded" || "Skipped", // required * // type: "STANDARD" || "ROLLBACK", * // }, * // beforeEntryConditionState: { // StageConditionState * // latestExecution: { // StageConditionsExecution * // status: "InProgress" || "Failed" || "Errored" || "Succeeded" || "Cancelled" || "Abandoned" || "Overridden", * // summary: "STRING_VALUE", * // }, * // conditionStates: [ // ConditionStateList * // { // ConditionState * // latestExecution: { // ConditionExecution * // status: "InProgress" || "Failed" || "Errored" || "Succeeded" || "Cancelled" || "Abandoned" || "Overridden", * // summary: "STRING_VALUE", * // lastStatusChange: new Date("TIMESTAMP"), * // }, * // ruleStates: [ // RuleStateList * // { // RuleState * // ruleName: "STRING_VALUE", * // currentRevision: { // RuleRevision * // revisionId: "STRING_VALUE", // required * // revisionChangeId: "STRING_VALUE", // required * // created: new Date("TIMESTAMP"), // required * // }, * // latestExecution: { // RuleExecution * // ruleExecutionId: "STRING_VALUE", * // status: "InProgress" || "Abandoned" || "Succeeded" || "Failed", * // summary: "STRING_VALUE", * // lastStatusChange: new Date("TIMESTAMP"), * // token: "STRING_VALUE", * // lastUpdatedBy: "STRING_VALUE", * // externalExecutionId: "STRING_VALUE", * // externalExecutionUrl: "STRING_VALUE", * // errorDetails: { * // code: "STRING_VALUE", * // message: "STRING_VALUE", * // }, * // }, * // entityUrl: "STRING_VALUE", * // revisionUrl: "STRING_VALUE", * // }, * // ], * // }, * // ], * // }, * // onSuccessConditionState: { * // latestExecution: { * // status: "InProgress" || "Failed" || "Errored" || "Succeeded" || "Cancelled" || "Abandoned" || "Overridden", * // summary: "STRING_VALUE", * // }, * // conditionStates: [ * // { * // latestExecution: { * // status: "InProgress" || "Failed" || "Errored" || "Succeeded" || "Cancelled" || "Abandoned" || "Overridden", * // summary: "STRING_VALUE", * // lastStatusChange: new Date("TIMESTAMP"), * // }, * // ruleStates: [ * // { * // ruleName: "STRING_VALUE", * // currentRevision: { * // revisionId: "STRING_VALUE", // required * // revisionChangeId: "STRING_VALUE", // required * // created: new Date("TIMESTAMP"), // required * // }, * // latestExecution: { * // ruleExecutionId: "STRING_VALUE", * // status: "InProgress" || "Abandoned" || "Succeeded" || "Failed", * // summary: "STRING_VALUE", * // lastStatusChange: new Date("TIMESTAMP"), * // token: "STRING_VALUE", * // lastUpdatedBy: "STRING_VALUE", * // externalExecutionId: "STRING_VALUE", * // externalExecutionUrl: "STRING_VALUE", * // errorDetails: { * // code: "STRING_VALUE", * // message: "STRING_VALUE", * // }, * // }, * // entityUrl: "STRING_VALUE", * // revisionUrl: "STRING_VALUE", * // }, * // ], * // }, * // ], * // }, * // onFailureConditionState: { * // latestExecution: { * // status: "InProgress" || "Failed" || "Errored" || "Succeeded" || "Cancelled" || "Abandoned" || "Overridden", * // summary: "STRING_VALUE", * // }, * // conditionStates: [ * // { * // latestExecution: { * // status: "InProgress" || "Failed" || "Errored" || "Succeeded" || "Cancelled" || "Abandoned" || "Overridden", * // summary: "STRING_VALUE", * // lastStatusChange: new Date("TIMESTAMP"), * // }, * // ruleStates: [ * // { * // ruleName: "STRING_VALUE", * // currentRevision: { * // revisionId: "STRING_VALUE", // required * // revisionChangeId: "STRING_VALUE", // required * // created: new Date("TIMESTAMP"), // required * // }, * // latestExecution: { * // ruleExecutionId: "STRING_VALUE", * // status: "InProgress" || "Abandoned" || "Succeeded" || "Failed", * // summary: "STRING_VALUE", * // lastStatusChange: new Date("TIMESTAMP"), * // token: "STRING_VALUE", * // lastUpdatedBy: "STRING_VALUE", * // externalExecutionId: "STRING_VALUE", * // externalExecutionUrl: "STRING_VALUE", * // errorDetails: { * // code: "STRING_VALUE", * // message: "STRING_VALUE", * // }, * // }, * // entityUrl: "STRING_VALUE", * // revisionUrl: "STRING_VALUE", * // }, * // ], * // }, * // ], * // }, * // retryStageMetadata: { // RetryStageMetadata * // autoStageRetryAttempt: Number("int"), * // manualStageRetryAttempt: Number("int"), * // latestRetryTrigger: "AutomatedStageRetry" || "ManualStageRetry", * // }, * // }, * // ], * // created: new Date("TIMESTAMP"), * // updated: new Date("TIMESTAMP"), * // }; * * ``` * * @param GetPipelineStateCommandInput - {@link GetPipelineStateCommandInput} * @returns {@link GetPipelineStateCommandOutput} * @see {@link GetPipelineStateCommandInput} for command's `input` shape. * @see {@link GetPipelineStateCommandOutput} for command's `response` shape. * @see {@link CodePipelineClientResolvedConfig | config} for CodePipelineClient's `config` shape. * * @throws {@link PipelineNotFoundException} (client fault) *

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

* * @throws {@link ValidationException} (client fault) *

The validation was specified in an invalid format.

* * @throws {@link CodePipelineServiceException} *

Base exception class for all service exceptions from CodePipeline service.

* * * @public */ export declare class GetPipelineStateCommand extends GetPipelineStateCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetPipelineStateInput; output: GetPipelineStateOutput; }; sdk: { input: GetPipelineStateCommandInput; output: GetPipelineStateCommandOutput; }; }; }