update-action-type¶

Description¶

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.

Synopsis¶

  update-action-type
--action-type <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--action-type (structure)

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

description -> (string)

The description for the action type to be updated.

executor -> (structure)

Information about the executor for an action type that was created with any supported integration model.

configuration -> (structure)

The action configuration properties for the action type. These properties are specified in the action definition when the action type is created.

lambdaExecutorConfiguration -> (structure)

Details about the Lambda executor of the action type.

lambdaFunctionArn -> (string)

The ARN of the Lambda function used by the action engine.

jobWorkerExecutorConfiguration -> (structure)

Details about the JobWorker executor of the action type.

pollingAccounts -> (list)

The accounts in which the job worker is configured and might poll for jobs as part of the action execution.

(string)

pollingServicePrincipals -> (list)

The service Principals in which the job worker is configured and might poll for jobs as part of the action execution.

(string)

type -> (string)

The integration model used to create and update the action type, Lambda or JobWorker .

policyStatementsTemplate -> (string)

The policy statement that specifies the permissions in the CodePipeline customer’s account that are needed to successfully run an action.

To grant permission to another account, specify the account ID as the Principal, a domain-style identifier defined by the service, for example codepipeline.amazonaws.com .

Note

The size of the passed JSON policy document cannot exceed 2048 characters.

jobTimeout -> (integer)

The timeout in seconds for the job. An action execution can have multiple jobs. This is the timeout for a single job, not the entire action execution.

id -> (structure)

The action category, owner, provider, and version of the action type to be updated.

category -> (string)

Defines what kind of action can be taken in the stage, one of the following:

Source

Build

Test

Deploy

Approval

Invoke

owner -> (string)

The creator of the action type being called: AWS or ThirdParty .

provider -> (string)

The provider of the action type being called. The provider name is supplied when the action type is created.

version -> (string)

A string that describes the action type version.

inputArtifactDetails -> (structure)

Details for the artifacts, such as application files, to be worked on by the action. For example, the minimum and maximum number of input artifacts allowed.

minimumCount -> (integer)

The minimum number of artifacts that can be used with the action type. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source .

maximumCount -> (integer)

The maximum number of artifacts that can be used with the actiontype. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source .

outputArtifactDetails -> (structure)

Details for the output artifacts, such as a built application, that are the result of the action. For example, the minimum and maximum number of output artifacts allowed.

minimumCount -> (integer)

The minimum number of artifacts that can be used with the action type. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source .

maximumCount -> (integer)

The maximum number of artifacts that can be used with the actiontype. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source .

permissions -> (structure)

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

allowedAccounts -> (list)

A list of AWS account IDs with access to use the action type in their pipelines.

(string)

properties -> (list)

The properties of the action type to be updated.

(structure)

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.

name -> (string)

The property name that is displayed to users.

optional -> (boolean)

Whether the configuration property is an optional value.

key -> (boolean)

Whether the configuration property is a key.

noEcho -> (boolean)

Whether to omit the field value entered by the customer in the log. If true , the value is not saved in CloudTrail logs for the action execution.

queryable -> (boolean)

Indicates that the property is used with polling. An action type can have up to one queryable property. If it has one, that property must be both required and not secret.

description -> (string)

The description of the property that is displayed to users.

urls -> (structure)

The links associated with the action type to be updated.

configurationUrl -> (string)

The URL returned to the CodePipeline console that contains a link to the page where customers can configure the external action.

entityUrlTemplate -> (string)

The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as a status page. This link is provided as part of the action display in the pipeline.

executionUrlTemplate -> (string)

The link to an execution page for the action type in progress. For example, for a CodeDeploy action, this link is shown on the pipeline view page in the CodePipeline console, and it links to a CodeDeploy status page.

revisionUrlTemplate -> (string)

The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

JSON Syntax:

{
  "description": "string",
  "executor": {
    "configuration": {
      "lambdaExecutorConfiguration": {
        "lambdaFunctionArn": "string"
      },
      "jobWorkerExecutorConfiguration": {
        "pollingAccounts": ["string", ...],
        "pollingServicePrincipals": ["string", ...]
      }
    },
    "type": "JobWorker"|"Lambda",
    "policyStatementsTemplate": "string",
    "jobTimeout": integer
  },
  "id": {
    "category": "Source"|"Build"|"Deploy"|"Test"|"Invoke"|"Approval",
    "owner": "string",
    "provider": "string",
    "version": "string"
  },
  "inputArtifactDetails": {
    "minimumCount": integer,
    "maximumCount": integer
  },
  "outputArtifactDetails": {
    "minimumCount": integer,
    "maximumCount": integer
  },
  "permissions": {
    "allowedAccounts": ["string", ...]
  },
  "properties": [
    {
      "name": "string",
      "optional": true|false,
      "key": true|false,
      "noEcho": true|false,
      "queryable": true|false,
      "description": "string"
    }
    ...
  ],
  "urls": {
    "configurationUrl": "string",
    "entityUrlTemplate": "string",
    "executionUrlTemplate": "string",
    "revisionUrlTemplate": "string"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output¶

None

Table of Contents

Feedback

User Guide