@aws-sdk/client-codecatalyst 3.450.0 → 3.452.0

package/dist-types/commands/ListWorkflowRunsCommand.d.ts

@@ -0,0 +1,114 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { CodeCatalystClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeCatalystClient";
+import { ListWorkflowRunsRequest, ListWorkflowRunsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListWorkflowRunsCommand}.
+ */
+export interface ListWorkflowRunsCommandInput extends ListWorkflowRunsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListWorkflowRunsCommand}.
+ */
+export interface ListWorkflowRunsCommandOutput extends ListWorkflowRunsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Retrieves a list of workflow runs of a specified workflow.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CodeCatalystClient, ListWorkflowRunsCommand } from "@aws-sdk/client-codecatalyst"; // ES Modules import
+ * // const { CodeCatalystClient, ListWorkflowRunsCommand } = require("@aws-sdk/client-codecatalyst"); // CommonJS import
+ * const client = new CodeCatalystClient(config);
+ * const input = { // ListWorkflowRunsRequest
+ *   spaceName: "STRING_VALUE", // required
+ *   workflowId: "STRING_VALUE",
+ *   projectName: "STRING_VALUE", // required
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   sortBy: [ // WorkflowRunSortCriteriaList
+ *     {},
+ *   ],
+ * };
+ * const command = new ListWorkflowRunsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListWorkflowRunsResponse
+ * //   nextToken: "STRING_VALUE",
+ * //   items: [ // WorkflowRunSummaries
+ * //     { // WorkflowRunSummary
+ * //       id: "STRING_VALUE", // required
+ * //       workflowId: "STRING_VALUE", // required
+ * //       workflowName: "STRING_VALUE", // required
+ * //       status: "STRING_VALUE", // required
+ * //       statusReasons: [ // WorkflowRunStatusReasons
+ * //         {},
+ * //       ],
+ * //       startTime: new Date("TIMESTAMP"), // required
+ * //       endTime: new Date("TIMESTAMP"),
+ * //       lastUpdatedTime: new Date("TIMESTAMP"), // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListWorkflowRunsCommandInput - {@link ListWorkflowRunsCommandInput}
+ * @returns {@link ListWorkflowRunsCommandOutput}
+ * @see {@link ListWorkflowRunsCommandInput} for command's `input` shape.
+ * @see {@link ListWorkflowRunsCommandOutput} for command's `response` shape.
+ * @see {@link CodeCatalystClientResolvedConfig | config} for CodeCatalystClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request.
+ *        Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce
+ *       the number of resources, or change the tier if applicable.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.</p>
+ *
+ * @throws {@link CodeCatalystServiceException}
+ * <p>Base exception class for all service exceptions from CodeCatalyst service.</p>
+ *
+ */
+export declare class ListWorkflowRunsCommand extends $Command<ListWorkflowRunsCommandInput, ListWorkflowRunsCommandOutput, CodeCatalystClientResolvedConfig> {
+    readonly input: ListWorkflowRunsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListWorkflowRunsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeCatalystClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListWorkflowRunsCommandInput, ListWorkflowRunsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/ListWorkflowsCommand.d.ts

@@ -0,0 +1,114 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { CodeCatalystClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeCatalystClient";
+import { ListWorkflowsRequest, ListWorkflowsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListWorkflowsCommand}.
+ */
+export interface ListWorkflowsCommandInput extends ListWorkflowsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListWorkflowsCommand}.
+ */
+export interface ListWorkflowsCommandOutput extends ListWorkflowsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Retrieves a list of workflows in a specified project.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CodeCatalystClient, ListWorkflowsCommand } from "@aws-sdk/client-codecatalyst"; // ES Modules import
+ * // const { CodeCatalystClient, ListWorkflowsCommand } = require("@aws-sdk/client-codecatalyst"); // CommonJS import
+ * const client = new CodeCatalystClient(config);
+ * const input = { // ListWorkflowsRequest
+ *   spaceName: "STRING_VALUE", // required
+ *   projectName: "STRING_VALUE", // required
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   sortBy: [ // WorkflowSortCriteriaList
+ *     {},
+ *   ],
+ * };
+ * const command = new ListWorkflowsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListWorkflowsResponse
+ * //   nextToken: "STRING_VALUE",
+ * //   items: [ // WorkflowSummaries
+ * //     { // WorkflowSummary
+ * //       id: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE", // required
+ * //       sourceRepositoryName: "STRING_VALUE", // required
+ * //       sourceBranchName: "STRING_VALUE", // required
+ * //       definition: { // WorkflowDefinitionSummary
+ * //         path: "STRING_VALUE", // required
+ * //       },
+ * //       createdTime: new Date("TIMESTAMP"), // required
+ * //       lastUpdatedTime: new Date("TIMESTAMP"), // required
+ * //       runMode: "STRING_VALUE", // required
+ * //       status: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListWorkflowsCommandInput - {@link ListWorkflowsCommandInput}
+ * @returns {@link ListWorkflowsCommandOutput}
+ * @see {@link ListWorkflowsCommandInput} for command's `input` shape.
+ * @see {@link ListWorkflowsCommandOutput} for command's `response` shape.
+ * @see {@link CodeCatalystClientResolvedConfig | config} for CodeCatalystClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request.
+ *        Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce
+ *       the number of resources, or change the tier if applicable.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.</p>
+ *
+ * @throws {@link CodeCatalystServiceException}
+ * <p>Base exception class for all service exceptions from CodeCatalyst service.</p>
+ *
+ */
+export declare class ListWorkflowsCommand extends $Command<ListWorkflowsCommandInput, ListWorkflowsCommandOutput, CodeCatalystClientResolvedConfig> {
+    readonly input: ListWorkflowsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListWorkflowsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeCatalystClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListWorkflowsCommandInput, ListWorkflowsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/StartWorkflowRunCommand.d.ts

@@ -0,0 +1,99 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { CodeCatalystClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeCatalystClient";
+import { StartWorkflowRunRequest, StartWorkflowRunResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartWorkflowRunCommand}.
+ */
+export interface StartWorkflowRunCommandInput extends StartWorkflowRunRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartWorkflowRunCommand}.
+ */
+export interface StartWorkflowRunCommandOutput extends StartWorkflowRunResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Begins a run of a specified workflow.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CodeCatalystClient, StartWorkflowRunCommand } from "@aws-sdk/client-codecatalyst"; // ES Modules import
+ * // const { CodeCatalystClient, StartWorkflowRunCommand } = require("@aws-sdk/client-codecatalyst"); // CommonJS import
+ * const client = new CodeCatalystClient(config);
+ * const input = { // StartWorkflowRunRequest
+ *   spaceName: "STRING_VALUE", // required
+ *   projectName: "STRING_VALUE", // required
+ *   workflowId: "STRING_VALUE", // required
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new StartWorkflowRunCommand(input);
+ * const response = await client.send(command);
+ * // { // StartWorkflowRunResponse
+ * //   spaceName: "STRING_VALUE", // required
+ * //   projectName: "STRING_VALUE", // required
+ * //   id: "STRING_VALUE", // required
+ * //   workflowId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param StartWorkflowRunCommandInput - {@link StartWorkflowRunCommandInput}
+ * @returns {@link StartWorkflowRunCommandOutput}
+ * @see {@link StartWorkflowRunCommandInput} for command's `input` shape.
+ * @see {@link StartWorkflowRunCommandOutput} for command's `response` shape.
+ * @see {@link CodeCatalystClientResolvedConfig | config} for CodeCatalystClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request.
+ *        Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce
+ *       the number of resources, or change the tier if applicable.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.</p>
+ *
+ * @throws {@link CodeCatalystServiceException}
+ * <p>Base exception class for all service exceptions from CodeCatalyst service.</p>
+ *
+ */
+export declare class StartWorkflowRunCommand extends $Command<StartWorkflowRunCommandInput, StartWorkflowRunCommandOutput, CodeCatalystClientResolvedConfig> {
+    readonly input: StartWorkflowRunCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: StartWorkflowRunCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeCatalystClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartWorkflowRunCommandInput, StartWorkflowRunCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -15,6 +15,8 @@ export * from "./GetSourceRepositoryCommand";
 export * from "./GetSpaceCommand";
 export * from "./GetSubscriptionCommand";
 export * from "./GetUserDetailsCommand";
+export * from "./GetWorkflowCommand";
+export * from "./GetWorkflowRunCommand";
 export * from "./ListAccessTokensCommand";
 export * from "./ListDevEnvironmentSessionsCommand";
 export * from "./ListDevEnvironmentsCommand";
@@ -23,8 +25,11 @@ export * from "./ListProjectsCommand";
 export * from "./ListSourceRepositoriesCommand";
 export * from "./ListSourceRepositoryBranchesCommand";
 export * from "./ListSpacesCommand";
+export * from "./ListWorkflowRunsCommand";
+export * from "./ListWorkflowsCommand";
 export * from "./StartDevEnvironmentCommand";
 export * from "./StartDevEnvironmentSessionCommand";
+export * from "./StartWorkflowRunCommand";
 export * from "./StopDevEnvironmentCommand";
 export * from "./StopDevEnvironmentSessionCommand";
 export * from "./UpdateDevEnvironmentCommand";

package/dist-types/extensionConfiguration.d.ts

@@ -1,8 +1,9 @@
 import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
 import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
 import { DefaultExtensionConfiguration } from "@smithy/types";
+import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
 /**
  * @internal
  */
-export interface CodeCatalystExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration {
+export interface CodeCatalystExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
 }

package/dist-types/index.d.ts

@@ -22,7 +22,7 @@
  *             </li>
  *             <li>
  *                <p>
- *                   <a>UpdateSpace</a>, which hanges one or more values for a space.</p>
+ *                   <a>UpdateSpace</a>, which changes one or more values for a space.</p>
  *             </li>
  *          </ul>
  *          <p>Projects, by calling the following:</p>
@@ -123,6 +123,29 @@
  *                   <a>UpdateDevEnvironment</a>, which changes one or more values for a Dev Environment.</p>
  *             </li>
  *          </ul>
+ *          <p>Workflows, by calling the following:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a>GetWorkflow</a>, which returns information about a workflow.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>GetWorkflowRun</a>, which returns information about a specified run of a workflow.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>ListWorkflowRuns</a>, which retrieves a list of runs of a specified workflow.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>ListWorkflows</a>, which retrieves a list of workflows in a specified project.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>StartWorkflowRun</a>, which starts a run of a specified workflow.</p>
+ *             </li>
+ *          </ul>
  *          <p>Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:</p>
  *          <ul>
  *             <li>