openapi: 3.0.0 info: version: 2019-12-02 x-release: v4 title: EC2 Image Builder CancelImageCreation GetContainerRecipe#containerRecipeArn 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: GetContainerRecipe#containerRecipeArn paths: /GetContainerRecipe#containerRecipeArn: 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' get: operationId: GetContainerRecipe description: Retrieves a container recipe. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetContainerRecipeResponse' examples: GetContainerRecipe200Example: summary: Default GetContainerRecipe 200 response x-microcks-default: true value: requestId: example-id-1234 containerRecipe: example-string '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' examples: GetContainerRecipe480Example: summary: Default GetContainerRecipe 480 response x-microcks-default: true value: {} '481': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' examples: GetContainerRecipe481Example: summary: Default GetContainerRecipe 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: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '485': description: CallRateLimitExceededException content: application/json: schema: $ref: '#/components/schemas/CallRateLimitExceededException' parameters: - name: containerRecipeArn in: query required: true description: The Amazon Resource Name (ARN) of the container recipe to retrieve. schema: type: string pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):container-recipe/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+$ summary: Amazon EC2 Image Builder Get Container Recipe x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - GetContainerRecipe#containerRecipeArn components: schemas: ContainerRecipe: type: object properties: arn: allOf: - $ref: '#/components/schemas/ImageBuilderArn' - description: '

The Amazon Resource Name (ARN) of the container recipe.

Semantic versioning is included in each object''s Amazon Resource Name (ARN), at the level that applies to that object as follows:

  1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.

  2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>

  3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

' containerType: allOf: - $ref: '#/components/schemas/ContainerType' - description: Specifies the type of container, such as Docker. name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the container recipe. description: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The description of the container recipe. platform: allOf: - $ref: '#/components/schemas/Platform' - description: The system platform for the container, such as Windows or Linux. owner: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The owner of the container recipe. version: allOf: - $ref: '#/components/schemas/VersionNumber' - description: '

The semantic version of the container recipe.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

' components: allOf: - $ref: '#/components/schemas/ComponentConfigurationList' - description: Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination. instanceConfiguration: allOf: - $ref: '#/components/schemas/InstanceConfiguration' - description: A group of options that can be used to configure an instance for building and testing container images. dockerfileTemplateData: allOf: - $ref: '#/components/schemas/DockerFileTemplate' - description: Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe. kmsKeyId: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: Identifies which KMS key is used to encrypt the container image for distribution to the target Region. encrypted: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: A flag that indicates if the target container is encrypted. parentImage: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The base image for the container recipe. dateCreated: allOf: - $ref: '#/components/schemas/DateTime' - description: The date when this container recipe was created. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: Tags that are attached to the container recipe. workingDirectory: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The working directory for use during build and test workflows. targetRepository: allOf: - $ref: '#/components/schemas/TargetContainerRepository' - description: The destination repository for the container image. description: A container recipe. Platform: type: string enum: - Windows - Linux VersionNumber: type: string pattern: ^[0-9]+\.[0-9]+\.[0-9]+$ EbsVolumeType: type: string enum: - standard - io1 - io2 - gp2 - gp3 - sc1 - st1 NonEmptyString: type: string minLength: 1 maxLength: 1024 GetContainerRecipeResponse: type: object properties: requestId: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The request ID that uniquely identifies this request. containerRecipe: allOf: - $ref: '#/components/schemas/ContainerRecipe' - description: The container recipe object that is returned. ComponentVersionArnOrBuildVersionArn: type: string pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\.([0-9]+|x)\.([0-9]+|x))|(?:[0-9]+\.[0-9]+\.[0-9]+/[0-9]+))$ ServiceException: {} DateTime: type: string InstanceConfiguration: type: object properties: image: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image. blockDeviceMappings: allOf: - $ref: '#/components/schemas/InstanceBlockDeviceMappings' - description: Defines the block devices to attach for building an instance from this Image Builder AMI. description: Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images. ComponentConfigurationList: type: array items: $ref: '#/components/schemas/ComponentConfiguration' minItems: 1 ForbiddenException: {} ServiceUnavailableException: {} EbsVolumeSizeInteger: type: integer minimum: 1 maximum: 16000 TargetContainerRepository: type: object required: - service - repositoryName properties: service: allOf: - $ref: '#/components/schemas/ContainerRepositoryService' - description: Specifies the service in which this image was registered. repositoryName: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The name of the container repository where the output container image is stored. This name is prefixed by the repository location. description: The container repository where the output container image is stored. ComponentParameterValue: type: string pattern: '[^\x00]*' minLength: 0 ComponentParameterName: type: string pattern: '[^\x00]+' minLength: 1 maxLength: 256 EmptyString: type: string minLength: 0 maxLength: 0 ResourceName: type: string pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$ TagMap: type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' TagValue: type: string maxLength: 256 CallRateLimitExceededException: {} ComponentConfiguration: type: object required: - componentArn properties: componentArn: allOf: - $ref: '#/components/schemas/ComponentVersionArnOrBuildVersionArn' - description: The Amazon Resource Name (ARN) of the component. example: arn:aws:service:us-east-1:123456789012:resource/example parameters: allOf: - $ref: '#/components/schemas/ComponentParameterList' - description: A group of parameter settings that Image Builder uses to configure the component for a specific recipe. example: example-string description: Configuration details of the component. InstanceBlockDeviceMapping: type: object properties: deviceName: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The device to which these mappings apply. example: example-resource-name ebs: allOf: - $ref: '#/components/schemas/EbsInstanceBlockDeviceSpecification' - description: Use to manage Amazon EBS-specific configuration for this mapping. example: example-string virtualName: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: Use to manage instance ephemeral devices. example: example-resource-name noDevice: allOf: - $ref: '#/components/schemas/EmptyString' - description: Use to remove a mapping from the base image. example: example-string description: Defines block device mappings for the instance used to configure your image. EbsIopsInteger: type: integer minimum: 100 maximum: 64000 EbsInstanceBlockDeviceSpecification: type: object properties: encrypted: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: Use to configure device encryption. deleteOnTermination: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: Use to configure delete on termination of the associated device. iops: allOf: - $ref: '#/components/schemas/EbsIopsInteger' - description: Use to configure device IOPS. kmsKeyId: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: Use to configure the KMS key to use when encrypting the device. snapshotId: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The snapshot that defines the device contents. volumeSize: allOf: - $ref: '#/components/schemas/EbsVolumeSizeInteger' - description: Use to override the device's volume size. volumeType: allOf: - $ref: '#/components/schemas/EbsVolumeType' - description: Use to override the device's volume type. throughput: allOf: - $ref: '#/components/schemas/EbsVolumeThroughput' - description: ' For GP3 volumes only – The throughput in MiB/s that the volume supports.' description: Amazon EBS-specific block device mapping specifications. ClientException: {} InvalidRequestException: {} ComponentParameter: type: object required: - name - value properties: name: allOf: - $ref: '#/components/schemas/ComponentParameterName' - description: The name of the component parameter to set. value: allOf: - $ref: '#/components/schemas/ComponentParameterValueList' - description: Sets the value for the named component parameter. description: Contains a key/value pair that sets the named component parameter. DockerFileTemplate: type: string ComponentParameterList: type: array items: $ref: '#/components/schemas/ComponentParameter' minItems: 1 ContainerType: type: string enum: - DOCKER InstanceBlockDeviceMappings: type: array items: $ref: '#/components/schemas/InstanceBlockDeviceMapping' NullableBoolean: type: boolean ComponentParameterValueList: type: array items: $ref: '#/components/schemas/ComponentParameterValue' ContainerRepositoryService: type: string enum: - ECR EbsVolumeThroughput: type: integer minimum: 125 maximum: 1000 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