GetActionType
Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.
Request Syntax
{
"category": "string",
"owner": "string",
"provider": "string",
"version": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- category
-
Defines what kind of action can be taken in the stage. The following are the valid values:
-
Source -
Build -
Test -
Deploy -
Approval -
Invoke -
Compute
Type: String
Valid Values:
Source | Build | Deploy | Test | Invoke | Approval | ComputeRequired: Yes
-
- owner
-
The creator of an action type that was created with any supported integration model. There are two valid values:
AWSandThirdParty.Type: String
Pattern:
AWS|ThirdPartyRequired: Yes
- provider
-
The provider of the action type being called. The provider name is specified when the action type is created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 35.
Pattern:
[0-9A-Za-z_-]+Required: Yes
- version
-
A string that describes the action type version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 9.
Pattern:
[0-9A-Za-z_-]+Required: Yes
Response Syntax
{
"actionType": {
"description": "string",
"executor": {
"configuration": {
"jobWorkerExecutorConfiguration": {
"pollingAccounts": [ "string" ],
"pollingServicePrincipals": [ "string" ]
},
"lambdaExecutorConfiguration": {
"lambdaFunctionArn": "string"
}
},
"jobTimeout": number,
"policyStatementsTemplate": "string",
"type": "string"
},
"id": {
"category": "string",
"owner": "string",
"provider": "string",
"version": "string"
},
"inputArtifactDetails": {
"maximumCount": number,
"minimumCount": number
},
"outputArtifactDetails": {
"maximumCount": number,
"minimumCount": number
},
"permissions": {
"allowedAccounts": [ "string" ]
},
"properties": [
{
"description": "string",
"key": boolean,
"name": "string",
"noEcho": boolean,
"optional": boolean,
"queryable": boolean
}
],
"urls": {
"configurationUrl": "string",
"entityUrlTemplate": "string",
"executionUrlTemplate": "string",
"revisionUrlTemplate": "string"
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- actionType
-
The action type information for the requested action type, such as the action type ID.
Type: ActionTypeDeclaration object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ActionTypeNotFoundException
-
The specified action type cannot be found.
HTTP Status Code: 400
- ValidationException
-
The validation was specified in an invalid format.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
