openapi: 3.0.0 info: version: 2019-12-02 x-release: v4 title: EC2 Image Builder CancelImageCreation ListImagePipelines API description: EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards. x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png 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: imagebuilder x-aws-signingName: imagebuilder x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/imagebuilder-2019-12-02.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://imagebuilder.{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 imagebuilder multi-region endpoint - url: https://imagebuilder.{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 imagebuilder multi-region endpoint - url: http://imagebuilder.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The imagebuilder endpoint for China (Beijing) and China (Ningxia) - url: https://imagebuilder.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The imagebuilder endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: ListImagePipelines paths: /ListImagePipelines: 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: ListImagePipelines description: Returns a list of image pipelines. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListImagePipelinesResponse' examples: ListImagePipelines200Example: summary: Default ListImagePipelines 200 response x-microcks-default: true value: requestId: example-id-1234 imagePipelineList: example-string nextToken: example-string '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' examples: ListImagePipelines480Example: summary: Default ListImagePipelines 480 response x-microcks-default: true value: {} '481': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' examples: ListImagePipelines481Example: summary: Default ListImagePipelines 481 response x-microcks-default: true value: {} '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '483': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '484': description: InvalidPaginationTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidPaginationTokenException' '485': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '486': description: CallRateLimitExceededException content: application/json: schema: $ref: '#/components/schemas/CallRateLimitExceededException' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: filters: description:

Use the following filters to streamline results:

type: array items: $ref: '#/components/schemas/Filter' minItems: 1 maxItems: 10 maxResults: description: The maximum items to return in a request. type: integer minimum: 1 maximum: 25 nextToken: description: A token to specify where to start paginating. This is the NextToken from a previously truncated response. type: string minLength: 1 maxLength: 65535 summary: Amazon EC2 Image Builder List Image Pipelines x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - ListImagePipelines components: schemas: Arn: type: string Platform: type: string enum: - Windows - Linux StringList: type: array items: $ref: '#/components/schemas/NonEmptyString' NonEmptyString: type: string minLength: 1 maxLength: 1024 ImagePipeline: type: object properties: arn: allOf: - $ref: '#/components/schemas/ImageBuilderArn' - description: The Amazon Resource Name (ARN) of the image pipeline. name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the image pipeline. description: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The description of the image pipeline. platform: allOf: - $ref: '#/components/schemas/Platform' - description: The platform of the image pipeline. enhancedImageMetadataEnabled: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default. imageRecipeArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline. containerRecipeArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline. infrastructureConfigurationArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline. distributionConfigurationArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline. imageTestsConfiguration: allOf: - $ref: '#/components/schemas/ImageTestsConfiguration' - description: The image tests configuration of the image pipeline. schedule: allOf: - $ref: '#/components/schemas/Schedule' - description: The schedule of the image pipeline. status: allOf: - $ref: '#/components/schemas/PipelineStatus' - description: The status of the image pipeline. dateCreated: allOf: - $ref: '#/components/schemas/DateTime' - description: The date on which this image pipeline was created. dateUpdated: allOf: - $ref: '#/components/schemas/DateTime' - description: The date on which this image pipeline was last updated. dateLastRun: allOf: - $ref: '#/components/schemas/DateTime' - description: This is no longer supported, and does not return a value. dateNextRun: allOf: - $ref: '#/components/schemas/DateTime' - description: This is no longer supported, and does not return a value. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The tags of this image pipeline. imageScanningConfiguration: allOf: - $ref: '#/components/schemas/ImageScanningConfiguration' - description: Contains settings for vulnerability scans. description: Details of an image pipeline. ImageTestsTimeoutMinutes: type: integer minimum: 60 maximum: 1440 DateTime: type: string ServiceException: {} ForbiddenException: {} PipelineExecutionStartCondition: type: string enum: - EXPRESSION_MATCH_ONLY - EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE ServiceUnavailableException: {} Filter: type: object properties: name: allOf: - $ref: '#/components/schemas/FilterName' - description: The name of the filter. Filter names are case-sensitive. values: allOf: - $ref: '#/components/schemas/FilterValues' - description: The filter values. Filter values are case-sensitive. description: A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. PaginationToken: type: string minLength: 1 maxLength: 65535 ResourceName: type: string pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$ Timezone: type: string pattern: '[a-zA-Z0-9]{2,}(?:\/[a-zA-z0-9-_+]+)*' minLength: 3 maxLength: 100 ImageScanningConfiguration: type: object properties: imageScanningEnabled: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image. ecrConfiguration: allOf: - $ref: '#/components/schemas/EcrConfiguration' - description: Contains Amazon ECR settings for vulnerability scans. description: Contains settings for Image Builder image resource and container image scans. TagMap: type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' TagValue: type: string maxLength: 256 CallRateLimitExceededException: {} Schedule: type: object properties: scheduleExpression: allOf: - $ref: '#/components/schemas/NonEmptyString' - description:

The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

timezone: allOf: - $ref: '#/components/schemas/Timezone' - description: The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC. pipelineExecutionStartCondition: allOf: - $ref: '#/components/schemas/PipelineExecutionStartCondition' - description: The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference. description: A schedule configures how often and when a pipeline will automatically create a new image. ImageTestsConfiguration: type: object properties: imageTestsEnabled: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution. timeoutMinutes: allOf: - $ref: '#/components/schemas/ImageTestsTimeoutMinutes' - description:

The maximum time in minutes that tests are permitted to run.

The timeoutMinutes attribute is not currently active. This value is ignored.

 description: Configure image tests for your pipeline build. Tests run after building the image, to verify that the AMI or container image is valid before distributing it. ClientException: {} ImagePipelineList: type: array items: $ref: '#/components/schemas/ImagePipeline' InvalidRequestException: {} FilterValue: type: string pattern: ^[0-9a-zA-Z./_ :-]{1,1024}$ PipelineStatus: type: string enum: - DISABLED - ENABLED InvalidPaginationTokenException: {} NullableBoolean: type: boolean FilterValues: type: array items: $ref: '#/components/schemas/FilterValue' minItems: 1 maxItems: 10 ListImagePipelinesResponse: type: object properties: requestId: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The request ID that uniquely identifies this request. imagePipelineList: allOf: - $ref: '#/components/schemas/ImagePipelineList' - description: The list of image pipelines. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects. FilterName: type: string pattern: ^[a-zA-Z]{1,1024}$ EcrConfiguration: type: object properties: repositoryName: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images. example: example-resource-name containerTags: allOf: - $ref: '#/components/schemas/StringList' - description: Tags for Image Builder to apply to the output container image that &INS; scans. Tags can help you identify and manage your scanned images. example: example-string description: Settings that Image Builder uses to configure the ECR repository and the output container images that Amazon Inspector scans. ImageBuilderArn: type: string pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$ parameters: 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-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential 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/imagebuilder/ x-hasEquivalentPaths: true