The #X Amz Target=CodePipeline 20150709.CreateCustomActionType API from Amazon CodePipeline — 1 operation(s) for #x amz target=codepipeline 20150709.createcustomactiontype.
openapi: 3.0.0
info:
version: '2015-07-09'
x-release: v4
title: 'AWS CodePipeline Executions #X Amz Target=CodePipeline 20150709.CreateCustomActionType API'
description: <fullname>CodePipeline</fullname> <p> <b>Overview</b> </p> <p>This is the CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html">CodePipeline User Guide</a>.</p> <p>You can use the CodePipeline API to work with pipelines, stages, actions, and transitions.</p> <p> <i>Pipelines</i> are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions. </p> <p>You can work with pipelines by calling:</p> <ul> <li> <p> <a>CreatePipeline</a>, which creates a uniquely named pipeline.</p> </li> <li> <p> <a>DeletePipeline</a>, which deletes the specified pipeline.</p> </li> <li> <p> <a>GetPipeline</a>, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).</p> </li> <li> <p> <a>GetPipelineExecution</a>, which returns information about a specific execution of a pipeline.</p> </li> <li> <p> <a>GetPipelineState</a>, which returns information about the current state of the stages and actions of a pipeline.</p> </li> <li> <p> <a>ListActionExecutions</a>, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.</p> </li> <li> <p> <a>ListPipelines</a>, which gets a summary of all of the pipelines associated with your account.</p> </li> <li> <p> <a>ListPipelineExecutions</a>, which gets a summary of the most recent executions for a pipeline.</p> </li> <li> <p> <a>StartPipelineExecution</a>, which runs the most recent revision of an artifact through the pipeline.</p> </li> <li> <p> <a>StopPipelineExecution</a>, which stops the specified pipeline execution from continuing through the pipeline.</p> </li> <li> <p> <a>UpdatePipeline</a>, which updates a pipeline with edits or changes to the structure of the pipeline.</p> </li> </ul> <p>Pipelines include <i>stages</i>. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call <a>GetPipelineState</a>, which displays the status of a pipeline, including the status of stages in the pipeline, or <a>GetPipeline</a>, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html">CodePipeline Pipeline Structure Reference</a>.</p> <p>Pipeline stages include <i>actions</i> that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as <a>CreatePipeline</a> and <a>GetPipelineState</a>. Valid action categories are:</p> <ul> <li> <p>Source</p> </li> <li> <p>Build</p> </li> <li> <p>Test</p> </li> <li> <p>Deploy</p> </li> <li> <p>Approval</p> </li> <li> <p>Invoke</p> </li> </ul> <p>Pipelines also include <i>transitions</i>, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.</p> <p>You can work with transitions by calling:</p> <ul> <li> <p> <a>DisableStageTransition</a>, which prevents artifacts from transitioning to the next stage in a pipeline.</p> </li> <li> <p> <a>EnableStageTransition</a>, which enables transition of artifacts between stages in a pipeline. </p> </li> </ul> <p> <b>Using the API to integrate with CodePipeline</b> </p> <p>For third-party integrators or developers who want to create their own integrations with CodePipeline, the expected sequence varies from the standard API user. To integrate with CodePipeline, developers need to work with the following items:</p> <p> <b>Jobs</b>, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source. </p> <p>You can work with jobs by calling:</p> <ul> <li> <p> <a>AcknowledgeJob</a>, which confirms whether a job worker has received the specified job.</p> </li> <li> <p> <a>GetJobDetails</a>, which returns the details of a job.</p> </li> <li> <p> <a>PollForJobs</a>, which determines whether there are any jobs to act on.</p> </li> <li> <p> <a>PutJobFailureResult</a>, which provides details of a job failure. </p> </li> <li> <p> <a>PutJobSuccessResult</a>, which provides details of a job success.</p> </li> </ul> <p> <b>Third party jobs</b>, which are instances of an action created by a partner action and integrated into CodePipeline. Partner actions are created by members of the Amazon Web Services Partner Network.</p> <p>You can work with third party jobs by calling:</p> <ul> <li> <p> <a>AcknowledgeThirdPartyJob</a>, which confirms whether a job worker has received the specified job.</p> </li> <li> <p> <a>GetThirdPartyJobDetails</a>, which requests the details of a job for a partner action.</p> </li> <li> <p> <a>PollForThirdPartyJobs</a>, which determines whether there are any jobs to act on. </p> </li> <li> <p> <a>PutThirdPartyJobFailureResult</a>, which provides details of a job failure.</p> </li> <li> <p> <a>PutThirdPartyJobSuccessResult</a>, which provides details of a job success.</p> </li> </ul>
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: codepipeline
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codepipeline-2015-07-09.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://codepipeline.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The CodePipeline multi-region endpoint
- url: https://codepipeline.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The CodePipeline multi-region endpoint
- url: http://codepipeline.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The CodePipeline endpoint for China (Beijing) and China (Ningxia)
- url: https://codepipeline.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The CodePipeline endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=CodePipeline 20150709.CreateCustomActionType'
paths:
/#X-Amz-Target=CodePipeline_20150709.CreateCustomActionType:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateCustomActionType
description: Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCustomActionTypeOutput'
examples:
CreateCustomActionType200Example:
summary: Default CreateCustomActionType 200 response
x-microcks-default: true
value:
actionType: STANDARD
tags: example-value
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
CreateCustomActionType480Example:
summary: Default CreateCustomActionType 480 response
x-microcks-default: true
value: STANDARD
'481':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
examples:
CreateCustomActionType481Example:
summary: Default CreateCustomActionType 481 response
x-microcks-default: true
value: STANDARD
'482':
description: TooManyTagsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyTagsException'
examples:
CreateCustomActionType482Example:
summary: Default CreateCustomActionType 482 response
x-microcks-default: true
value: STANDARD
'483':
description: InvalidTagsException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidTagsException'
examples:
CreateCustomActionType483Example:
summary: Default CreateCustomActionType 483 response
x-microcks-default: true
value: STANDARD
'484':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
CreateCustomActionType484Example:
summary: Default CreateCustomActionType 484 response
x-microcks-default: true
value: STANDARD
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCustomActionTypeInput'
examples:
CreateCustomActionTypeRequestExample:
summary: Default CreateCustomActionType request
x-microcks-default: true
value:
category: example-value
provider: '500123'
version: 1.0.0
settings: example-value
configurationProperties: example-value
inputArtifactDetails: example-value
outputArtifactDetails: example-value
tags: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodePipeline_20150709.CreateCustomActionType
summary: Amazon CodePipeline Create Custom Action Type
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=CodePipeline 20150709.CreateCustomActionType'
components:
schemas:
ActionConfigurationProperty:
type: object
required:
- name
- required
- key
- secret
properties:
name:
allOf:
- $ref: '#/components/schemas/ActionConfigurationKey'
- description: The name of the action configuration property.
required:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Whether the configuration property is a required value.
key:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Whether the configuration property is a key.
secret:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: <p>Whether the configuration property is secret. Secrets are hidden from all calls except for <code>GetJobDetails</code>, <code>GetThirdPartyJobDetails</code>, <code>PollForJobs</code>, and <code>PollForThirdPartyJobs</code>.</p> <p>When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.</p>
queryable:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: <p>Indicates that the property is used with <code>PollForJobs</code>. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.</p> <p>If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.</p>
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: The description of the action configuration property that is displayed to users.
type:
allOf:
- $ref: '#/components/schemas/ActionConfigurationPropertyType'
- description: The type of the configuration property.
description: Represents information about an action configuration property.
Tag:
type: object
required:
- key
- value
properties:
key:
allOf:
- $ref: '#/components/schemas/TagKey'
- description: The tag's key.
value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: The tag's value.
description: A tag is a key-value pair that is used to manage the resource.
Boolean:
type: boolean
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
LimitExceededException: {}
ActionCategory:
type: string
enum:
- Source
- Build
- Deploy
- Test
- Invoke
- Approval
ActionTypeSettings:
type: object
properties:
thirdPartyConfigurationUrl:
allOf:
- $ref: '#/components/schemas/Url'
- description: The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.
entityUrlTemplate:
allOf:
- $ref: '#/components/schemas/UrlTemplate'
- description: The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
executionUrlTemplate:
allOf:
- $ref: '#/components/schemas/UrlTemplate'
- description: The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.
revisionUrlTemplate:
allOf:
- $ref: '#/components/schemas/UrlTemplate'
- description: 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.
description: Returns information about the settings for an action type.
ActionConfigurationPropertyType:
type: string
enum:
- String
- Number
- Boolean
ValidationException: {}
ArtifactDetails:
type: object
required:
- minimumCount
- maximumCount
properties:
minimumCount:
allOf:
- $ref: '#/components/schemas/MinimumArtifactCount'
- description: The minimum number of artifacts allowed for the action type.
maximumCount:
allOf:
- $ref: '#/components/schemas/MaximumArtifactCount'
- description: The maximum number of artifacts allowed for the action type.
description: Returns information about the details of an artifact.
ActionOwner:
type: string
enum:
- AWS
- ThirdParty
- Custom
MinimumArtifactCount:
type: integer
minimum: 0
maximum: 5
TagKey:
type: string
minLength: 1
maxLength: 128
ConcurrentModificationException: {}
ActionConfigurationPropertyList:
type: array
items:
$ref: '#/components/schemas/ActionConfigurationProperty'
maxItems: 10
Version:
type: string
pattern: '[0-9A-Za-z_-]+'
minLength: 1
maxLength: 9
Url:
type: string
minLength: 1
maxLength: 2048
ActionTypeId:
type: object
required:
- category
- owner
- provider
- version
properties:
category:
allOf:
- $ref: '#/components/schemas/ActionCategory'
- description: <p>A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values. </p> <ul> <li> <p>Source</p> </li> <li> <p>Build</p> </li> <li> <p>Test</p> </li> <li> <p>Deploy</p> </li> <li> <p>Invoke</p> </li> <li> <p>Approval</p> </li> </ul>
owner:
allOf:
- $ref: '#/components/schemas/ActionOwner'
- description: 'The creator of the action being called. There are three valid values for the <code>Owner</code> field in the action category section within your pipeline structure: <code>AWS</code>, <code>ThirdParty</code>, and <code>Custom</code>. For more information, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers">Valid Action Types and Providers in CodePipeline</a>.'
provider:
allOf:
- $ref: '#/components/schemas/ActionProvider'
- description: The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as <code>CodeDeploy</code>. For more information, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers">Valid Action Types and Providers in CodePipeline</a>.
version:
allOf:
- $ref: '#/components/schemas/Version'
- description: A string that describes the action version.
description: Represents information about an action type.
InvalidTagsException: {}
CreateCustomActionTypeOutput:
type: object
required:
- actionType
properties:
actionType:
allOf:
- $ref: '#/components/schemas/ActionType'
- description: Returns information about the details of an action type.
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: Specifies the tags applied to the custom action.
description: Represents the output of a <code>CreateCustomActionType</code> operation.
ActionConfigurationKey:
type: string
minLength: 1
maxLength: 50
ActionProvider:
type: string
pattern: '[0-9A-Za-z_-]+'
minLength: 1
maxLength: 35
TooManyTagsException: {}
MaximumArtifactCount:
type: integer
minimum: 0
maximum: 5
UrlTemplate:
type: string
minLength: 1
maxLength: 2048
TagValue:
type: string
minLength: 0
maxLength: 256
CreateCustomActionTypeInput:
type: object
required:
- category
- provider
- version
- inputArtifactDetails
- outputArtifactDetails
title: CreateCustomActionTypeInput
properties:
category:
allOf:
- $ref: '#/components/schemas/ActionCategory'
- description: The category of the custom action, such as a build action or a test action.
provider:
allOf:
- $ref: '#/components/schemas/ActionProvider'
- description: The provider of the service used in the custom action, such as CodeDeploy.
version:
allOf:
- $ref: '#/components/schemas/Version'
- description: The version identifier of the custom action.
settings:
allOf:
- $ref: '#/components/schemas/ActionTypeSettings'
- description: URLs that provide users information about this custom action.
configurationProperties:
allOf:
- $ref: '#/components/schemas/ActionConfigurationPropertyList'
- description: <p>The configuration properties for the custom action.</p> <note> <p>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 <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html">Create a Custom Action for a Pipeline</a>.</p> </note>
inputArtifactDetails:
allOf:
- $ref: '#/components/schemas/ArtifactDetails'
- description: The details of the input artifact for the action, such as its commit ID.
outputArtifactDetails:
allOf:
- $ref: '#/components/schemas/ArtifactDetails'
- description: The details of the output artifact of the action, such as its commit ID.
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tags for the custom action.
description: Represents the input of a CreateCustomActionType operation.
Description:
type: string
minLength: 1
maxLength: 160
ActionType:
type: object
required:
- id
- inputArtifactDetails
- outputArtifactDetails
properties:
id:
allOf:
- $ref: '#/components/schemas/ActionTypeId'
- description: Represents information about an action type.
settings:
allOf:
- $ref: '#/components/schemas/ActionTypeSettings'
- description: The settings for the action type.
actionConfigurationProperties:
allOf:
- $ref: '#/components/schemas/ActionConfigurationPropertyList'
- description: The configuration properties for the action type.
inputArtifactDetails:
allOf:
- $ref: '#/components/schemas/ArtifactDetails'
- description: The details of the input artifact for the action, such as its commit ID.
outputArtifactDetails:
allOf:
- $ref: '#/components/schemas/ArtifactDetails'
- description: The details of the output artifact of the action, such as its commit ID.
description: Returns information about the details of an action type.
parameters:
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/codepipeline/
x-hasEquivalentPaths: true