AWS CodePipeline

Update action type

このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

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.

Inputs

Expand All

フィールド

種類

説明

region [required]

enum

default: us-east-1

actionType [required]

object

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

description

string

The description for the action type to be updated.

executor [required]

object

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

configuration [required]

object

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

lambdaExecutorConfiguration

object

Details about the Lambda executor of the action type.

lambdaFunctionArn [required]

string

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

jobWorkerExecutorConfiguration

object

Details about the JobWorker executor of the action type.

pollingAccounts

[string]

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

pollingServicePrincipals

[string]

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

type [required]

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 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. The size of the passed JSON policy document cannot exceed 2048 characters.

jobTimeout

number

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 [required]

object

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

category [required]

string

Defines what kind of action can be taken in the stage, one of the following: Source Build Test Deploy Approval Invoke

owner [required]

string

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

provider [required]

string

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

version [required]

string

A string that describes the action type version.

inputArtifactDetails [required]

object

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 [required]

number

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 [required]

number

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 [required]

object

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 [required]

number

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 [required]

number

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

object

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

allowedAccounts [required]

[string]

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

properties

[object]

The properties of the action type to be updated.

name [required]

string

The property name that is displayed to users.

optional [required]

boolean

Whether the configuration property is an optional value.

key [required]

boolean

Whether the configuration property is a key.

noEcho [required]

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

object

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.

Outputs

フィールド

種類

説明

amzRequestId [required]

string