openapi: 3.2.0 info: version: 2019-12-02 x-release: v4 title: EC2 Image Builder Get Distribution Configuration 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: GetDistributionConfiguration paths: /GetDistributionConfiguration#distributionConfigurationArn: 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: GetDistributionConfiguration description: Gets a distribution configuration. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDistributionConfigurationResponse' examples: GetDistributionConfiguration200Example: summary: Default GetDistributionConfiguration 200 response x-microcks-default: true value: requestId: example-id-1234 distributionConfiguration: example-string '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' examples: GetDistributionConfiguration480Example: summary: Default GetDistributionConfiguration 480 response x-microcks-default: true value: {} '481': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' examples: GetDistributionConfiguration481Example: summary: Default GetDistributionConfiguration 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: distributionConfigurationArn in: query required: true description: The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve. schema: type: string pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):distribution-configuration/[a-z0-9-_]+$ summary: Amazon EC2 Image Builder Get Distribution Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - GetDistributionConfiguration components: schemas: LicenseConfigurationArnList: type: array items: $ref: '#/components/schemas/LicenseConfigurationArn' minItems: 1 maxItems: 50 CallRateLimitExceededException: {} LaunchTemplateConfigurationList: type: array items: $ref: '#/components/schemas/LaunchTemplateConfiguration' minItems: 1 maxItems: 100 ServiceUnavailableException: {} OrganizationalUnitArn: type: string pattern: ^arn:aws[^:]*:organizations::[0-9]{12}:ou/o-[a-z0-9]{10,32}/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32} DiskImageFormat: type: string enum: - VMDK - RAW - VHD DistributionConfiguration: type: object required: - timeoutMinutes properties: arn: allOf: - $ref: '#/components/schemas/ImageBuilderArn' - description: The Amazon Resource Name (ARN) of the distribution configuration. name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the distribution configuration. description: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The description of the distribution configuration. distributions: allOf: - $ref: '#/components/schemas/DistributionList' - description: The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions. timeoutMinutes: allOf: - $ref: '#/components/schemas/DistributionTimeoutMinutes' - description: The maximum duration in minutes for this distribution configuration. dateCreated: allOf: - $ref: '#/components/schemas/DateTime' - description: The date on which this distribution configuration was created. dateUpdated: allOf: - $ref: '#/components/schemas/DateTime' - description: The date on which this distribution configuration was last updated. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The tags of the distribution configuration. description: A distribution configuration. LaunchTemplateConfiguration: type: object required: - launchTemplateId properties: launchTemplateId: allOf: - $ref: '#/components/schemas/LaunchTemplateId' - description: Identifies the Amazon EC2 launch template to use. accountId: allOf: - $ref: '#/components/schemas/AccountId' - description: The account ID that this configuration applies to. setDefaultVersion: allOf: - $ref: '#/components/schemas/Boolean' - description: Set the specified Amazon EC2 launch template as the default launch template for the specified account. description: Identifies an Amazon EC2 launch template to use for a specific account. OrganizationalUnitArnList: type: array items: $ref: '#/components/schemas/OrganizationalUnitArn' minItems: 1 maxItems: 25 LaunchTemplateId: type: string pattern: ^lt-[a-z0-9-_]{17}$ DistributionTimeoutMinutes: type: integer minimum: 30 maximum: 720 FastLaunchConfiguration: type: object required: - enabled properties: enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it. snapshotConfiguration: allOf: - $ref: '#/components/schemas/FastLaunchSnapshotConfiguration' - description: Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled. maxParallelLaunches: allOf: - $ref: '#/components/schemas/MaxParallelLaunches' - description: The maximum number of parallel instances that are launched for creating resources. launchTemplate: allOf: - $ref: '#/components/schemas/FastLaunchLaunchTemplateSpecification' - description: The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots. accountId: allOf: - $ref: '#/components/schemas/AccountId' - description: The owner account ID for the fast-launch enabled Windows AMI. description: Define and configure faster launching for output Windows AMIs. MaxParallelLaunches: type: integer minimum: 1 maximum: 10000 ResourceName: type: string pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$ LaunchPermissionConfiguration: type: object properties: userIds: allOf: - $ref: '#/components/schemas/AccountList' - description: The Amazon Web Services account ID. userGroups: allOf: - $ref: '#/components/schemas/StringList' - description: The name of the group. organizationArns: allOf: - $ref: '#/components/schemas/OrganizationArnList' - description: The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?. organizationalUnitArns: allOf: - $ref: '#/components/schemas/OrganizationalUnitArnList' - description: The ARN for an Organizations organizational unit (OU) that you want to share your AMI with. For more information about key concepts for Organizations, see Organizations terminology and concepts. description: Describes the configuration for a launch permission. The launch permission modification request is sent to the Amazon EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to all. See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute. 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]+)?)?$ Boolean: type: boolean GetDistributionConfigurationResponse: type: object properties: requestId: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The request ID that uniquely identifies this request. distributionConfiguration: allOf: - $ref: '#/components/schemas/DistributionConfiguration' - description: The distribution configuration object. AccountList: type: array items: $ref: '#/components/schemas/AccountId' minItems: 1 maxItems: 1536 TagValue: type: string maxLength: 256 OrganizationArnList: type: array items: $ref: '#/components/schemas/OrganizationArn' minItems: 1 maxItems: 25 AccountId: type: string pattern: ^[0-9]{12}$ 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. DateTime: type: string ContainerRepositoryService: type: string enum: - ECR StringList: type: array items: $ref: '#/components/schemas/NonEmptyString' InvalidRequestException: {} FastLaunchConfigurationList: type: array items: $ref: '#/components/schemas/FastLaunchConfiguration' minItems: 1 maxItems: 1000 AmiNameString: type: string pattern: ^[-_A-Za-z0-9{][-_A-Za-z0-9\s:{}\.]+[-_A-Za-z0-9}]$ minLength: 1 maxLength: 127 TargetResourceCount: type: integer minimum: 1 maximum: 10000 ClientException: {} NonEmptyString: type: string minLength: 1 maxLength: 1024 S3ExportConfiguration: type: object required: - roleName - diskImageFormat - s3Bucket properties: roleName: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The name of the role that grants VM Import/Export permission to export images to your S3 bucket. diskImageFormat: allOf: - $ref: '#/components/schemas/DiskImageFormat' - description:

Export the updated image to one of the following supported disk image formats:

s3Bucket: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The S3 bucket in which to store the output disk images for your VM. s3Prefix: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The Amazon S3 path for the bucket where the output disk images for your VM are stored. description: Properties that configure export from your build instance to a compatible file format for your VM. FastLaunchSnapshotConfiguration: type: object properties: targetResourceCount: allOf: - $ref: '#/components/schemas/TargetResourceCount' - description: The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI. description: Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI. ForbiddenException: {} FastLaunchLaunchTemplateSpecification: type: object properties: launchTemplateId: allOf: - $ref: '#/components/schemas/LaunchTemplateId' - description: The ID of the launch template to use for faster launching for a Windows AMI. launchTemplateName: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The name of the launch template to use for faster launching for a Windows AMI. launchTemplateVersion: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The version of the launch template to use for faster launching for a Windows AMI. description:

Identifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled.

You can specify either the launchTemplateName or the launchTemplateId, but not both.

 LicenseConfigurationArn: type: string pattern: ^arn:aws[^:]*:license-manager:[^:]+:[0-9]{12}:license-configuration:lic-[a-z0-9-_]{32}$ Distribution: type: object required: - region properties: region: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The target Region. example: example-string amiDistributionConfiguration: allOf: - $ref: '#/components/schemas/AmiDistributionConfiguration' - description: The specific AMI settings; for example, launch permissions or AMI tags. example: example-id-1234 containerDistributionConfiguration: allOf: - $ref: '#/components/schemas/ContainerDistributionConfiguration' - description: Container distribution settings for encryption, licensing, and sharing in a specific Region. example: example-string licenseConfigurationArns: allOf: - $ref: '#/components/schemas/LicenseConfigurationArnList' - description: The License Manager Configuration to associate with the AMI in the specified Region. example: arn:aws:service:us-east-1:123456789012:resource/example launchTemplateConfigurations: allOf: - $ref: '#/components/schemas/LaunchTemplateConfigurationList' - description: A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts. example: example-string s3ExportConfiguration: allOf: - $ref: '#/components/schemas/S3ExportConfiguration' - description: Configure export settings to deliver disk images created from your image build, using a file format that is compatible with your VMs in that Region. example: example-string fastLaunchConfigurations: allOf: - $ref: '#/components/schemas/FastLaunchConfigurationList' - description: The Windows faster-launching configurations to use for AMI distribution. example: example-string description: Defines the settings for a specific Region. OrganizationArn: type: string pattern: ^arn:aws[^:]*:organizations::[0-9]{12}:organization/o-[a-z0-9]{10,32}$ TagMap: type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' DistributionList: type: array items: $ref: '#/components/schemas/Distribution' ServiceException: {} AmiDistributionConfiguration: type: object properties: name: allOf: - $ref: '#/components/schemas/AmiNameString' - description: The name of the output AMI. description: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The description of the AMI distribution configuration. Minimum and maximum length are in characters. targetAccountIds: allOf: - $ref: '#/components/schemas/AccountList' - description: The ID of an account to which you want to distribute an image. amiTags: allOf: - $ref: '#/components/schemas/TagMap' - description: The tags to apply to AMIs distributed to this Region. kmsKeyId: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The KMS key identifier used to encrypt the distributed image. launchPermission: allOf: - $ref: '#/components/schemas/LaunchPermissionConfiguration' - description: Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances. description: Define and configure the output AMIs of the pipeline. ContainerDistributionConfiguration: type: object required: - targetRepository properties: description: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The description of the container distribution configuration. containerTags: allOf: - $ref: '#/components/schemas/StringList' - description: Tags that are attached to the container distribution configuration. targetRepository: allOf: - $ref: '#/components/schemas/TargetContainerRepository' - description: The destination repository for the container distribution configuration. description: Container distribution settings for encryption, licensing, and sharing in a specific Region. parameters: X-Amz-Signature: name: X-Amz-Signature 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-Credential: name: X-Amz-Credential 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-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 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