UpdateActionTypeCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CodePipelineClient, UpdateActionTypeCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import
// const { CodePipelineClient, UpdateActionTypeCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import
const client = new CodePipelineClient(config);
const input = { // UpdateActionTypeInput
  actionType: { // ActionTypeDeclaration
    description: "STRING_VALUE",
    executor: { // ActionTypeExecutor
      configuration: { // ExecutorConfiguration
        lambdaExecutorConfiguration: { // LambdaExecutorConfiguration
          lambdaFunctionArn: "STRING_VALUE", // required
        },
        jobWorkerExecutorConfiguration: { // JobWorkerExecutorConfiguration
          pollingAccounts: [ // PollingAccountList
            "STRING_VALUE",
          ],
          pollingServicePrincipals: [ // PollingServicePrincipalList
            "STRING_VALUE",
          ],
        },
      },
      type: "JobWorker" || "Lambda", // required
      policyStatementsTemplate: "STRING_VALUE",
      jobTimeout: Number("int"),
    },
    id: { // ActionTypeIdentifier
      category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval" || "Compute", // required
      owner: "STRING_VALUE", // required
      provider: "STRING_VALUE", // required
      version: "STRING_VALUE", // required
    },
    inputArtifactDetails: { // ActionTypeArtifactDetails
      minimumCount: Number("int"), // required
      maximumCount: Number("int"), // required
    },
    outputArtifactDetails: {
      minimumCount: Number("int"), // required
      maximumCount: Number("int"), // required
    },
    permissions: { // ActionTypePermissions
      allowedAccounts: [ // AllowedAccounts // required
        "STRING_VALUE",
      ],
    },
    properties: [ // ActionTypeProperties
      { // ActionTypeProperty
        name: "STRING_VALUE", // required
        optional: true || false, // required
        key: true || false, // required
        noEcho: true || false, // required
        queryable: true || false,
        description: "STRING_VALUE",
      },
    ],
    urls: { // ActionTypeUrls
      configurationUrl: "STRING_VALUE",
      entityUrlTemplate: "STRING_VALUE",
      executionUrlTemplate: "STRING_VALUE",
      revisionUrlTemplate: "STRING_VALUE",
    },
  },
};
const command = new UpdateActionTypeCommand(input);
const response = await client.send(command);
// {};

UpdateActionTypeCommand Input

See UpdateActionTypeCommandInput for more details

Parameter
Type
Description
actionType
Required
ActionTypeDeclaration | undefined

The action type definition for the action type to be updated.

UpdateActionTypeCommand Output

See UpdateActionTypeCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
ActionTypeNotFoundException
client

The specified action type cannot be found.

RequestFailedException
client

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

ValidationException
client

The validation was specified in an invalid format.

CodePipelineServiceException
Base exception class for all service exceptions from CodePipeline service.