action_types

Creates, updates, deletes, gets or lists an action_types resource.

Overview

Name	action_types
Type	Resource
Id	aws.codepipeline.action_types

Fields

The following fields are returned by SELECT queries:

get_action_type

Name	Datatype	Description
id	object	The action category, owner, provider, and version of the action type to be updated.
description	string	The description for the action type to be updated.
executor	object	Information about the executor for an action type that was created with any supported integration model.
input_artifact_details	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.
output_artifact_details	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.
permissions	object	Details identifying the accounts with permissions to use the action type.
properties_	array	The properties of the action type to be updated.
urls	object	The links associated with the action type to be updated.

list_action_types

Name	Datatype	Description
id	object	Represents information about an action type.
action_configuration_properties	array	The configuration properties for the action type.
input_artifact_details	object	The details of the input artifact for the action, such as its commit ID.
output_artifact_details	object	The details of the output artifact of the action, such as its commit ID.
settings	object	The settings for the action type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_action_type	select	region		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.
list_action_types	select	region		Gets a summary of all CodePipeline action types associated with your account.
create_custom_action_type	insert	region, category, provider, version, inputArtifactDetails, outputArtifactDetails		Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
update_action_type	update	region, actionType		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.
delete_custom_action_type	delete	region		Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only. To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
poll_for_jobs	exec	region, actionTypeId		Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains AWS or ThirdParty in the owner field, the PollForJobs action returns an error. When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
poll_for_third_party_jobs	exec	region, actionTypeId		Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only. When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_action_type

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.

SELECT
id,
description,
executor,
input_artifact_details,
output_artifact_details,
permissions,
properties_,
urls
FROM aws.codepipeline.action_types
WHERE region = '{{ region }}' -- required
;

list_action_types

Gets a summary of all CodePipeline action types associated with your account.

SELECT
id,
action_configuration_properties,
input_artifact_details,
output_artifact_details,
settings
FROM aws.codepipeline.action_types
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_custom_action_type

Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.

INSERT INTO aws.codepipeline.action_types (
category,
provider,
version,
settings,
configurationProperties,
inputArtifactDetails,
outputArtifactDetails,
tags,
region
)
SELECT 
'{{ category }}' /* required */,
'{{ provider }}' /* required */,
'{{ version }}' /* required */,
'{{ settings }}',
'{{ configurationProperties }}',
'{{ inputArtifactDetails }}' /* required */,
'{{ outputArtifactDetails }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
action_type,
tags
;

Manifest

# Description fields are for documentation purposes
- name: action_types
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the action_types resource.
  - name: category
    value: "{{ category }}"
    description: |
      The category of the custom action, such as a build action or a test action.
    valid_values: ['Source', 'Build', 'Deploy', 'Test', 'Invoke', 'Approval', 'Compute']
  - name: provider
    value: "{{ provider }}"
    description: |
      The provider of the service used in the custom action, such as CodeDeploy.
  - name: version
    value: "{{ version }}"
    description: |
      The version identifier of the custom action.
  - name: settings
    description: |
      URLs that provide users information about this custom action.
    value:
      thirdPartyConfigurationUrl: "{{ thirdPartyConfigurationUrl }}"
      entityUrlTemplate: "{{ entityUrlTemplate }}"
      executionUrlTemplate: "{{ executionUrlTemplate }}"
      revisionUrlTemplate: "{{ revisionUrlTemplate }}"
  - name: configurationProperties
    description: |
      The configuration properties for the custom action. You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.
    value:
      - name: "{{ name }}"
        required_: {{ required_ }}
        key: {{ key }}
        secret: {{ secret }}
        queryable: {{ queryable }}
        description: "{{ description }}"
        type_: "{{ type_ }}"
  - name: inputArtifactDetails
    description: |
      The details of the input artifact for the action, such as its commit ID.
    value:
      minimumCount: {{ minimumCount }}
      maximumCount: {{ maximumCount }}
  - name: outputArtifactDetails
    description: |
      The details of the output artifact of the action, such as its commit ID.
    value:
      minimumCount: {{ minimumCount }}
      maximumCount: {{ maximumCount }}
  - name: tags
    description: |
      The tags for the custom action.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

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.

UPDATE aws.codepipeline.action_types
SET 
actionType = '{{ actionType }}'
WHERE 
region = '{{ region }}' --required
AND actionType = '{{ actionType }}' --required;

DELETE examples

delete_custom_action_type

Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only. To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.

DELETE FROM aws.codepipeline.action_types
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

poll_for_jobs

Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains AWS or ThirdParty in the owner field, the PollForJobs action returns an error. When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

EXEC aws.codepipeline.action_types.poll_for_jobs 
@region='{{ region }}' --required 
@@json=
'{
"actionTypeId": "{{ actionTypeId }}", 
"maxBatchSize": {{ maxBatchSize }}, 
"queryParam": "{{ queryParam }}"
}'
;

poll_for_third_party_jobs

Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only. When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.

EXEC aws.codepipeline.action_types.poll_for_third_party_jobs 
@region='{{ region }}' --required 
@@json=
'{
"actionTypeId": "{{ actionTypeId }}", 
"maxBatchSize": {{ maxBatchSize }}
}'
;