AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS CodePipeline UpdateActionType API operation.

Syntax

Update-CPActionType
-Permissions_AllowedAccount <String[]>
-Id_Category <ActionCategory>
-Urls_ConfigurationUrl <String>
-ActionType_Description <String>
-Urls_EntityUrlTemplate <String>
-Urls_ExecutionUrlTemplate <String>
-Executor_JobTimeout <Int32>
-LambdaExecutorConfiguration_LambdaFunctionArn <String>
-InputArtifactDetails_MaximumCount <Int32>
-OutputArtifactDetails_MaximumCount <Int32>
-InputArtifactDetails_MinimumCount <Int32>
-OutputArtifactDetails_MinimumCount <Int32>
-Id_Owner <String>
-Executor_PolicyStatementsTemplate <String>
-JobWorkerExecutorConfiguration_PollingAccount <String[]>
-JobWorkerExecutorConfiguration_PollingServicePrincipal <String[]>
-ActionType_Property <ActionTypeProperty[]>
-Id_Provider <String>
-Urls_RevisionUrlTemplate <String>
-Executor_Type <ExecutorType>
-Id_Version <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonCodePipelineConfig>

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.

Parameters

-ActionType_Description <String>
The description for the action type to be updated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ActionType_Property <ActionTypeProperty[]>
The properties of the action type to be updated. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Properties
-ClientConfig <AmazonCodePipelineConfig>
Amazon.PowerShell.Cmdlets.CP.AmazonCodePipelineClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Executor_JobTimeout <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Executor_JobTimeout
-Executor_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Executor_PolicyStatementsTemplate
-Executor_Type <ExecutorType>
The integration model used to create and update the action type, Lambda or JobWorker.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Executor_Type
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Id_Category <ActionCategory>
Defines what kind of action can be taken in the stage, one of the following:
  • Source
  • Build
  • Test
  • Deploy
  • Approval
  • Invoke
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Id_Category
-Id_Owner <String>
The creator of the action type being called: AWS or ThirdParty.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Id_Owner
-Id_Provider <String>
The provider of the action type being called. The provider name is supplied when the action type is created.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Id_Provider
-Id_Version <String>
A string that describes the action type version.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Id_Version
-InputArtifactDetails_MaximumCount <Int32>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_InputArtifactDetails_MaximumCount
-InputArtifactDetails_MinimumCount <Int32>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_InputArtifactDetails_MinimumCount
-JobWorkerExecutorConfiguration_PollingAccount <String[]>
The accounts in which the job worker is configured and might poll for jobs as part of the action execution. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Executor_Configuration_JobWorkerExecutorConfiguration_PollingAccounts
-JobWorkerExecutorConfiguration_PollingServicePrincipal <String[]>
The service Principals in which the job worker is configured and might poll for jobs as part of the action execution. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Executor_Configuration_JobWorkerExecutorConfiguration_PollingServicePrincipals
-LambdaExecutorConfiguration_LambdaFunctionArn <String>
The ARN of the Lambda function used by the action engine.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Executor_Configuration_LambdaExecutorConfiguration_LambdaFunctionArn
-OutputArtifactDetails_MaximumCount <Int32>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_OutputArtifactDetails_MaximumCount
-OutputArtifactDetails_MinimumCount <Int32>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_OutputArtifactDetails_MinimumCount
-Permissions_AllowedAccount <String[]>
A list of Amazon Web Services account IDs with access to use the action type in their pipelines. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Permissions_AllowedAccounts
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodePipeline.Model.UpdateActionTypeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Urls_ConfigurationUrl <String>
The URL returned to the CodePipeline console that contains a link to the page where customers can configure the external action.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Urls_ConfigurationUrl
-Urls_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Urls_EntityUrlTemplate
-Urls_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Urls_ExecutionUrlTemplate
-Urls_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionType_Urls_RevisionUrlTemplate

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.CodePipeline.Model.UpdateActionTypeResponse
This cmdlet does not generate any output.The service response (type Amazon.CodePipeline.Model.UpdateActionTypeResponse) be returned by specifying '-Select *'.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z