{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.imagebuilder#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

You do not have permissions to perform the requested operation.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.imagebuilder#AccountAggregation": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Identifies the account that owns the aggregated resource findings.

" } }, "severityCounts": { "target": "com.amazonaws.imagebuilder#SeverityCounts", "traits": { "smithy.api#documentation": "

Counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings.

" } } }, "traits": { "smithy.api#documentation": "

Contains counts of vulnerability findings from image scans that run when you create\n\t\t\tnew Image Builder images, or build new versions of existing images. The vulnerability counts are\n\t\t\tgrouped by severity level. The counts are aggregated across resources to create the\n\t\t\tfinal tally for the account that owns them.

" } }, "com.amazonaws.imagebuilder#AccountId": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.imagebuilder#AccountList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#AccountId" }, "traits": { "smithy.api#length": { "min": 1, "max": 1536 } } }, "com.amazonaws.imagebuilder#AdditionalInstanceConfiguration": { "type": "structure", "members": { "systemsManagerAgent": { "target": "com.amazonaws.imagebuilder#SystemsManagerAgent", "traits": { "smithy.api#documentation": "

The Systems Manager agent settings for your build instance. This setting\n\t\t\tapplies to Linux and macOS build instances only. Requests that set it for a\n\t\t\trecipe with a Windows base image are rejected.

" } }, "userDataOverride": { "target": "com.amazonaws.imagebuilder#UserDataOverride", "traits": { "smithy.api#documentation": "

Use this property to provide commands or a command script to run when you launch your\n\t\t\tbuild instance.

\n

The userDataOverride property replaces any commands that Image Builder might have added to\n\t\t\tensure that Systems Manager is installed on your Linux build instance. If you override the user\n\t\t\tdata, make sure that you add commands to install Systems Manager, if it is not pre-installed on\n\t\t\tyour base image.

\n \n

The user data is always base 64 encoded. For example, the following commands are\n\t\t\t\tencoded as\n\t\t\t\tIyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg==:

\n

\n #!/bin/bash\n

\n

mkdir -p /var/bb/

\n

touch /var

\n
" } } }, "traits": { "smithy.api#documentation": "

In addition to your infrastructure configuration, these settings provide an extra\n\t\t\tlayer of control over your build instances. You can also specify commands to run on\n\t\t\tlaunch for all of your build instances.

\n

Image Builder does not automatically install the Systems Manager agent on Windows instances. If your base\n\t\t\timage includes the Systems Manager agent, then the AMI that you create will also include the\n\t\t\tagent. For Linux instances, if the base image does not already include the Systems Manager agent,\n\t\t\tImage Builder installs it. For Linux instances where Image Builder installs the Systems Manager agent, you can\n\t\t\tchoose whether to keep it for the AMI that you create.

" } }, "com.amazonaws.imagebuilder#Ami": { "type": "structure", "members": { "region": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region of the Amazon EC2 AMI.

" } }, "image": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The AMI ID of the Amazon EC2 AMI.

" } }, "name": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the Amazon EC2 AMI.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.

" } }, "state": { "target": "com.amazonaws.imagebuilder#ImageState", "traits": { "smithy.api#documentation": "

The state of the AMI, which includes the status and, if applicable,\n\t\t\tthe reason for that status.

" } }, "accountId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The account ID of the owner of the AMI.

" } } }, "traits": { "smithy.api#documentation": "

Details of an Amazon EC2 AMI.

" } }, "com.amazonaws.imagebuilder#AmiDistributionConfiguration": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#AmiNameString", "traits": { "smithy.api#documentation": "

The name of the output AMI. The name must include the\n\t\t\t{{ imagebuilder:buildDate }} dynamic tag so that each build\n\t\t\tproduces a uniquely named AMI. If you don't specify a name, Image Builder\n\t\t\tnames the output AMI with the image name followed by the build timestamp,\n\t\t\tfor example my-image 2022-10-26T22-30-05.912619Z.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description to apply to the distributed AMI. Image Builder sets this as the\n\t\t\toutput AMI's description in each target Region and account. If you\n\t\t\tdon't specify a description, the AMI in the build Region uses the\n\t\t\timage recipe's description, if the recipe has one. Copies distributed\n\t\t\tto other Regions and accounts don't receive a default\n\t\t\tdescription.

" } }, "targetAccountIds": { "target": "com.amazonaws.imagebuilder#AccountList", "traits": { "smithy.api#documentation": "

The Amazon Web Services account IDs to distribute the AMI to in this Region. Each listed\n\t\t\taccount receives its own copy of the output AMI. If you don't specify\n\t\t\taccounts, Image Builder distributes the AMI only to your own account.

" } }, "amiTags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags to apply to AMIs distributed to this Region.

" } }, "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt the distributed image. \n\t\t\tThis can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide.

" } }, "launchPermission": { "target": "com.amazonaws.imagebuilder#LaunchPermissionConfiguration", "traits": { "smithy.api#documentation": "

Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to\n\t\t\tlaunch instances.

" } } }, "traits": { "smithy.api#documentation": "

Define and configure the output AMIs of the pipeline.

" } }, "com.amazonaws.imagebuilder#AmiList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#Ami" } }, "com.amazonaws.imagebuilder#AmiNameString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 127 }, "smithy.api#pattern": "^[-_A-Za-z0-9{][-_A-Za-z0-9\\s:{}\\.]+[-_A-Za-z0-9}]$" } }, "com.amazonaws.imagebuilder#AmiWatermarkName": { "type": "string", "traits": { "smithy.api#documentation": "

The name of an AMI watermark. AMI watermarks are lineage markers that\n\t\t\tImage Builder attaches to output AMIs during the build process. AMI watermarks\n\t\t\tautomatically propagate to derivative AMIs when the source AMI is\n\t\t\tcopied or distributed.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[A-Za-z0-9()\\[\\]./'@_\\-][A-Za-z0-9 ()\\[\\]./'@_\\-]{1,126}[A-Za-z0-9()\\[\\]./'@_\\-]$" } }, "com.amazonaws.imagebuilder#AmiWatermarksList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#AmiWatermarkName" }, "traits": { "smithy.api#documentation": "

A list of AMI watermark names to attach to the output AMI. Names are\n\t\t\tcase-sensitive. The recipe does not allow duplicate names.

", "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.imagebuilder#Arn": { "type": "string" }, "com.amazonaws.imagebuilder#AutoDisableFailureCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 10 } } }, "com.amazonaws.imagebuilder#AutoDisablePolicy": { "type": "structure", "members": { "failureCount": { "target": "com.amazonaws.imagebuilder#AutoDisableFailureCount", "traits": { "smithy.api#documentation": "

The number of consecutive scheduled image pipeline executions that must fail before Image Builder \n\t\t\tautomatically disables the pipeline.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines the rules by which an image pipeline is automatically disabled when\n\t\t\tit fails. By default, if the schedule doesn't include an auto-disable\n\t\t\tpolicy, Image Builder disables the pipeline after 5 consecutive failed scheduled\n\t\t\tbuilds.

" } }, "com.amazonaws.imagebuilder#AutoScalingGroupConfiguration": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the Auto Scaling group, in the same account and Amazon Web Services Region as the\n\t\t\tinfrastructure configuration. To specify a group, you must have permissions to describe\n\t\t\tit.

", "smithy.api#required": {} } }, "capacityWaitTimeoutSeconds": { "target": "com.amazonaws.imagebuilder#CapacityWaitTimeoutSeconds", "traits": { "smithy.api#documentation": "

The number of seconds that Image Builder waits for an instance to become available in the\n\t\t\tgroup before the build fails. If you set this value to 0 or omit it, the build fails as\n\t\t\tsoon as the group has no instance available.

" } } }, "traits": { "smithy.api#documentation": "

Identifies the Amazon EC2 Auto Scaling group that Image Builder takes the build instance from,\n\t\t\tand how long Image Builder waits when the group has no instance available.

" } }, "com.amazonaws.imagebuilder#Boolean": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.imagebuilder#BuildType": { "type": "enum", "members": { "USER_INITIATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USER_INITIATED" } }, "SCHEDULED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SCHEDULED" } }, "IMPORT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPORT" } }, "IMPORT_ISO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPORT_ISO" } } } }, "com.amazonaws.imagebuilder#CallRateLimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder\n\t\t\tcalls on your behalf. Retry with an increasing or variable delay between\n\t\t\trequests.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.imagebuilder#CancelImageCreation": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#CancelImageCreationRequest" }, "output": { "target": "com.amazonaws.imagebuilder#CancelImageCreationResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Cancels the creation of an image. This operation can only be used on\n\t\t\timages in a non-terminal state. Cancellation is asynchronous: the request\n\t\t\treturns immediately, then Image Builder stops the running build and moves the image\n\t\t\tto the CANCELLED state. Output resources that the build already\n\t\t\tcreated, such as AMIs and snapshots, aren't removed.

", "smithy.api#examples": [ { "title": "Cancel an image build", "documentation": "The following example cancels a build that is in progress for the specified image build version.", "input": { "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE77777" }, "output": { "requestId": "fead325f-72d9-42b5-b2ed-c5294984c6a9", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE77777", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" } } ], "smithy.api#http": { "method": "PUT", "uri": "/CancelImageCreation", "code": 200 } } }, "com.amazonaws.imagebuilder#CancelImageCreationRequest": { "type": "structure", "members": { "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that you want to cancel creation\n\t\t\tfor.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#CancelImageCreationResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image whose creation this request canceled.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#CancelLifecycleExecution": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#CancelLifecycleExecutionRequest" }, "output": { "target": "com.amazonaws.imagebuilder#CancelLifecycleExecutionResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Cancels a lifecycle execution \u2013 a single run of lifecycle actions that a\n\t\t\tlifecycle policy or a StartResourceStateUpdate request\n\t\t\tstarted. You can only cancel an execution that hasn't reached a\n\t\t\tterminal state. Cancellation is asynchronous and doesn't undo\n\t\t\tcompleted lifecycle actions.

", "smithy.api#examples": [ { "title": "Cancel a lifecycle execution", "documentation": "The following example cancels the scheduled resource state update associated with the specified lifecycle execution ID before it runs.", "input": { "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE97531" }, "output": { "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503" } } ], "smithy.api#http": { "method": "PUT", "uri": "/CancelLifecycleExecution", "code": 200 } } }, "com.amazonaws.imagebuilder#CancelLifecycleExecutionRequest": { "type": "structure", "members": { "lifecycleExecutionId": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", "traits": { "smithy.api#documentation": "

Identifies the specific runtime instance of the image lifecycle to cancel.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#CancelLifecycleExecutionResponse": { "type": "structure", "members": { "lifecycleExecutionId": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", "traits": { "smithy.api#documentation": "

The unique identifier of the lifecycle execution that the cancellation\n\t\t\trequest applies to. The cancellation completes asynchronously.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#CapacityWaitTimeoutSeconds": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 3600 } } }, "com.amazonaws.imagebuilder#ClientException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

A generic client error. This error usually indicates that the request\n\t\t\tfailed a validation check, such as when a downstream service rejects a\n\t\t\tconfigured value.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.imagebuilder#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.imagebuilder#Component": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the component.

" } }, "version": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { "smithy.api#documentation": "

The version of the component.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the component.

" } }, "changeDescription": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Describes what change has been made in this version of the component, \n\t\t\tor what makes this version different from other versions of the component.

" } }, "type": { "target": "com.amazonaws.imagebuilder#ComponentType", "traits": { "smithy.api#documentation": "

The component type specifies whether Image Builder uses the component to build the image or\n\t\t\tonly to test it.

" } }, "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

The operating system platform of the component.

" } }, "supportedOsVersions": { "target": "com.amazonaws.imagebuilder#OsVersionList", "traits": { "smithy.api#documentation": "

The operating system (OS) version supported by the component. If the OS information is\n\t\t\tavailable, Image Builder performs a prefix match against the base image OS version during image\n\t\t\trecipe creation.

" } }, "state": { "target": "com.amazonaws.imagebuilder#ComponentState", "traits": { "smithy.api#documentation": "

Describes the current status of the component.

" } }, "parameters": { "target": "com.amazonaws.imagebuilder#ComponentParameterDetailList", "traits": { "smithy.api#documentation": "

Contains parameter details for each of the parameters that the component document \n\t\t\tdefined for the component.

" } }, "owner": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The owner of the component. The value is your account ID for components\n\t\t\tthat you own, the sharing account's ID for shared components, or\n\t\t\tAmazon, ThirdParty, or AWSMarketplace.

" } }, "data": { "target": "com.amazonaws.imagebuilder#ComponentData", "traits": { "smithy.api#documentation": "

Component data contains the YAML document content for the component.

" } }, "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The KMS key identifier used to encrypt the component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide.

" } }, "encrypted": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Indicates whether the component data is encrypted at rest. Image Builder encrypts\n\t\t\tall component data at rest, so this value is always true. This\n\t\t\tfield is retained for backward compatibility.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date that Image Builder created the component.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags that apply to the component.

" } }, "publisher": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Contains the name of the publisher if this is a third-party component. Otherwise, \n\t\t\tthis property is empty.

" } }, "obfuscate": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether component source is hidden from view in the console, and from \n\t\t\tcomponent detail results for API, CLI, or SDK operations.

" } }, "productCodes": { "target": "com.amazonaws.imagebuilder#ProductCodeList", "traits": { "smithy.api#documentation": "

Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components.

" } } }, "traits": { "smithy.api#documentation": "

A detailed view of a component.

" } }, "com.amazonaws.imagebuilder#ComponentBuildVersionArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):component/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" } }, "com.amazonaws.imagebuilder#ComponentConfiguration": { "type": "structure", "members": { "componentArn": { "target": "com.amazonaws.imagebuilder#ComponentVersionArnOrBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component. You can specify a build version ARN, or a\n\t\t\tcomponent version ARN whose version segments can use x\n\t\t\twildcards, for example 1.x.x.

", "smithy.api#required": {} } }, "parameters": { "target": "com.amazonaws.imagebuilder#ComponentParameterList", "traits": { "smithy.api#documentation": "

A group of parameter settings that Image Builder uses to configure the component for\n\t\t\ta specific recipe. You must supply a value for every component parameter\n\t\t\tthat has no default value, and you can only supply parameters that the\n\t\t\tcomponent defines.

" } } }, "traits": { "smithy.api#documentation": "

Configuration details of the component. You can specify each component only\n\t\t\tonce in a recipe, regardless of version. Components with a status of\n\t\t\tDEPRECATED or DISABLED can't be added to new\n\t\t\trecipes.

" } }, "com.amazonaws.imagebuilder#ComponentConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ComponentConfiguration" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.imagebuilder#ComponentData": { "type": "string" }, "com.amazonaws.imagebuilder#ComponentFailureContext": { "type": "structure", "members": { "componentArn": { "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component build version that failed.

" } }, "phaseName": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the phase in the component document where the failure occurred, such\n\t\t\tas build, validate, or test.

" } }, "stepName": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the step in the component document that failed.

" } }, "action": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The action that the failed step runs, for example ExecuteBash.

" } }, "errorMessage": { "target": "com.amazonaws.imagebuilder#NonEmptyMaxLengthString", "traits": { "smithy.api#documentation": "

The error message from the step that failed. Image Builder truncates messages that are\n\t\t\tlonger than 1024 characters. The component log in Amazon CloudWatch Logs contains\n\t\t\tthe full output.

" } } }, "traits": { "smithy.api#documentation": "

Contains details about the component that caused the image creation process to\n\t\t\tfail. The details identify the first step that failed when the component ran.

" } }, "com.amazonaws.imagebuilder#ComponentFormat": { "type": "enum", "members": { "SHELL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHELL" } } } }, "com.amazonaws.imagebuilder#ComponentParameter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#ComponentParameterName", "traits": { "smithy.api#documentation": "

The name of the component parameter to set.

", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.imagebuilder#ComponentParameterValueList", "traits": { "smithy.api#documentation": "

Sets the value for the named component parameter.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains a key/value pair that sets the named component parameter.

" } }, "com.amazonaws.imagebuilder#ComponentParameterDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[^\\x00]+$" } }, "com.amazonaws.imagebuilder#ComponentParameterDetail": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#ComponentParameterName", "traits": { "smithy.api#documentation": "

The name of this input parameter.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.imagebuilder#ComponentParameterType", "traits": { "smithy.api#documentation": "

The type of input this parameter provides. The currently supported value is\n\t\t\t\"string\".

", "smithy.api#required": {} } }, "defaultValue": { "target": "com.amazonaws.imagebuilder#ComponentParameterValueList", "traits": { "smithy.api#documentation": "

The default value of this parameter if no input is provided.

" } }, "description": { "target": "com.amazonaws.imagebuilder#ComponentParameterDescription", "traits": { "smithy.api#documentation": "

Describes this parameter.

" } } }, "traits": { "smithy.api#documentation": "

Defines a parameter that is used to provide configuration details for the\n\t\t\tcomponent.

" } }, "com.amazonaws.imagebuilder#ComponentParameterDetailList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ComponentParameterDetail" } }, "com.amazonaws.imagebuilder#ComponentParameterList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ComponentParameter" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.imagebuilder#ComponentParameterName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[^\\x00]+$" } }, "com.amazonaws.imagebuilder#ComponentParameterType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 }, "smithy.api#pattern": "^String|Integer|Boolean|StringList$" } }, "com.amazonaws.imagebuilder#ComponentParameterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0 }, "smithy.api#pattern": "^[^\\x00]*$" } }, "com.amazonaws.imagebuilder#ComponentParameterValueList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ComponentParameterValue" } }, "com.amazonaws.imagebuilder#ComponentState": { "type": "structure", "members": { "status": { "target": "com.amazonaws.imagebuilder#ComponentStatus", "traits": { "smithy.api#documentation": "

The current state of the component. Components with a status of\n\t\t\tDEPRECATED or DISABLED can't be added to new\n\t\t\trecipes.

" } }, "reason": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Describes how or why the component changed state.

" } } }, "traits": { "smithy.api#documentation": "

A group of fields that describe the current status of components.

" } }, "com.amazonaws.imagebuilder#ComponentStatus": { "type": "enum", "members": { "DEPRECATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPRECATED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } } } }, "com.amazonaws.imagebuilder#ComponentSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the component.

" } }, "version": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { "smithy.api#documentation": "

The version of the component.

" } }, "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

The operating system platform of the component.

" } }, "supportedOsVersions": { "target": "com.amazonaws.imagebuilder#OsVersionList", "traits": { "smithy.api#documentation": "

The operating system (OS) version that the component supports. If the OS information\n\t\t\tis available, Image Builder performs a prefix match against the base image OS version during\n\t\t\timage recipe creation.

" } }, "state": { "target": "com.amazonaws.imagebuilder#ComponentState", "traits": { "smithy.api#documentation": "

Describes the current status of the component.

" } }, "type": { "target": "com.amazonaws.imagebuilder#ComponentType", "traits": { "smithy.api#documentation": "

The component type specifies whether Image Builder uses the component to build the image or\n\t\t\tonly to test it.

" } }, "owner": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The owner of the component. The value is your account ID for components\n\t\t\tthat you own, the sharing account's ID for shared components, or\n\t\t\tAmazon, ThirdParty, or AWSMarketplace.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the component.

" } }, "changeDescription": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The change description for this version of the component.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date that Image Builder created this version of the component.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags that apply to the component.

" } }, "publisher": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Contains the name of the publisher if this is a third-party component. Otherwise, \n\t\t\tthis property is empty.

" } }, "obfuscate": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether component source is hidden from view in the console, and from \n\t\t\tcomponent detail results for API, CLI, or SDK operations.

" } } }, "traits": { "smithy.api#documentation": "

A high-level summary of a component.

" } }, "com.amazonaws.imagebuilder#ComponentSummaryList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ComponentSummary" } }, "com.amazonaws.imagebuilder#ComponentType": { "type": "enum", "members": { "BUILD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BUILD" } }, "TEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEST" } } } }, "com.amazonaws.imagebuilder#ComponentVersion": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

\n \n

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

\n
    \n
  1. \n

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

    \n
  2. \n
  3. \n

    Version ARNs have only the first three nodes: ..

    \n
  4. \n
  5. \n

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

    \n
  6. \n
\n
" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the component.

" } }, "version": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { "smithy.api#documentation": "

The semantic version of the component.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes, you can assign any positive integer value, including \n\tzero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

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

\n

\n Filtering: You can use wildcards (x) to specify the most recent versions or nodes when \n\tselecting the base image or components for your recipe. When you use a wildcard in any node, all nodes \n\tto the right of the first wildcard must also be wildcards.

\n
" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the component.

" } }, "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

The platform of the component.

" } }, "supportedOsVersions": { "target": "com.amazonaws.imagebuilder#OsVersionList", "traits": { "smithy.api#documentation": "

The operating system (OS) version supported by the component. If OS information is\n\t\t\tavailable, Image Builder performs a prefix match against the base image OS version during image\n\t\t\trecipe creation.

" } }, "type": { "target": "com.amazonaws.imagebuilder#ComponentType", "traits": { "smithy.api#documentation": "

The type of the component denotes whether the component is used to build the image or\n\t\t\tonly to test it.

" } }, "owner": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The owner of the component. The value is your account ID for components\n\t\t\tthat you own, the sharing account's ID for shared components, or\n\t\t\tAmazon, ThirdParty, or AWSMarketplace.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date that the component was created.

" } }, "status": { "target": "com.amazonaws.imagebuilder#ComponentStatus", "traits": { "smithy.api#documentation": "

Describes the current status of the component version.

" } }, "productCodes": { "target": "com.amazonaws.imagebuilder#ProductCodeList", "traits": { "smithy.api#documentation": "

Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components.

" } } }, "traits": { "smithy.api#documentation": "

The defining characteristics of a specific version of a component.

" } }, "com.amazonaws.imagebuilder#ComponentVersionArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):component/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" } }, "com.amazonaws.imagebuilder#ComponentVersionArnOrBuildVersionArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$" } }, "com.amazonaws.imagebuilder#ComponentVersionList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ComponentVersion" } }, "com.amazonaws.imagebuilder#ConsecutiveFailures": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.imagebuilder#Container": { "type": "structure", "members": { "region": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Containers and container images are Region-specific. This is the Region context for\n\t\t\tthe container.

" } }, "imageUris": { "target": "com.amazonaws.imagebuilder#StringList", "traits": { "smithy.api#documentation": "

A list of URIs for containers created in the context Region.

" } } }, "traits": { "smithy.api#documentation": "

Details of the container images that are output resources of an image build\n\t\t\tin a given Amazon Web Services Region: the Region, and the URIs of the container\n\t\t\timages.

" } }, "com.amazonaws.imagebuilder#ContainerDistributionConfiguration": { "type": "structure", "members": { "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the container distribution configuration.

" } }, "containerTags": { "target": "com.amazonaws.imagebuilder#StringList", "traits": { "smithy.api#documentation": "

Tags that Image Builder applies to the distributed container image in the target\n\t\t\trepository. These are repository image tags, not resource tags.

" } }, "targetRepository": { "target": "com.amazonaws.imagebuilder#TargetContainerRepository", "traits": { "smithy.api#documentation": "

The destination repository for the container distribution configuration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines how the output container image is distributed in a specific\n\t\t\tAmazon Web Services Region: the target repository, the image tags to apply to the\n\t\t\tdistributed image, and an optional description.

" } }, "com.amazonaws.imagebuilder#ContainerList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#Container" } }, "com.amazonaws.imagebuilder#ContainerRecipe": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

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

\n \n

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

\n
    \n
  1. \n

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

    \n
  2. \n
  3. \n

    Version ARNs have only the first three nodes: ..

    \n
  4. \n
  5. \n

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

    \n
  6. \n
\n
" } }, "containerType": { "target": "com.amazonaws.imagebuilder#ContainerType", "traits": { "smithy.api#documentation": "

Specifies the type of container, such as Docker.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the container recipe.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the container recipe.

" } }, "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

The system platform for the container. Container recipes support only the\n\t\t\tLinux and Windows platforms.

" } }, "owner": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The owner of the container recipe.

" } }, "version": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { "smithy.api#documentation": "

The semantic version of the container recipe.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes, you can assign any positive integer value, including \n\tzero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

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

\n

\n Filtering: You can use wildcards (x) to specify the most recent versions or nodes when \n\tselecting the base image or components for your recipe. When you use a wildcard in any node, all nodes \n\tto the right of the first wildcard must also be wildcards.

\n
" } }, "components": { "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", "traits": { "smithy.api#documentation": "

Build and test components that are included in the container recipe.\n\t\t\tA recipe can contain a maximum of 20 build and test components\n\t\t\tin any combination, by default. This maximum is an adjustable quota. For more information, see\n\t\t\tEC2 Image Builder endpoints and quotas\n\t\t\tin the Amazon Web Services General Reference.

" } }, "instanceConfiguration": { "target": "com.amazonaws.imagebuilder#InstanceConfiguration", "traits": { "smithy.api#documentation": "

A group of options that can be used to configure an instance for building and testing\n\t\t\tcontainer images.

" } }, "dockerfileTemplateData": { "target": "com.amazonaws.imagebuilder#DockerFileTemplate", "traits": { "smithy.api#documentation": "

The Dockerfile template that Image Builder uses to build the container image. The\n\t\t\ttemplate can include contextual variables that Image Builder replaces with build\n\t\t\tinformation at build time. For the contextual variables that the template\n\t\t\tcan include, see Create\n\t\t\t\ta new version of a container recipe in the\n\t\t\tEC2 Image Builder User Guide.

" } }, "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The KMS key that Image Builder uses to encrypt the recipe's Dockerfile template\n\t\t\tdata at rest. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide. If you don't specify a key, Image Builder\n\t\t\tencrypts the template data with a KMS key that Image Builder owns. This key\n\t\t\tisn't used to encrypt the output container image.

" } }, "encrypted": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether the recipe's Dockerfile template data is encrypted at\n\t\t\trest. Image Builder encrypts all Dockerfile template data at rest, so this value is\n\t\t\talways true. This field is retained for backward compatibility,\n\t\t\tand doesn't describe encryption of the output container image.

" } }, "parentImage": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The base image for customizations specified in the container recipe. This can \n\t\t\tcontain an Image Builder image resource ARN or a container image URI, for example \n\t\t\tamazonlinux:latest.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date when this container recipe was created.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

Tags that are attached to the container recipe.

" } }, "workingDirectory": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The working directory for use during build and test workflows.

" } }, "targetRepository": { "target": "com.amazonaws.imagebuilder#TargetContainerRepository", "traits": { "smithy.api#documentation": "

The destination repository for the container image.

" } } }, "traits": { "smithy.api#documentation": "

Defines how Image Builder builds and tests a container image: the base image,\n\t\t\tcomponents to apply, the Dockerfile template, the build and test instance\n\t\t\tconfiguration, and the target repository for the output image.

" } }, "com.amazonaws.imagebuilder#ContainerRecipeArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):container-recipe/[a-z0-9-_]+/(?:[0-9]+|x)\\.(?:[0-9]+|x)\\.(?:[0-9]+|x)$" } }, "com.amazonaws.imagebuilder#ContainerRecipeSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

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

" } }, "containerType": { "target": "com.amazonaws.imagebuilder#ContainerType", "traits": { "smithy.api#documentation": "

Specifies the type of container, such as \"Docker\".

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the container recipe.

" } }, "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

The system platform for the container. Container recipes support only the\n\t\t\tLinux and Windows platforms.

" } }, "owner": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The owner of the container recipe.

" } }, "parentImage": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The base image for the container recipe.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date when this container recipe was created.

" } }, "instanceImage": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The base image for a container build and test instance. This can contain an AMI ID \n\t\tor it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, \n\t\tfollowed by the parameter name or ARN.

\n

If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

Tags that are attached to the container recipe.

" } } }, "traits": { "smithy.api#documentation": "

A summary of a container recipe.

" } }, "com.amazonaws.imagebuilder#ContainerRecipeSummaryList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ContainerRecipeSummary" } }, "com.amazonaws.imagebuilder#ContainerRepositoryService": { "type": "enum", "members": { "ECR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ECR" } } } }, "com.amazonaws.imagebuilder#ContainerType": { "type": "enum", "members": { "DOCKER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DOCKER" } } } }, "com.amazonaws.imagebuilder#CreateComponent": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#CreateComponentRequest" }, "output": { "target": "com.amazonaws.imagebuilder#CreateComponentResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#DryRunOperationException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#InvalidVersionNumberException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a new component that can be used to build, validate, test, and assess your\n\t\t\timage. The component is based on a YAML document that you specify using exactly one of\n\t\t\tthe following methods:

\n \n

Image Builder determines the component type from the document. If the document\n\t\t\tcontains a single phase named test, the component type is\n\t\t\tTEST. Otherwise, the component type is BUILD.

", "smithy.api#examples": [ { "title": "Create a component from a document stored in Amazon S3", "documentation": "The following example creates a component from a YAML definition document that's stored in an Amazon S3 bucket. The definition document for this component includes an AppVersion parameter that recipes can set when they include the component.", "input": { "name": "my-example-parameterized-component", "semanticVersion": "1.0.0", "description": "Installs a configurable version of my application", "platform": "Linux", "uri": "s3://amzn-s3-demo-bucket/components/install-my-app.yaml", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE10101" }, "output": { "requestId": "0cec8e32-a5c6-4aeb-ac3a-6471c8a2a8a9", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE10101", "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/1.0.0/1", "latestVersionReferences": { "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/x.x.x", "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/1.0.0" } } }, { "title": "Create a component from an inline document", "documentation": "The following example creates a build component from a YAML document provided inline in the request.", "input": { "name": "my-example-component", "semanticVersion": "1.0.0", "description": "Installs the latest version of my application", "platform": "Linux", "data": "name: InstallMyApp\ndescription: Installs my application\nschemaVersion: 1.0\nphases:\n - name: build\n steps:\n - name: InstallApp\n action: ExecuteBash\n inputs:\n commands:\n - sudo yum -y install my-app\n", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "output": { "requestId": "e769f240-fb6a-4253-88d1-20a80cbe787d", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1", "latestVersionReferences": { "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/x.x.x", "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0" } } } ], "smithy.api#http": { "method": "PUT", "uri": "/CreateComponent", "code": 200 } } }, "com.amazonaws.imagebuilder#CreateComponentRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the component. Image Builder generates the component ARN from a\n\t\t\tnormalized form of the name, so names that differ only in case, spaces, or\n\t\t\tunderscores count as the same name. If a component with the same name and\n\t\t\tsemantic version already exists in your account in the same Amazon Web Services Region,\n\t\t\tthe request creates a new build version for it. If the content is also\n\t\t\tidentical to the latest build version, the request fails because the\n\t\t\tcomponent already exists.

", "smithy.api#required": {} } }, "semanticVersion": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { "smithy.api#documentation": "

The semantic version of the component. This version follows the semantic version\n\t\t\tsyntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes, you can assign any positive integer value, including \n\tzero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

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

\n
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Describes the contents of the component.

" } }, "changeDescription": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The change description of the component. Describes what change has been made in this\n\t\t\tversion, or what makes this version different from other versions of the\n\t\t\tcomponent.

" } }, "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

The operating system platform of the component.

", "smithy.api#required": {} } }, "supportedOsVersions": { "target": "com.amazonaws.imagebuilder#OsVersionList", "traits": { "smithy.api#documentation": "

The operating system (OS) version supported by the component. If the OS information is\n\t\t\tavailable, a prefix match is performed against the base image OS version during image\n\t\t\trecipe creation.

" } }, "data": { "target": "com.amazonaws.imagebuilder#InlineComponentData", "traits": { "smithy.api#documentation": "

Component data contains inline YAML document content for the component.\n\t\t\tAlternatively, you can specify the uri of a YAML document file stored in\n\t\t\tAmazon S3. However, you cannot specify both properties.

" } }, "uri": { "target": "com.amazonaws.imagebuilder#Uri", "traits": { "smithy.api#documentation": "

The uri of a YAML component document file. This must be an S3 URL\n\t\t\t\t(s3://bucket/key), and you must have permission to access the\n\t\t\tS3 bucket it points to. If you use Amazon S3, you can specify component content up to your\n\t\t\tservice quota for component size, which is 64 KB by default.

\n

Alternatively, you can specify the YAML document inline, using the component\n\t\t\t\tdata property. You cannot specify both properties.

" } }, "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component.\n\t\t\tThis can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide. If you don't specify a key, Image Builder encrypts the\n\t\t\tcomponent data with a KMS key that Image Builder owns.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags that apply to the component.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "dryRun": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#CreateComponentResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "componentBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that the request created.

" } }, "latestVersionReferences": { "target": "com.amazonaws.imagebuilder#LatestVersionReferences", "traits": { "smithy.api#documentation": "

A set of wildcard version ARNs that always reference the latest\n\t\t\tversion of the resource. ARNs are included for the latest version overall, and for the latest\n\t\t\tversions within the same major, minor, and patch levels.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#CreateContainerRecipe": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#CreateContainerRecipeRequest" }, "output": { "target": "com.amazonaws.imagebuilder#CreateContainerRecipeResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#DryRunOperationException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#InvalidVersionNumberException" }, { "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a new container recipe. Container recipes define how images are configured,\n\t\t\ttested, and assessed.

", "smithy.api#examples": [ { "title": "Create a container recipe with a custom build instance configuration", "documentation": "The following example creates a container recipe that customizes the Amazon EC2 instance that builds the container image. The build instance launches from an Amazon ECS-optimized instance image and uses a 40 GiB gp3 volume.", "input": { "containerType": "DOCKER", "name": "my-example-container-recipe", "semanticVersion": "1.1.0", "description": "A container recipe that builds on an ECS-optimized instance image with a larger build volume", "parentImage": "amazonlinux:latest", "components": [ { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-container-component/1.0.0/1" } ], "instanceConfiguration": { "image": "ami-1234567890abcdef0", "blockDeviceMappings": [ { "deviceName": "/dev/xvda", "ebs": { "volumeSize": 40, "volumeType": "gp3", "deleteOnTermination": true } } ] }, "dockerfileTemplateData": "FROM {{{ imagebuilder:parentImage }}}\n{{{ imagebuilder:environments }}}\n{{{ imagebuilder:components }}}\n", "targetRepository": { "service": "ECR", "repositoryName": "my-example-container-repo" }, "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE40404" }, "output": { "requestId": "4b6fc7f3-5b6b-4086-858e-22d4c7f9a37f", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE40404", "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.1.0", "latestVersionReferences": { "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/x.x.x", "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.1.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.1.0" } } }, { "title": "Create a container recipe with an inline Dockerfile template", "documentation": "The following example creates a Docker container recipe that applies one build component, using the latest Amazon Linux container image as the parent and an existing ECR repository as the target.", "input": { "containerType": "DOCKER", "name": "my-example-container-recipe", "semanticVersion": "1.0.0", "parentImage": "amazonlinux:latest", "components": [ { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-container-component/1.0.0/1" } ], "dockerfileTemplateData": "FROM {{{ imagebuilder:parentImage }}}\n{{{ imagebuilder:environments }}}\n{{{ imagebuilder:components }}}\n", "targetRepository": { "service": "ECR", "repositoryName": "my-example-container-repo" }, "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE99999" }, "output": { "requestId": "20b16948-45a4-4b3a-9a17-d54779847365", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE99999", "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0", "latestVersionReferences": { "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/x.x.x", "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0" } } } ], "smithy.api#http": { "method": "PUT", "uri": "/CreateContainerRecipe", "code": 200 } } }, "com.amazonaws.imagebuilder#CreateContainerRecipeRequest": { "type": "structure", "members": { "containerType": { "target": "com.amazonaws.imagebuilder#ContainerType", "traits": { "smithy.api#documentation": "

The type of container to create.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the container recipe. The recipe name, combined with the\n\t\t\tsemantic version, must be unique to your account in each Amazon Web Services Region.\n\t\t\tImage Builder generates the container recipe ARN from a normalized form of the\n\t\t\tname, so names that differ only in case, spaces, or underscores count as\n\t\t\tthe same name.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the container recipe.

" } }, "semanticVersion": { "target": "com.amazonaws.imagebuilder#WildcardVersionNumber", "traits": { "smithy.api#documentation": "

The semantic version of the container recipe. This version follows the semantic\n\t\t\tversion syntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes, you can assign any positive integer value, including \n\tzero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

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

\n
", "smithy.api#required": {} } }, "components": { "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", "traits": { "smithy.api#documentation": "

The components included in the container recipe. You can specify each\n\t\t\tcomponent only one time in a recipe.

" } }, "instanceConfiguration": { "target": "com.amazonaws.imagebuilder#InstanceConfiguration", "traits": { "smithy.api#documentation": "

A group of options that can be used to configure an instance for building and testing\n\t\t\tcontainer images.

" } }, "dockerfileTemplateData": { "target": "com.amazonaws.imagebuilder#InlineDockerFileTemplate", "traits": { "smithy.api#documentation": "

The Dockerfile template used to build your image, as an inline data blob.\n\t\t\tYou must specify exactly one of the dockerfileTemplateData or\n\t\t\tdockerfileTemplateUri properties. For the contextual variables\n\t\t\tthat the template can include, see Create\n\t\t\t\ta new version of a container recipe in the\n\t\t\tEC2 Image Builder User Guide.

" } }, "dockerfileTemplateUri": { "target": "com.amazonaws.imagebuilder#Uri", "traits": { "smithy.api#documentation": "

The Amazon S3 URI for the Dockerfile template that is used to build your container\n\t\t\timage. You must have permission to read the object. Image Builder reads the object\n\t\t\tonce, when it creates the recipe, and stores its content in the recipe.\n\t\t\tLater changes to the S3 object don't affect the recipe. You must specify\n\t\t\texactly one of the dockerfileTemplateData or\n\t\t\tdockerfileTemplateUri properties.

" } }, "platformOverride": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

Specifies the operating system platform when you use a custom base image.\n\t\t\tContainer recipes support only the Linux and Windows platforms.

" } }, "imageOsVersionOverride": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Specifies the operating system version for the base image. Use this property\n\t\t\tonly when the base image is a container image from a registry. When the base\n\t\t\timage is an Image Builder image, the operating system version comes from the parent\n\t\t\timage.

" } }, "parentImage": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The base image for the container recipe. This can be an Image Builder image resource\n\t\t\tARN or a container image URI from a registry, for example\n\t\t\tamazonlinux:latest.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

Tags that are attached to the container recipe.

" } }, "workingDirectory": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The working directory for use during build and test workflows.

" } }, "targetRepository": { "target": "com.amazonaws.imagebuilder#TargetContainerRepository", "traits": { "smithy.api#documentation": "

The destination repository for the container image. The Amazon ECR repository\n\t\t\tmust already exist in the Amazon Web Services Region where the build runs.

", "smithy.api#required": {} } }, "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the Dockerfile \n\t\t\ttemplate. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "dryRun": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#CreateContainerRecipeResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "containerRecipeArn": { "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", "traits": { "smithy.api#documentation": "

Returns the Amazon Resource Name (ARN) of the container recipe that the request\n\t\t\tcreated.

" } }, "latestVersionReferences": { "target": "com.amazonaws.imagebuilder#LatestVersionReferences", "traits": { "smithy.api#documentation": "

A set of wildcard version ARNs that always reference the latest\n\t\t\tversion of the resource. ARNs are included for the latest version overall, and for the latest\n\t\t\tversions within the same major, minor, and patch levels.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#CreateDistributionConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#CreateDistributionConfigurationRequest" }, "output": { "target": "com.amazonaws.imagebuilder#CreateDistributionConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#DryRunOperationException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a new distribution configuration. Distribution configurations define\n\t\t\tand configure the outputs for your images, including the target Regions,\n\t\t\taccounts, and settings for each Region.

", "smithy.api#examples": [ { "title": "Create a distribution configuration", "documentation": "The following example creates a distribution configuration that distributes the output AMI to two Regions. The AMI name includes the build date, so that repeated builds create unique AMI names.", "input": { "name": "my-example-distribution", "description": "Copies the output AMI to a second Region", "distributions": [ { "region": "us-west-2", "amiDistributionConfiguration": { "name": "my-example-image-{{ imagebuilder:buildDate }}" } }, { "region": "us-east-1", "amiDistributionConfiguration": { "name": "my-example-image-{{ imagebuilder:buildDate }}" } } ], "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444" }, "output": { "requestId": "ca5312ad-a273-4c8c-817e-042941a5762d", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution" } }, { "title": "Create a distribution configuration with launch permissions and a launch template update", "documentation": "The following example creates a distribution configuration that distributes the output AMI to two Regions. In us-east-1, it shares the AMI with another AWS account. In us-west-2, it sets the new AMI as the default version of your launch template.", "input": { "name": "my-example-distribution", "description": "Distributes the output AMI to two Regions and shares it with another account", "distributions": [ { "region": "us-west-2", "amiDistributionConfiguration": { "name": "my-example-image-{{ imagebuilder:buildDate }}" }, "launchTemplateConfigurations": [ { "launchTemplateId": "lt-1234567890abcdef0", "setDefaultVersion": true } ] }, { "region": "us-east-1", "amiDistributionConfiguration": { "name": "my-example-image-{{ imagebuilder:buildDate }}", "launchPermission": { "userIds": [ "444455556666" ] } } } ], "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE56789" }, "output": { "requestId": "13c97ae8-8e39-4e12-af78-25e70def0933", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE56789", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution" } } ], "smithy.api#http": { "method": "PUT", "uri": "/CreateDistributionConfiguration", "code": 200 } } }, "com.amazonaws.imagebuilder#CreateDistributionConfigurationRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution configuration. Distribution configuration\n\t\t\tnames must be unique to your account in each Amazon Web Services Region. Image Builder generates\n\t\t\tthe distribution configuration ARN from a normalized form of the name, so\n\t\t\tnames that differ only in case, spaces, or underscores count as the same\n\t\t\tname.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the distribution configuration.

" } }, "distributions": { "target": "com.amazonaws.imagebuilder#DistributionList", "traits": { "smithy.api#documentation": "

The distribution settings for the configuration. Each entry defines how\n\t\t\toutput images are distributed in one target Amazon Web Services Region. A Region can\n\t\t\tappear at most once in the list.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags of the distribution configuration.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "dryRun": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#CreateDistributionConfigurationResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "distributionConfigurationArn": { "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that was created by\n\t\t\tthis request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#CreateImage": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#CreateImageRequest" }, "output": { "target": "com.amazonaws.imagebuilder#CreateImageResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a new image along with all configured output resources defined in the\n\t\t\tdistribution configuration. You must specify exactly one recipe for your image, using\n\t\t\teither a containerRecipeArn or an imageRecipeArn.

\n

The response returns as soon as Image Builder creates the new image resource.\n\t\t\tThe image build process runs asynchronously. To check its progress, call\n\t\t\tGetImage and check the image status.

", "smithy.api#examples": [ { "title": "Create an image", "documentation": "The following example creates a new image from the specified image recipe and infrastructure configuration.", "input": { "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEeeeee" }, "output": { "requestId": "62e9b43f-a9fd-4272-89fb-ce6235d07ab4", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEeeeee", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "latestVersionReferences": { "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/x.x.x", "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0" } } }, { "title": "Create an image with custom build and parallel test workflows", "documentation": "The following example creates an image that uses your custom build and test workflows. It uses the Image Builder service-linked role as the execution role. Both test workflows are in the same parallel group, so they can run at the same time after the build workflow completes.", "input": { "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "workflows": [ { "workflowArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1" }, { "workflowArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/test/my-example-integration-tests/1.0.0/1", "parallelGroup": "post-build-tests" }, { "workflowArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/test/my-example-compliance-tests/1.0.0/1", "parallelGroup": "post-build-tests" } ], "executionRole": "arn:aws:iam::111122223333:role/aws-service-role/imagebuilder.amazonaws.com/AWSServiceRoleForImageBuilder", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE01234" }, "output": { "requestId": "359f18b1-814f-4857-987f-924214970897", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE01234", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "latestVersionReferences": { "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/x.x.x", "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0" } } } ], "smithy.api#http": { "method": "PUT", "uri": "/CreateImage", "code": 200 } } }, "com.amazonaws.imagebuilder#CreateImagePipeline": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#CreateImagePipelineRequest" }, "output": { "target": "com.amazonaws.imagebuilder#CreateImagePipelineResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#DryRunOperationException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a new image pipeline. Use image pipelines to automate the creation and\n\t\t\tdistribution of images. You must specify exactly one recipe for the pipeline,\n\t\t\tusing either a containerRecipeArn or an\n\t\t\timageRecipeArn.

", "smithy.api#examples": [ { "title": "Create an image pipeline", "documentation": "The following example creates a pipeline that builds a new image version every Sunday at 9:00 AM UTC, if the base image or components have updates.", "input": { "name": "my-example-pipeline", "description": "Builds a new version of my image every Sunday", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution", "schedule": { "scheduleExpression": "cron(0 9 ? * SUN *)", "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" }, "status": "ENABLED", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE55555" }, "output": { "requestId": "db0a9329-35ef-4b53-98d0-a34385e44e28", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE55555", "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline" } }, { "title": "Create an image pipeline with scanning, custom workflows, and an auto-disable policy", "documentation": "The following example creates a pipeline that uses your custom build workflow and enables image scanning. The schedule evaluates its cron expression in the America/Los_Angeles time zone. The auto-disable policy disables the pipeline after 3 consecutive failed scheduled builds.", "input": { "name": "my-example-pipeline", "description": "Builds a scanned image with my custom build workflow on Sunday mornings when dependency updates are available", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.1.0", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution", "workflows": [ { "workflowArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1" } ], "executionRole": "arn:aws:iam::111122223333:role/aws-service-role/imagebuilder.amazonaws.com/AWSServiceRoleForImageBuilder", "imageScanningConfiguration": { "imageScanningEnabled": true }, "schedule": { "scheduleExpression": "cron(0 9 ? * SUN *)", "timezone": "America/Los_Angeles", "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE", "autoDisablePolicy": { "failureCount": 3 } }, "status": "ENABLED", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE30303" }, "output": { "requestId": "f8da3ec9-4b76-4aa3-817a-c35a90f59dca", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE30303", "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline" } } ], "smithy.api#http": { "method": "PUT", "uri": "/CreateImagePipeline", "code": 200 } } }, "com.amazonaws.imagebuilder#CreateImagePipelineRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the image pipeline. Pipeline names must be unique to your\n\t\t\taccount in each Amazon Web Services Region. Image Builder generates the pipeline ARN from a\n\t\t\tnormalized form of the name, so names that differ only in case, spaces, or\n\t\t\tunderscores count as the same name.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the image pipeline.

" } }, "imageRecipeArn": { "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that configures\n\t\t\timages created by this image pipeline. You must specify either this property\n\t\t\tor containerRecipeArn, but not both.

" } }, "containerRecipeArn": { "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that is used to configure\n\t\t\timages created by this container pipeline. You must specify either this\n\t\t\tproperty or imageRecipeArn, but not both.

" } }, "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that \n\t\t\tbuilds images created by this image pipeline.

", "smithy.api#required": {} } }, "distributionConfigurationArn": { "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that configures and\n\t\t\tdistributes images created by this image pipeline.

" } }, "imageTestsConfiguration": { "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", "traits": { "smithy.api#documentation": "

Specifies the test settings that Image Builder applies to images that this\n\t\t\tpipeline creates. If you don't provide test settings, Image Builder stores a default\n\t\t\tconfiguration with image tests enabled.

" } }, "enhancedImageMetadataEnabled": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether to collect additional information about the image being created, including the operating\n\t\t\tsystem (OS) version and package list. Defaults to true.

" } }, "schedule": { "target": "com.amazonaws.imagebuilder#Schedule", "traits": { "smithy.api#documentation": "

The schedule of the image pipeline. If you don't provide a schedule, the\n\t\t\tpipeline runs only when you call\n\t\t\tStartImagePipelineExecution.

" } }, "status": { "target": "com.amazonaws.imagebuilder#PipelineStatus", "traits": { "smithy.api#documentation": "

The status of the image pipeline. If you don't specify a status, it\n\t\t\tdefaults to ENABLED. A disabled pipeline doesn't run on its\n\t\t\tschedule, but you can still start builds manually.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags of the image pipeline.

" } }, "imageTags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags that Image Builder applies to the Image Builder image resource that this\n\t\t\tpipeline's scheduled executions create. These tags don't apply to the\n\t\t\toutput AMI. To tag output AMIs, use amiTags in the\n\t\t\tpipeline's distribution configuration.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "imageScanningConfiguration": { "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", "traits": { "smithy.api#documentation": "

The settings that determine whether and how Amazon Inspector scans the images that\n\t\t\tthis pipeline creates.

" } }, "workflows": { "target": "com.amazonaws.imagebuilder#WorkflowConfigurationList", "traits": { "smithy.api#documentation": "

The array of workflow configuration objects for builds that this pipeline\n\t\t\tstarts. If you specify workflows, they replace the default workflows that\n\t\t\tImage Builder otherwise runs for the pipeline's builds. For example, if your\n\t\t\tlist doesn't include a test workflow, the pipeline's builds\n\t\t\tdon't run one. You must also specify executionRole when\n\t\t\tyou provide workflows.

" } }, "executionRole": { "target": "com.amazonaws.imagebuilder#RoleNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) for the IAM role you create that grants \n\t\t\tImage Builder access to perform workflow actions.

" } }, "loggingConfiguration": { "target": "com.amazonaws.imagebuilder#PipelineLoggingConfiguration", "traits": { "smithy.api#documentation": "

Specifies the logging configuration for the image pipeline. Use this\n\t\t\tto define custom CloudWatch Logs log groups for your pipeline execution\n\t\t\tlogs and image build logs. The service manages log groups with names\n\t\t\tstarting with /aws/imagebuilder/ using the service-linked\n\t\t\trole. For custom log group names outside of this prefix, you must also\n\t\t\tprovide an executionRole.

" } }, "dryRun": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#CreateImagePipelineResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "imagePipelineArn": { "target": "com.amazonaws.imagebuilder#ImagePipelineArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that was created by this\n\t\t\trequest.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#CreateImageRecipe": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#CreateImageRecipeRequest" }, "output": { "target": "com.amazonaws.imagebuilder#CreateImageRecipeResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#DryRunOperationException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#InvalidVersionNumberException" }, { "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a new image recipe. Image recipes define how images are configured, tested,\n\t\t\tand assessed.

", "smithy.api#examples": [ { "title": "Create an image recipe", "documentation": "The following example creates an image recipe that applies a custom component on top of the latest Amazon Linux 2023 base image.", "input": { "name": "my-example-recipe", "semanticVersion": "1.0.0", "description": "An image recipe that installs my application on Amazon Linux 2023", "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2023-x86/x.x.x", "components": [ { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1" } ], "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" }, "output": { "requestId": "89f4af2f-4f28-45e6-a9d8-abeba591df6a", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "latestVersionReferences": { "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/x.x.x", "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0" } } }, { "title": "Create an image recipe with component parameters and block device mappings", "documentation": "The following example creates an image recipe that configures its components and storage. The AppVersion component parameter selects the application version to install. The block device mapping increases the root volume to an encrypted 30 GiB gp3 volume.", "input": { "name": "my-example-recipe", "semanticVersion": "1.1.0", "description": "Installs a specific version of my application on Amazon Linux 2023 with a larger encrypted root volume", "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2023-x86/x.x.x", "components": [ { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/1.0.0/1", "parameters": [ { "name": "AppVersion", "value": [ "2.5.0" ] } ] } ], "blockDeviceMappings": [ { "deviceName": "/dev/xvda", "ebs": { "volumeSize": 30, "volumeType": "gp3", "encrypted": true, "deleteOnTermination": true } } ], "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE20202" }, "output": { "requestId": "e3bdc054-d12e-4578-a847-68a18da724ca", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE20202", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.1.0", "latestVersionReferences": { "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/x.x.x", "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.1.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.1.0" } } } ], "smithy.api#http": { "method": "PUT", "uri": "/CreateImageRecipe", "code": 200 } } }, "com.amazonaws.imagebuilder#CreateImageRecipeRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the image recipe. The recipe name, combined with the semantic\n\t\t\tversion, must be unique to your account in each Amazon Web Services Region. Image Builder\n\t\t\tgenerates the image recipe ARN from a normalized form of the name, so\n\t\t\tnames that differ only in case, spaces, or underscores count as the same\n\t\t\tname.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the image recipe.

" } }, "semanticVersion": { "target": "com.amazonaws.imagebuilder#WildcardVersionNumber", "traits": { "smithy.api#documentation": "

The semantic version of the image recipe. This version follows the semantic version\n\t\t\tsyntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes, you can assign any positive integer value, including \n\tzero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

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

\n
", "smithy.api#required": {} } }, "components": { "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", "traits": { "smithy.api#documentation": "

The components included in the image recipe. Components are optional. A\n\t\t\trecipe with no components bakes the base image without additional\n\t\t\tcustomization. You can\n\t\t\tspecify each component only one time in a recipe. Components with a status\n\t\t\tof DEPRECATED or DISABLED can't be added to\n\t\t\tnew recipes.

" } }, "parentImage": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The base image for customizations specified in the image recipe. You can specify the \n\t\t\tparent image using one of the following options:

\n \n

If you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access \n\t\t\tto the AMI. The AMI must also be in the Region where you're creating\n\t\t\tthe recipe.

", "smithy.api#required": {} } }, "blockDeviceMappings": { "target": "com.amazonaws.imagebuilder#InstanceBlockDeviceMappings", "traits": { "smithy.api#documentation": "

The block device mappings that Image Builder applies to the build instance and the\n\t\t\toutput AMI. For example, you can override the size of the base image's\n\t\t\troot volume or attach additional EBS volumes.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags of the image recipe.

" } }, "workingDirectory": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The working directory used during build and test workflows. If you\n\t\t\tdon't specify a working directory, Image Builder uses /tmp for\n\t\t\tLinux and macOS build instances, and C:/ for Windows build\n\t\t\tinstances.

" } }, "additionalInstanceConfiguration": { "target": "com.amazonaws.imagebuilder#AdditionalInstanceConfiguration", "traits": { "smithy.api#documentation": "

The additional settings and launch scripts for your build instances.

" } }, "amiTags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

Tags that are applied to the AMI that Image Builder creates during the Build phase\n\t\t\tprior to image distribution.

" } }, "amiWatermarks": { "target": "com.amazonaws.imagebuilder#AmiWatermarksList", "traits": { "smithy.api#documentation": "

The AMI watermark names to attach to the output AMI from this recipe.\n\t\t\tAMI watermarks are lineage markers. They automatically propagate to\n\t\t\tderivative AMIs when the source AMI is copied or distributed across\n\t\t\tRegions or accounts.

\n \n

AMI watermarks are supported only for image recipes. AMIs with\n\t\t\t\twatermarks cannot be made public.

\n
" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "dryRun": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#CreateImageRecipeResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "imageRecipeArn": { "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that was created by this\n\t\t\trequest.

" } }, "latestVersionReferences": { "target": "com.amazonaws.imagebuilder#LatestVersionReferences", "traits": { "smithy.api#documentation": "

A set of wildcard version ARNs that always reference the latest\n\t\t\tversion of the resource. ARNs are included for the latest version overall, and for the latest\n\t\t\tversions within the same major, minor, and patch levels.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#CreateImageRequest": { "type": "structure", "members": { "imageRecipeArn": { "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that defines how images are\n\t\t\tconfigured, tested, and assessed. You must specify either this property or\n\t\t\tcontainerRecipeArn, but not both.

" } }, "containerRecipeArn": { "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that defines how images are\n\t\t\tconfigured and tested. You must specify either this property or\n\t\t\timageRecipeArn, but not both.

" } }, "distributionConfigurationArn": { "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that defines and\n\t\t\tconfigures the outputs of the image build. If you don't specify a\n\t\t\tdistribution configuration, Image Builder creates the output image only in the\n\t\t\taccount and Amazon Web Services Region where the build runs.

" } }, "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the\n\t\t\tenvironment in which your image will be built and tested.

", "smithy.api#required": {} } }, "imageTestsConfiguration": { "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", "traits": { "smithy.api#documentation": "

Settings that determine whether Image Builder runs tests on the image after\n\t\t\tbuilding it. Image tests are enabled by default.

" } }, "enhancedImageMetadataEnabled": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether to collect additional information about the image being created, including the operating\n\t\t\tsystem (OS) version and package list. Defaults to true.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags of the image.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "imageScanningConfiguration": { "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", "traits": { "smithy.api#documentation": "

The settings that determine whether and how Amazon Inspector scans the image\n\t\t\tfor vulnerabilities.

" } }, "workflows": { "target": "com.amazonaws.imagebuilder#WorkflowConfigurationList", "traits": { "smithy.api#documentation": "

The array of workflow configuration objects for the build. If you specify\n\t\t\tworkflows, they replace the default workflows that Image Builder otherwise runs for\n\t\t\tthe build, and you must also provide an executionRole.

" } }, "executionRole": { "target": "com.amazonaws.imagebuilder#RoleNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) for the IAM role you create that grants\n\t\t\tImage Builder access to perform workflow actions. This property is required if you\n\t\t\tspecify workflows. If you don't provide a role, Image Builder uses the\n\t\t\tImage Builder service-linked role in your account, and creates it if it doesn't\n\t\t\texist.

" } }, "loggingConfiguration": { "target": "com.amazonaws.imagebuilder#ImageLoggingConfiguration", "traits": { "smithy.api#documentation": "

The CloudWatch Logs log group where Image Builder sends the image build logs. If\n\t\t\tyou specify a log group name outside of the /aws/imagebuilder/\n\t\t\tnamespace, you must also provide an executionRole that has\n\t\t\tpermission to write to that log group.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#CreateImageResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that the request created.

" } }, "latestVersionReferences": { "target": "com.amazonaws.imagebuilder#LatestVersionReferences", "traits": { "smithy.api#documentation": "

A set of wildcard version ARNs that always reference the latest\n\t\t\tversion of the resource. ARNs are included for the latest version overall, and for the latest\n\t\t\tversions within the same major, minor, and patch levels.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#CreateInfrastructureConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#CreateInfrastructureConfigurationRequest" }, "output": { "target": "com.amazonaws.imagebuilder#CreateInfrastructureConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#DryRunOperationException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a new infrastructure configuration. An infrastructure configuration defines\n\t\t\tthe environment in which your image will be built and tested.

", "smithy.api#examples": [ { "title": "Create an infrastructure configuration", "documentation": "The following example creates an infrastructure configuration that gives Image Builder a choice of two instance types for its build and test instances.", "input": { "name": "my-example-infrastructure", "description": "An infrastructure configuration for Amazon Linux builds", "instanceProfileName": "EC2InstanceProfileForImageBuilder", "instanceTypes": [ "t3.medium", "t3.large" ], "terminateInstanceOnFailure": true, "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" }, "output": { "requestId": "67082698-415b-4d9f-8be0-84a58380b93f", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure" } }, { "title": "Create an infrastructure configuration with instance placement and metadata options", "documentation": "The following example creates an infrastructure configuration. It places your build and test instances in a single Availability Zone and requires IMDSv2 for instance metadata requests. It also applies resource tags to the resources that Image Builder creates during the build.", "input": { "name": "my-example-infrastructure", "description": "An infrastructure configuration that pins build instances to one Availability Zone and requires IMDSv2", "instanceProfileName": "my-example-instance-role", "placement": { "availabilityZone": "us-west-2a" }, "instanceMetadataOptions": { "httpTokens": "required", "httpPutResponseHopLimit": 2 }, "resourceTags": { "CostCenter": "12345", "Environment": "test" }, "terminateInstanceOnFailure": true, "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE98765" }, "output": { "requestId": "b96b54d8-daa6-4fdf-b25a-7b570bc2ab25", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE98765", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure" } } ], "smithy.api#http": { "method": "PUT", "uri": "/CreateInfrastructureConfiguration", "code": 200 } } }, "com.amazonaws.imagebuilder#CreateInfrastructureConfigurationRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the infrastructure configuration. Infrastructure configuration\n\t\t\tnames must be unique to your account in each Amazon Web Services Region. Image Builder generates\n\t\t\tthe infrastructure configuration ARN from a normalized form of the name, so\n\t\t\tnames that differ only in case, spaces, or underscores count as the same\n\t\t\tname.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the infrastructure configuration.

" } }, "instanceTypes": { "target": "com.amazonaws.imagebuilder#InstanceTypeList", "traits": { "smithy.api#documentation": "

The instance types of the infrastructure configuration. You can specify one or more\n\t\t\tinstance types to use for this build. Image Builder picks one of these instance types\n\t\t\tbased on availability. If you don't specify instance types, Image Builder selects\n\t\t\tcompatible instance types automatically. If you specify a Dedicated Host,\n\t\t\tImage Builder uses only instance types that the host supports.

" } }, "instanceProfileName": { "target": "com.amazonaws.imagebuilder#InstanceProfileNameType", "traits": { "smithy.api#documentation": "

The instance profile to associate with the instance used to customize your Amazon EC2\n\t\t\tAMI. The instance profile must exist in your account.

", "smithy.api#required": {} } }, "securityGroupIds": { "target": "com.amazonaws.imagebuilder#SecurityGroupIds", "traits": { "smithy.api#documentation": "

The security group IDs to associate with the instance used to customize your Amazon EC2\n\t\t\tAMI.

" } }, "subnetId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The subnet ID in which to place the instance used to customize your Amazon EC2\n\t\t\tAMI. If you specify subnetId, you must also specify one or\n\t\t\tmore security group IDs in securityGroupIds. Otherwise, the\n\t\t\trequest fails.

" } }, "logging": { "target": "com.amazonaws.imagebuilder#Logging", "traits": { "smithy.api#documentation": "

The logging configuration of the infrastructure configuration. When you\n\t\t\tconfigure S3 logs, Image Builder writes logs from the build and test process to the\n\t\t\tspecified bucket under the key prefix.

" } }, "keyPair": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The key pair of the infrastructure configuration. You can use this to log on to and\n\t\t\tdebug the instance used to create your image.

" } }, "terminateInstanceOnFailure": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether to terminate the instance on failure. Set to\n\t\t\tfalse if you want Image Builder to retain the instance used to configure your AMI if the build or\n\t\t\ttest phase of your workflow fails. Defaults to true.

" } }, "terminateInstanceOnCompletion": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether Image Builder terminates build and test instances when image creation\n\t\t\tends without a failure (success, cancellation, or expiration). Defaults to\n\t\t\ttrue.

" } }, "snsTopicArn": { "target": "com.amazonaws.imagebuilder#SnsTopicArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic to which Image Builder sends image build event notifications.\n\t\t\tSpecify a standard topic. Image Builder doesn't support FIFO topics.\n\t\t\tImage Builder validates the topic when you create or update the configuration. You\n\t\t\tmust have permission to publish to the topic.

\n \n

EC2 Image Builder can't send notifications to SNS topics that are encrypted using keys\n\t\t\t\tfrom other accounts. If your SNS topic is encrypted, the key must be owned by the\n\t\t\t\tsame account that owns your Image Builder resources.

\n
" } }, "resourceTags": { "target": "com.amazonaws.imagebuilder#ResourceTagMap", "traits": { "smithy.api#documentation": "

The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during\n\t\t\tthe build process. Tags are formatted as key value pairs. Tag keys can't\n\t\t\tbegin with aws: or match one of the following reserved keys: CreatedBy,\n\t\t\tEc2ImageBuilderArn, Name, or\n\t\t\tTags.

" } }, "instanceMetadataOptions": { "target": "com.amazonaws.imagebuilder#InstanceMetadataOptions", "traits": { "smithy.api#documentation": "

The instance metadata service (IMDS) settings that Image Builder applies to the EC2\n\t\t\tbuild and test instances it launches during image creation. If you don't\n\t\t\tset these options, the EC2 launch defaults for the instance apply. For more\n\t\t\tinformation about instance metadata options, see one of the following\n\t\t\tlinks:

\n " } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The metadata tags to assign to the infrastructure configuration resource that Image Builder \n\t\t\tcreates as output. Tags are formatted as key value pairs.

" } }, "placement": { "target": "com.amazonaws.imagebuilder#Placement", "traits": { "smithy.api#documentation": "

The instance placement settings that define where the build and test\n\t\t\tinstances that Image Builder launches during image creation run. These settings\n\t\t\tdon't affect instances that you launch from the output image.

" } }, "parentInstance": { "target": "com.amazonaws.imagebuilder#ParentInstanceConfiguration", "traits": { "smithy.api#documentation": "

The Amazon EC2 Auto Scaling group that Image Builder takes the build instance from, instead of\n\t\t\tlaunching a new instance. This applies only to the build phase.

\n

To use this feature, the execution role for the build must have permissions to\n\t\t\tdescribe the Auto Scaling group, tag the instance while it's still in the group, and\n\t\t\tdetach it from the group. For more information, see Build on an\n\t\t\t\tinstance from an Auto Scaling group in the EC2 Image Builder User\n\t\t\t\tGuide.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "dryRun": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#CreateInfrastructureConfigurationResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that was created by\n\t\t\tthis request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#CreateLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#CreateLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.imagebuilder#CreateLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#DryRunOperationException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a lifecycle policy resource.

", "smithy.api#examples": [ { "title": "Create a lifecycle policy", "documentation": "The following example creates a lifecycle policy that deletes AMI-based images six months after they were created, selecting the images that match the specified resource tags.", "input": { "name": "my-example-lifecycle-policy", "executionRole": "arn:aws:iam::111122223333:role/my-example-lifecycle-role", "resourceType": "AMI_IMAGE", "policyDetails": [ { "action": { "type": "DELETE" }, "filter": { "type": "AGE", "value": 6, "unit": "MONTHS" } } ], "resourceSelection": { "tagMap": { "Environment": "test" } }, "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE13579" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE13579", "lifecyclePolicyArn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-lifecycle-policy" } }, { "title": "Create a lifecycle policy with exclusion rules", "documentation": "The following example creates a lifecycle policy that deletes images created from the specified recipe version after six months. The policy excludes images whose AMIs launched an instance within the last 30 days or are tagged to be retained.", "input": { "name": "my-example-lifecycle-policy", "executionRole": "arn:aws:iam::111122223333:role/my-example-lifecycle-role", "resourceType": "AMI_IMAGE", "policyDetails": [ { "action": { "type": "DELETE" }, "filter": { "type": "AGE", "value": 6, "unit": "MONTHS" }, "exclusionRules": { "amis": { "lastLaunched": { "value": 30, "unit": "DAYS" }, "tagMap": { "Retention": "keep" } } } } ], "resourceSelection": { "recipes": [ { "name": "my-example-recipe", "semanticVersion": "1.0.0" } ] }, "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE43210" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE43210", "lifecyclePolicyArn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-lifecycle-policy" } } ], "smithy.api#http": { "method": "PUT", "uri": "/CreateLifecyclePolicy", "code": 200 } } }, "com.amazonaws.imagebuilder#CreateLifecyclePolicyRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the lifecycle policy to create. Policy names must be unique to\n\t\t\tyour account in each Amazon Web Services Region. Image Builder generates the policy ARN from a\n\t\t\tnormalized form of the name, so names that differ only in case, spaces, or\n\t\t\tunderscores count as the same name. You can't change the name after\n\t\t\tcreation.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Optional description for the lifecycle policy.

" } }, "status": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyStatus", "traits": { "smithy.api#documentation": "

Indicates whether the lifecycle policy resource is enabled. If you don't\n\t\t\tspecify a status, it defaults to ENABLED. Only enabled policies\n\t\t\trun on their schedule.

" } }, "executionRole": { "target": "com.amazonaws.imagebuilder#RoleNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run\n\t\t\tlifecycle actions. You must have permission to pass the role, and the\n\t\t\trole's trust policy must allow the Image Builder service principal to assume it.

", "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceType", "traits": { "smithy.api#documentation": "

The type of Image Builder resource that the lifecycle policy applies to. The resource\n\t\t\ttype determines the allowed rule actions: policies for AMI-based Image Builder images\n\t\t\tsupport DELETE, DEPRECATE, and\n\t\t\tDISABLE, and policies for container-based Image Builder images support\n\t\t\tonly DELETE. You can't\n\t\t\tchange the resource type after creation.

", "smithy.api#required": {} } }, "policyDetails": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetails", "traits": { "smithy.api#documentation": "

Configuration details for the lifecycle policy rules. A policy can contain\n\t\t\tat most one rule per action type: one DELETE, one\n\t\t\tDEPRECATE, and one DISABLE.

", "smithy.api#required": {} } }, "resourceSelection": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelection", "traits": { "smithy.api#documentation": "

Selection criteria for the resources that the lifecycle policy applies to.\n\t\t\tYou must specify exactly one selection criteria: either recipes or a tag\n\t\t\tmap, not both.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

Tags to apply to the lifecycle policy resource.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "dryRun": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#CreateLifecyclePolicyResponse": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "lifecyclePolicyArn": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lifecycle policy that the request created.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#CreateWorkflow": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#CreateWorkflowRequest" }, "output": { "target": "com.amazonaws.imagebuilder#CreateWorkflowResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#DryRunOperationException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#InvalidVersionNumberException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a new workflow or a new version of an existing workflow. If a workflow\n\t\t\twith the same name and semantic version already exists, and your request changes\n\t\t\tits configuration, Image Builder creates a new build version.\n\t\t\tIf the configuration is identical to the latest build version, the request\n\t\t\tfails because that workflow configuration already exists.

", "smithy.api#examples": [ { "title": "Create a build workflow from an inline document", "documentation": "The following example creates a build workflow from a YAML workflow document provided inline in the request.", "input": { "name": "my-example-workflow", "semanticVersion": "1.0.0", "description": "Workflow to build an AMI", "type": "BUILD", "data": "name: my-example-workflow\ndescription: Workflow to build an AMI\nschemaVersion: 1.0\nsteps:\n - name: LaunchBuildInstance\n action: LaunchInstance\n onFailure: Abort\n inputs:\n waitFor: ssmAgent\n - name: ApplyBuildComponents\n action: ExecuteComponents\n onFailure: Abort\n inputs:\n instanceId.$: $.stepOutputs.LaunchBuildInstance.instanceId\n - name: CreateOutputAMI\n action: CreateImage\n onFailure: Abort\n inputs:\n instanceId.$: $.stepOutputs.LaunchBuildInstance.instanceId\n - name: TerminateBuildInstance\n action: TerminateInstance\n onFailure: Continue\n inputs:\n instanceId.$: $.stepOutputs.LaunchBuildInstance.instanceId\n", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE54321" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE54321", "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1", "latestVersionReferences": { "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/x.x.x", "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0" } } } ], "smithy.api#http": { "method": "PUT", "uri": "/CreateWorkflow", "code": 200 } } }, "com.amazonaws.imagebuilder#CreateWorkflowRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the workflow to create. Image Builder generates the workflow ARN from a\n\t\t\tnormalized form of the name, so names that differ only in case, spaces, or\n\t\t\tunderscores count as the same name. If a workflow with the same name and\n\t\t\tsemantic version already exists in your account in the same Amazon Web Services Region,\n\t\t\tthe request creates a new build version for it. If the content is also\n\t\t\tidentical to the latest build version, the request fails because the\n\t\t\tworkflow already exists.

", "smithy.api#required": {} } }, "semanticVersion": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { "smithy.api#documentation": "

The semantic version of this workflow resource. The semantic version syntax \n\t\t\tadheres to the following rules.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes, you can assign any positive integer value, including \n\tzero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

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

\n
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Describes the workflow.

" } }, "changeDescription": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Describes what change has been made in this version of the workflow, or \n\t\t\twhat makes this version different from other versions of the workflow.

" } }, "data": { "target": "com.amazonaws.imagebuilder#InlineWorkflowData", "traits": { "smithy.api#documentation": "

The UTF-8 encoded YAML document content for the workflow, up to\n\t\t\t16,000 characters. For larger documents, store the document in Amazon S3 and specify\n\t\t\tthe uri property instead. You must specify exactly one of the\n\t\t\tdata or uri properties.

" } }, "uri": { "target": "com.amazonaws.imagebuilder#Uri", "traits": { "smithy.api#documentation": "

The uri of a YAML workflow document file stored in Amazon S3. This must\n\t\t\tbe an S3 URL (s3://bucket/key), and you must have permission to\n\t\t\taccess the S3 bucket it points to. A workflow document that you provide from\n\t\t\tAmazon S3 can be up to your service quota for workflow size.

\n

Alternatively, you can specify the YAML document inline, using the workflow\n\t\t\tdata property. You must specify exactly one of the data\n\t\t\tor uri properties.

" } }, "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource.\n\t\t\tThis can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide. If you don't specify a key, Image Builder encrypts the workflow\n\t\t\tdocument with a KMS key that Image Builder owns.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

Tags that apply to the workflow resource.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.imagebuilder#WorkflowType", "traits": { "smithy.api#documentation": "

The image creation stage that this workflow applies to. Image Builder validates the\n\t\t\tworkflow document steps against the stage you specify.

", "smithy.api#required": {} } }, "dryRun": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#CreateWorkflowResponse": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "workflowBuildVersionArn": { "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource that the request created.

" } }, "latestVersionReferences": { "target": "com.amazonaws.imagebuilder#LatestVersionReferences", "traits": { "smithy.api#documentation": "

A set of wildcard version ARNs that always reference the latest\n\t\t\tversion of the resource. ARNs are included for the latest version overall, and for the latest\n\t\t\tversions within the same major, minor, and patch levels.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#CvssScore": { "type": "structure", "members": { "baseScore": { "target": "com.amazonaws.imagebuilder#NonNegativeDouble", "traits": { "smithy.api#documentation": "

The CVSS base score.

" } }, "scoringVector": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The vector string of the CVSS score.

" } }, "version": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The CVSS version that generated the score.

" } }, "source": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The source of the CVSS score.

" } } }, "traits": { "smithy.api#documentation": "

A CVSS score for the vulnerability, as published by the vulnerability\n\t\t\tsource. Sources include the National Vulnerability Database (NVD) and the\n\t\t\toperating system vendor's security feed. A finding can include CVSS scores\n\t\t\tfrom multiple sources and CVSS versions.

" } }, "com.amazonaws.imagebuilder#CvssScoreAdjustment": { "type": "structure", "members": { "metric": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The metric that Amazon Inspector used to adjust the CVSS score.

" } }, "reason": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The reason for the CVSS score adjustment.

" } } }, "traits": { "smithy.api#documentation": "

Details about an adjustment that Amazon Inspector made to the CVSS score for a finding.

" } }, "com.amazonaws.imagebuilder#CvssScoreAdjustmentList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#CvssScoreAdjustment" } }, "com.amazonaws.imagebuilder#CvssScoreDetails": { "type": "structure", "members": { "scoreSource": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The source for the CVSS score.

" } }, "cvssSource": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The source of the CVSS data that the Amazon Inspector score for the finding is based\n\t\t\ton, for example NVD or a vendor security feed.

" } }, "version": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The CVSS version that generated the score.

" } }, "score": { "target": "com.amazonaws.imagebuilder#NonNegativeDouble", "traits": { "smithy.api#documentation": "

The CVSS score.

" } }, "scoringVector": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

A vector that measures the severity of the vulnerability.

" } }, "adjustments": { "target": "com.amazonaws.imagebuilder#CvssScoreAdjustmentList", "traits": { "smithy.api#documentation": "

The adjustments that Amazon Inspector applied to the base CVSS score to produce its own\n\t\t\tscore for the finding. The list is empty when Amazon Inspector made no\n\t\t\tadjustments.

" } } }, "traits": { "smithy.api#documentation": "

Details about the source of the score, and the factors that determined the adjustments\n\t\t\tto create the final score.

" } }, "com.amazonaws.imagebuilder#CvssScoreList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#CvssScore" } }, "com.amazonaws.imagebuilder#DateTime": { "type": "string" }, "com.amazonaws.imagebuilder#DateTimeTimestamp": { "type": "timestamp" }, "com.amazonaws.imagebuilder#DeleteComponent": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#DeleteComponentRequest" }, "output": { "target": "com.amazonaws.imagebuilder#DeleteComponentResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceDependencyException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes a component build version. The request fails with\n\t\t\tResourceDependencyException if an image recipe or container\n\t\t\trecipe references this component version. It also fails if the component\n\t\t\tbuild version is shared with other accounts.

", "smithy.api#examples": [ { "title": "Delete a component build version", "documentation": "The following example deletes the specified component build version.", "input": { "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1" }, "output": { "requestId": "c75a1764-2ca3-4cb4-9ce9-6d49f87942b0", "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1" } } ], "smithy.api#http": { "method": "DELETE", "uri": "/DeleteComponent", "code": 200 } } }, "com.amazonaws.imagebuilder#DeleteComponentRequest": { "type": "structure", "members": { "componentBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component build version to delete.

", "smithy.api#httpQuery": "componentBuildVersionArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#DeleteComponentResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "componentBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component build version that this request deleted.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#DeleteContainerRecipe": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#DeleteContainerRecipeRequest" }, "output": { "target": "com.amazonaws.imagebuilder#DeleteContainerRecipeResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceDependencyException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes a container recipe. The request fails with\n\t\t\tResourceDependencyException if the recipe is shared with other\n\t\t\taccounts, or if an image pipeline references it.

", "smithy.api#examples": [ { "title": "Delete a container recipe", "documentation": "The following example deletes the specified container recipe.", "input": { "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0" }, "output": { "requestId": "988e934a-b785-4705-aff1-4d9840a165aa", "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0" } } ], "smithy.api#http": { "method": "DELETE", "uri": "/DeleteContainerRecipe", "code": 200 } } }, "com.amazonaws.imagebuilder#DeleteContainerRecipeRequest": { "type": "structure", "members": { "containerRecipeArn": { "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "containerRecipeArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#DeleteContainerRecipeResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "containerRecipeArn": { "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#DeleteDistributionConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#DeleteDistributionConfigurationRequest" }, "output": { "target": "com.amazonaws.imagebuilder#DeleteDistributionConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceDependencyException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes a distribution configuration. You can't delete a configuration\n\t\t\tthat an image pipeline still references. The request fails with\n\t\t\tResourceDependencyException. Update or delete the referencing\n\t\t\tpipelines first.

", "smithy.api#examples": [ { "title": "Delete a distribution configuration", "documentation": "The following example deletes the specified distribution configuration.", "input": { "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution-configuration" }, "output": { "requestId": "2b752b77-2038-40f4-996a-0a6da1be5e92", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution-configuration" } } ], "smithy.api#http": { "method": "DELETE", "uri": "/DeleteDistributionConfiguration", "code": 200 } } }, "com.amazonaws.imagebuilder#DeleteDistributionConfigurationRequest": { "type": "structure", "members": { "distributionConfigurationArn": { "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration to delete.

", "smithy.api#httpQuery": "distributionConfigurationArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#DeleteDistributionConfigurationResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "distributionConfigurationArn": { "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that was\n\t\t\tdeleted.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#DeleteImage": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#DeleteImageRequest" }, "output": { "target": "com.amazonaws.imagebuilder#DeleteImageResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceDependencyException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container\n\t\t\timages that are created during the image build process. You must clean those up\n\t\t\tseparately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI\n\t\t\tcommands.

\n

The request fails with ResourceDependencyException if the image\n\t\t\tis shared with other accounts, or if other resources depend on it. It also\n\t\t\tfails while the image build is still running. Cancel an in-progress build\n\t\t\twith CancelImageCreation before you delete the image.

\n ", "smithy.api#examples": [ { "title": "Delete an image build version", "documentation": "The following example deletes the Image Builder image record for the specified build version - EC2 AMIs or ECR container images that the build created aren't removed.", "input": { "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "output": { "requestId": "fd45526c-ec37-4345-8843-329e4268e00e", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" } } ], "smithy.api#http": { "method": "DELETE", "uri": "/DeleteImage", "code": 200 } } }, "com.amazonaws.imagebuilder#DeleteImagePipeline": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#DeleteImagePipelineRequest" }, "output": { "target": "com.amazonaws.imagebuilder#DeleteImagePipelineResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceDependencyException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes an image pipeline. Images that the pipeline created aren't\n\t\t\tdeleted - remove those separately with DeleteImage. You\n\t\t\tcan delete a pipeline while a build that it started is still running. The\n\t\t\tbuild continues independently.

", "smithy.api#examples": [ { "title": "Delete an image pipeline", "documentation": "The following example deletes an image pipeline.", "input": { "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline" }, "output": { "requestId": "0536e4e9-5331-493a-921e-e8f86d367043", "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline" } } ], "smithy.api#http": { "method": "DELETE", "uri": "/DeleteImagePipeline", "code": 200 } } }, "com.amazonaws.imagebuilder#DeleteImagePipelineRequest": { "type": "structure", "members": { "imagePipelineArn": { "target": "com.amazonaws.imagebuilder#ImagePipelineArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline to delete.

", "smithy.api#httpQuery": "imagePipelineArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#DeleteImagePipelineResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "imagePipelineArn": { "target": "com.amazonaws.imagebuilder#ImagePipelineArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that was deleted.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#DeleteImageRecipe": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#DeleteImageRecipeRequest" }, "output": { "target": "com.amazonaws.imagebuilder#DeleteImageRecipeResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceDependencyException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes an image recipe.

", "smithy.api#examples": [ { "title": "Delete an image recipe", "documentation": "The following example deletes the specified image recipe version.", "input": { "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0" }, "output": { "requestId": "a27ae6de-0adc-4cbb-9705-a4b8751857b8", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0" } } ], "smithy.api#http": { "method": "DELETE", "uri": "/DeleteImageRecipe", "code": 200 } } }, "com.amazonaws.imagebuilder#DeleteImageRecipeRequest": { "type": "structure", "members": { "imageRecipeArn": { "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe to delete.

", "smithy.api#httpQuery": "imageRecipeArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#DeleteImageRecipeResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "imageRecipeArn": { "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that was deleted.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#DeleteImageRequest": { "type": "structure", "members": { "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Image Builder image resource to delete.

", "smithy.api#httpQuery": "imageBuildVersionArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#DeleteImageResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Image Builder image resource that this request deleted.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#DeleteInfrastructureConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#DeleteInfrastructureConfigurationRequest" }, "output": { "target": "com.amazonaws.imagebuilder#DeleteInfrastructureConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceDependencyException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes an infrastructure configuration. You can't delete a configuration\n\t\t\tthat an image pipeline still references. The request fails with\n\t\t\tResourceDependencyException. Update or delete the referencing\n\t\t\tpipelines first.

", "smithy.api#examples": [ { "title": "Delete an infrastructure configuration", "documentation": "The following example deletes the infrastructure configuration with the specified ARN.", "input": { "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure" }, "output": { "requestId": "fbae57f4-59fc-48ab-a25e-c67b0d9b454c", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure" } } ], "smithy.api#http": { "method": "DELETE", "uri": "/DeleteInfrastructureConfiguration", "code": 200 } } }, "com.amazonaws.imagebuilder#DeleteInfrastructureConfigurationRequest": { "type": "structure", "members": { "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration to delete.

", "smithy.api#httpQuery": "infrastructureConfigurationArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#DeleteInfrastructureConfigurationResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that was\n\t\t\tdeleted.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#DeleteLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#DeleteLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.imagebuilder#DeleteLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceDependencyException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified lifecycle policy resource. Deleting the policy removes\n\t\t\tits schedule, so no further lifecycle runs occur for that policy. If a\n\t\t\tlifecycle execution is in progress for the policy, Image Builder cancels it. Deletion\n\t\t\tdoesn't revert actions that the policy already applied to your\n\t\t\tresources.

", "smithy.api#examples": [ { "title": "Delete a lifecycle policy", "documentation": "The following example deletes the specified lifecycle policy.", "input": { "lifecyclePolicyArn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-lifecycle-policy" }, "output": { "lifecyclePolicyArn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-lifecycle-policy" } } ], "smithy.api#http": { "method": "DELETE", "uri": "/DeleteLifecyclePolicy", "code": 200 } } }, "com.amazonaws.imagebuilder#DeleteLifecyclePolicyRequest": { "type": "structure", "members": { "lifecyclePolicyArn": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lifecycle policy resource to delete.

", "smithy.api#httpQuery": "lifecyclePolicyArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#DeleteLifecyclePolicyResponse": { "type": "structure", "members": { "lifecyclePolicyArn": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lifecycle policy that was deleted.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#DeleteWorkflow": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#DeleteWorkflowRequest" }, "output": { "target": "com.amazonaws.imagebuilder#DeleteWorkflowResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceDependencyException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes a specific workflow resource. You can't delete a workflow build\n\t\t\tversion while an image pipeline references it. The request fails with\n\t\t\tResourceDependencyException.

", "smithy.api#examples": [ { "title": "Delete a workflow build version", "documentation": "The following example deletes the workflow build version that the ARN specifies.", "input": { "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1" }, "output": { "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1" } } ], "smithy.api#http": { "method": "DELETE", "uri": "/DeleteWorkflow", "code": 200 } } }, "com.amazonaws.imagebuilder#DeleteWorkflowRequest": { "type": "structure", "members": { "workflowBuildVersionArn": { "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource to delete.

", "smithy.api#httpQuery": "workflowBuildVersionArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#DeleteWorkflowResponse": { "type": "structure", "members": { "workflowBuildVersionArn": { "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource that this request deleted.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#DiskImageFormat": { "type": "enum", "members": { "VMDK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VMDK" } }, "RAW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RAW" } }, "VHD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VHD" } } } }, "com.amazonaws.imagebuilder#DistributeImage": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#DistributeImageRequest" }, "output": { "target": "com.amazonaws.imagebuilder#DistributeImageResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#AccessDeniedException" }, { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" }, { "target": "com.amazonaws.imagebuilder#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Distributes an existing AMI to target Regions and accounts without running\n\t\t\tthe full image build process. This operation only runs the distribution\n\t\t\tphase on an image that has already been built.

", "smithy.api#examples": [ { "title": "Distribute an existing AMI", "documentation": "The following example distributes an AMI that you own to the targets defined in the specified distribution configuration. It returns the ARN of a new Image Builder image resource that you can use with GetImage to monitor distribution progress.", "input": { "sourceImage": "ami-1234567890abcdef0", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution-configuration", "executionRole": "arn:aws:iam::111122223333:role/aws-service-role/imagebuilder.amazonaws.com/AWSServiceRoleForImageBuilder", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE86420" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE86420", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-source-ami/1.0.0/1" } } ], "smithy.api#http": { "method": "PUT", "uri": "/DistributeImage", "code": 200 } } }, "com.amazonaws.imagebuilder#DistributeImageRequest": { "type": "structure", "members": { "sourceImage": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The source image to distribute. You can specify the source in any of the\n\t\t\tfollowing formats:

\n \n

Whichever format you use, the source must resolve to an AMI in the current\n\t\t\tAmazon Web Services Region.

", "smithy.api#required": {} } }, "distributionConfigurationArn": { "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration. The configuration\n\t\t\tdefines target Regions, accounts, and AMI settings. The distribution\n\t\t\tconfiguration must be in the same Region as this operation.

", "smithy.api#required": {} } }, "executionRole": { "target": "com.amazonaws.imagebuilder#RoleNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role that Image Builder assumes to distribute\n\t\t\tthe image.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags to apply to the new Image Builder image resource that this operation\n\t\t\tcreates. To tag the output AMIs, use amiTags in the\n\t\t\tdistribution configuration.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "loggingConfiguration": { "target": "com.amazonaws.imagebuilder#ImageLoggingConfiguration", "traits": { "smithy.api#documentation": "

The logging configuration for the distribution.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#DistributeImageResponse": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new Image Builder image resource that this operation creates to\n\t\t\ttrack the distribution. Use this ARN with GetImage to\n\t\t\tmonitor distribution progress.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#Distribution": { "type": "structure", "members": { "region": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The target Region.

", "smithy.api#required": {} } }, "amiDistributionConfiguration": { "target": "com.amazonaws.imagebuilder#AmiDistributionConfiguration", "traits": { "smithy.api#documentation": "

The specific AMI settings; for example, launch permissions or AMI tags.

" } }, "containerDistributionConfiguration": { "target": "com.amazonaws.imagebuilder#ContainerDistributionConfiguration", "traits": { "smithy.api#documentation": "

Container distribution settings for encryption, licensing, and sharing in a specific\n\t\t\tRegion.

" } }, "licenseConfigurationArns": { "target": "com.amazonaws.imagebuilder#LicenseConfigurationArnList", "traits": { "smithy.api#documentation": "

The License Manager Configuration to associate with the AMI in the specified\n\t\t\tRegion.

" } }, "launchTemplateConfigurations": { "target": "com.amazonaws.imagebuilder#LaunchTemplateConfigurationList", "traits": { "smithy.api#documentation": "

A group of launchTemplateConfiguration settings that apply to image distribution for\n\t\t\tspecified accounts.

" } }, "s3ExportConfiguration": { "target": "com.amazonaws.imagebuilder#S3ExportConfiguration", "traits": { "smithy.api#documentation": "

Configure export settings to deliver disk images created from your image build, \n\t\t\tusing a file format that is compatible with your VMs in that Region.

" } }, "fastLaunchConfigurations": { "target": "com.amazonaws.imagebuilder#FastLaunchConfigurationList", "traits": { "smithy.api#documentation": "

The Windows faster-launching configurations to use for AMI distribution.

" } }, "ssmParameterConfigurations": { "target": "com.amazonaws.imagebuilder#SsmParameterConfigurationList", "traits": { "smithy.api#documentation": "

Contains settings to update Amazon Web Services Systems Manager (SSM) Parameter Store Parameters with \n\t\t\toutput AMI IDs from the build by target Region.

" } } }, "traits": { "smithy.api#documentation": "

Defines the settings for a specific Region.

" } }, "com.amazonaws.imagebuilder#DistributionConfiguration": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution configuration.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the distribution configuration.

" } }, "distributions": { "target": "com.amazonaws.imagebuilder#DistributionList", "traits": { "smithy.api#documentation": "

The distribution objects that apply Region-specific settings for the deployment of \n\t\t\tthe image to targeted Regions.

" } }, "timeoutMinutes": { "target": "com.amazonaws.imagebuilder#DistributionTimeoutMinutes", "traits": { "smithy.api#documentation": "

A property that Image Builder doesn't use. You can't set this property\n\t\t\twhen you create or update a distribution configuration, and it has no\n\t\t\teffect on distribution behavior.

", "smithy.api#required": {} } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which this distribution configuration was created.

" } }, "dateUpdated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which this distribution configuration was last updated.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags of the distribution configuration.

" } } }, "traits": { "smithy.api#documentation": "

Defines how Image Builder distributes the output of an image build. You can\n\t\t\tconfigure:

\n " } }, "com.amazonaws.imagebuilder#DistributionConfigurationArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):distribution-configuration/[a-z0-9-_]+$" } }, "com.amazonaws.imagebuilder#DistributionConfigurationSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution configuration.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the distribution configuration.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which the distribution configuration was created.

" } }, "dateUpdated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which the distribution configuration was updated.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags associated with the distribution configuration.

" } }, "regions": { "target": "com.amazonaws.imagebuilder#RegionList", "traits": { "smithy.api#documentation": "

A list of the Regions that the distribution configuration distributes\n\t\t\timages to.

" } } }, "traits": { "smithy.api#documentation": "

A high-level overview of a distribution configuration.

" } }, "com.amazonaws.imagebuilder#DistributionConfigurationSummaryList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#DistributionConfigurationSummary" } }, "com.amazonaws.imagebuilder#DistributionFailureContext": { "type": "structure", "members": { "errorMessage": { "target": "com.amazonaws.imagebuilder#NonEmptyMaxLengthString", "traits": { "smithy.api#documentation": "

The error message for the distribution failure.

" } }, "regionFailures": { "target": "com.amazonaws.imagebuilder#RegionFailureList", "traits": { "smithy.api#documentation": "

The details about the failure for each Region where the image didn't finish\n\t\t\tdistribution or configuration.

" } } }, "traits": { "smithy.api#documentation": "

Contains details about a failure that occurred while Image Builder distributed the image\n\t\t\tor applied configuration to the distributed image.

" } }, "com.amazonaws.imagebuilder#DistributionList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#Distribution" } }, "com.amazonaws.imagebuilder#DistributionTimeoutMinutes": { "type": "integer", "traits": { "smithy.api#range": { "min": 30, "max": 720 } } }, "com.amazonaws.imagebuilder#DockerFileTemplate": { "type": "string" }, "com.amazonaws.imagebuilder#DryRunOperationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.

", "smithy.api#error": "client", "smithy.api#httpError": 412 } }, "com.amazonaws.imagebuilder#EbsInstanceBlockDeviceSpecification": { "type": "structure", "members": { "encrypted": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether to encrypt the device.

" } }, "deleteOnTermination": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether to delete the associated device on termination.

" } }, "iops": { "target": "com.amazonaws.imagebuilder#EbsIopsInteger", "traits": { "smithy.api#documentation": "

The IOPS value for the device. Required only when volumeType is io1 or io2.

" } }, "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. \n\t\t\tThis can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide.

" } }, "snapshotId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The snapshot that defines the device contents.

" } }, "volumeSize": { "target": "com.amazonaws.imagebuilder#EbsVolumeSizeInteger", "traits": { "smithy.api#documentation": "

Overrides the volume size for the device.

" } }, "volumeType": { "target": "com.amazonaws.imagebuilder#EbsVolumeType", "traits": { "smithy.api#documentation": "

Overrides the volume type for the device.

" } }, "throughput": { "target": "com.amazonaws.imagebuilder#EbsVolumeThroughput", "traits": { "smithy.api#documentation": "

\n For GP3 volumes only \u2013 The throughput in MiB/s\n\t\t\tthat the volume supports.

" } } }, "traits": { "smithy.api#documentation": "

Amazon EBS-specific block device mapping specifications.

" } }, "com.amazonaws.imagebuilder#EbsIopsInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 100, "max": 64000 } } }, "com.amazonaws.imagebuilder#EbsVolumeSizeInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 16000 } } }, "com.amazonaws.imagebuilder#EbsVolumeThroughput": { "type": "integer", "traits": { "smithy.api#range": { "min": 125, "max": 1000 } } }, "com.amazonaws.imagebuilder#EbsVolumeType": { "type": "enum", "members": { "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "standard" } }, "IO1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "io1" } }, "IO2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "io2" } }, "GP2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "gp2" } }, "GP3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "gp3" } }, "SC1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "sc1" } }, "ST1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "st1" } } } }, "com.amazonaws.imagebuilder#EcrConfiguration": { "type": "structure", "members": { "repositoryName": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the container repository where Image Builder pushes the container\n\t\t\timage for the vulnerability scan. Provide the repository name only (a\n\t\t\tnamespace path is allowed, but not the registry hostname); the repository\n\t\t\tmust already exist in your account. If you don't specify a repository\n\t\t\tname, Image Builder creates the default repository\n\t\t\timage-builder-image-scanning-repository in your account.

" } }, "containerTags": { "target": "com.amazonaws.imagebuilder#StringList", "traits": { "smithy.api#documentation": "

Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can\n\t\t\thelp you identify and manage your scanned images.

" } } }, "traits": { "smithy.api#documentation": "

Settings that Image Builder uses to configure the ECR repository and the output container\n\t\t\timages that Amazon Inspector scans.

" } }, "com.amazonaws.imagebuilder#EmptyString": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 0 } } }, "com.amazonaws.imagebuilder#ErrorMessage": { "type": "string" }, "com.amazonaws.imagebuilder#FastLaunchConfiguration": { "type": "structure", "members": { "enabled": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether to enable Windows fast launch on the output AMI during\n\t\t\tdistribution. A value of false means Image Builder takes no\n\t\t\tfast-launch action for this configuration.

", "smithy.api#required": {} } }, "snapshotConfiguration": { "target": "com.amazonaws.imagebuilder#FastLaunchSnapshotConfiguration", "traits": { "smithy.api#documentation": "

Configuration settings for managing the number of snapshots that are created from\n\t\t\tpre-provisioned instances for the Windows AMI when Windows fast launch is enabled.

" } }, "maxParallelLaunches": { "target": "com.amazonaws.imagebuilder#MaxParallelLaunches", "traits": { "smithy.api#documentation": "

The maximum number of parallel instances that are launched for creating\n\t\t\tresources.

" } }, "launchTemplate": { "target": "com.amazonaws.imagebuilder#FastLaunchLaunchTemplateSpecification", "traits": { "smithy.api#documentation": "

The launch template that the fast-launch enabled Windows AMI uses when it launches\n\t\t\tWindows instances to create pre-provisioned snapshots.

" } }, "accountId": { "target": "com.amazonaws.imagebuilder#AccountId", "traits": { "smithy.api#documentation": "

The owner account ID for the fast-launch enabled Windows AMI.

" } } }, "traits": { "smithy.api#documentation": "

Defines and configures EC2 Fast Launch for output Windows AMIs.

" } }, "com.amazonaws.imagebuilder#FastLaunchConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#FastLaunchConfiguration" }, "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.imagebuilder#FastLaunchLaunchTemplateSpecification": { "type": "structure", "members": { "launchTemplateId": { "target": "com.amazonaws.imagebuilder#LaunchTemplateId", "traits": { "smithy.api#documentation": "

The ID of the launch template to use for Windows fast launch for a Windows AMI.

" } }, "launchTemplateName": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the launch template to use for Windows fast launch for a Windows AMI.

" } }, "launchTemplateVersion": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The version of the launch template to use for Windows fast launch for a Windows\n\t\t\tAMI.

" } } }, "traits": { "smithy.api#documentation": "

Identifies the launch template that the associated Windows AMI uses for launching an\n\t\t\tinstance when Windows fast launch is enabled.

\n \n

You can specify either the launchTemplateName or the\n\t\t\t\t\tlaunchTemplateId, but not both.

\n
" } }, "com.amazonaws.imagebuilder#FastLaunchSnapshotConfiguration": { "type": "structure", "members": { "targetResourceCount": { "target": "com.amazonaws.imagebuilder#TargetResourceCount", "traits": { "smithy.api#documentation": "

The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled\n\t\t\tWindows AMI.

" } } }, "traits": { "smithy.api#documentation": "

Configuration settings for creating and managing pre-provisioned snapshots for a\n\t\t\tfast-launch enabled Windows AMI.

" } }, "com.amazonaws.imagebuilder#Filter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#FilterName", "traits": { "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

\n

The name filter matches the name that you gave the resource\n\t\t\twhen you created it, exactly as you entered it. It doesn't match the name\n\t\t\tsegment of the resource ARN, which Image Builder converts to lowercase with hyphens\n\t\t\tin place of spaces and underscores. For example, a resource named My Image has\n\t\t\tan ARN that contains my-image \u2013 filter on\n\t\t\tMy Image to find it.

" } }, "values": { "target": "com.amazonaws.imagebuilder#FilterValues", "traits": { "smithy.api#documentation": "

The filter values. Filter values are case-sensitive.

\n

The name filter can use a wildcard: web* matches names that\n\t\t\tbegin with web, and *web* matches names that contain\n\t\t\tweb. The wildcard isn't supported in other positions or in other\n\t\t\tfilters.

" } } }, "traits": { "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results\n\t\t\tfrom a list operation. Filters can be used to match a set of resources by specific\n\t\t\tcriteria, such as tags, attributes, or IDs.

" } }, "com.amazonaws.imagebuilder#FilterList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#Filter" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.imagebuilder#FilterName": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z]{1,1024}$" } }, "com.amazonaws.imagebuilder#FilterValue": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9a-zA-Z./_ :,{}\"*-]{1,1024}$" } }, "com.amazonaws.imagebuilder#FilterValues": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#FilterValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.imagebuilder#ForbiddenException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

You are not authorized to perform the requested operation.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.imagebuilder#GetComponent": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetComponentRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetComponentResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves a component object.

", "smithy.api#examples": [ { "title": "Get the details of a component build version", "documentation": "The following example retrieves a component build version. The data field in the response contains the YAML document that defines the component.", "input": { "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1" }, "output": { "requestId": "f5401098-035f-4be2-9eee-784c388ed04b", "component": { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1", "name": "my-example-component", "version": "1.0.0", "description": "Installs the latest version of my application", "changeDescription": "Initial version", "type": "BUILD", "platform": "Linux", "state": { "status": "ACTIVE" }, "owner": "111122223333", "data": "name: InstallMyApp\ndescription: Installs my application\nschemaVersion: 1.0\nphases:\n - name: build\n steps:\n - name: InstallApp\n action: ExecuteBash\n inputs:\n commands:\n - sudo yum -y install my-app\n", "encrypted": true, "dateCreated": "2026-09-09T18:31:30.404Z" }, "latestVersionReferences": { "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/x.x.x", "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0" } } } ], "smithy.api#http": { "method": "GET", "uri": "/GetComponent", "code": 200 } } }, "com.amazonaws.imagebuilder#GetComponentPolicy": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetComponentPolicyRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetComponentPolicyResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves a component policy.

", "smithy.api#examples": [ { "title": "Get the resource policy for a component", "documentation": "The following example retrieves the resource policy that's applied to a component that the owner shared with another account.", "input": { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-shared-component/1.0.0/1" }, "output": { "requestId": "cb458998-6e6f-442a-9325-78c730b80895", "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetComponent\", \"imagebuilder:ListComponents\"], \"Resource\": [\"arn:aws:imagebuilder:us-west-2:111122223333:component/my-shared-component/1.0.0/1\"]}]}" } } ], "smithy.api#http": { "method": "GET", "uri": "/GetComponentPolicy", "code": 200 } } }, "com.amazonaws.imagebuilder#GetComponentPolicyRequest": { "type": "structure", "members": { "componentArn": { "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component whose policy you want to\n\t\t\tretrieve.

", "smithy.api#httpQuery": "componentArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetComponentPolicyResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "policy": { "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", "traits": { "smithy.api#documentation": "

The component policy.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetComponentRequest": { "type": "structure", "members": { "componentBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ComponentVersionArnOrBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that you want to get. You can specify a build\n\t\t\tversion ARN, or a component version ARN. The version can use the\n\t\t\tx wildcard in trailing positions, for example\n\t\t\t1.0.x or 1.x.x. Version ARNs resolve to the\n\t\t\tlatest available matching component build version.

", "smithy.api#httpQuery": "componentBuildVersionArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetComponentResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "component": { "target": "com.amazonaws.imagebuilder#Component", "traits": { "smithy.api#documentation": "

The component object specified in the request.

" } }, "latestVersionReferences": { "target": "com.amazonaws.imagebuilder#LatestVersionReferences", "traits": { "smithy.api#documentation": "

A set of wildcard version ARNs that always reference the latest\n\t\t\tversion of the resource. ARNs are included for the latest version overall, and for the latest\n\t\t\tversions within the same major, minor, and patch levels.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetContainerRecipe": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetContainerRecipeRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetContainerRecipeResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves a container recipe.

", "smithy.api#examples": [ { "title": "Get the details of a container recipe", "documentation": "The following example retrieves the details of the specified container recipe.", "input": { "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0" }, "output": { "requestId": "15b03ca7-050f-46d4-945e-00232cff6b19", "containerRecipe": { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0", "containerType": "DOCKER", "name": "my-example-container-recipe", "description": "A container recipe that installs my application on Amazon Linux", "platform": "Linux", "owner": "111122223333", "version": "1.0.0", "components": [ { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-container-component/1.0.0/1" } ], "dockerfileTemplateData": "FROM {{{ imagebuilder:parentImage }}}\n{{{ imagebuilder:environments }}}\n{{{ imagebuilder:components }}}\n", "encrypted": true, "parentImage": "amazonlinux:latest", "dateCreated": "2026-09-09T19:32:53.983Z", "targetRepository": { "service": "ECR", "repositoryName": "my-example-container-repo" } }, "latestVersionReferences": { "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/x.x.x", "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0" } } } ], "smithy.api#http": { "method": "GET", "uri": "/GetContainerRecipe", "code": 200 } } }, "com.amazonaws.imagebuilder#GetContainerRecipePolicy": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetContainerRecipePolicyRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetContainerRecipePolicyResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves the policy for a container recipe.

", "smithy.api#examples": [ { "title": "Get the policy attached to a container recipe", "documentation": "The following example retrieves the resource policy for a container recipe that you shared with another AWS account. The policy property contains the resource-based policy document as a JSON-encoded string.", "input": { "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe-shared/1.0.0" }, "output": { "requestId": "1b8334a0-5ae7-4c3c-8092-5d589dab7a2b", "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Sid\": \"AllowSharedAccountContainerRecipeAccess\", \"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetContainerRecipe\", \"imagebuilder:ListContainerRecipes\"], \"Resource\": \"arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe-shared/1.0.0\"}]}" } } ], "smithy.api#http": { "method": "GET", "uri": "/GetContainerRecipePolicy", "code": 200 } } }, "com.amazonaws.imagebuilder#GetContainerRecipePolicyRequest": { "type": "structure", "members": { "containerRecipeArn": { "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe for the policy being\n\t\t\trequested.

", "smithy.api#httpQuery": "containerRecipeArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetContainerRecipePolicyResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "policy": { "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", "traits": { "smithy.api#documentation": "

The resource policy for the container recipe, as a JSON policy document. If\n\t\t\tno policy has been applied, the response contains an empty JSON object\n\t\t\t({}).

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetContainerRecipeRequest": { "type": "structure", "members": { "containerRecipeArn": { "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "containerRecipeArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetContainerRecipeResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "containerRecipe": { "target": "com.amazonaws.imagebuilder#ContainerRecipe", "traits": { "smithy.api#documentation": "

The container recipe object that is returned.

" } }, "latestVersionReferences": { "target": "com.amazonaws.imagebuilder#LatestVersionReferences", "traits": { "smithy.api#documentation": "

A set of wildcard version ARNs that always reference the latest\n\t\t\tversion of the resource. ARNs are included for the latest version overall, and for the latest\n\t\t\tversions within the same major, minor, and patch levels.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetDistributionConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetDistributionConfigurationRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetDistributionConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves a distribution configuration.

", "smithy.api#examples": [ { "title": "Get the details of a distribution configuration", "documentation": "The following example retrieves a distribution configuration that distributes the output AMI to two Regions.", "input": { "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution" }, "output": { "requestId": "2d0a8dc0-99d5-4d7a-af7a-d1aeafd71c2e", "distributionConfiguration": { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution", "name": "my-example-distribution", "description": "Copies the output AMI to a second Region", "distributions": [ { "region": "us-west-2", "amiDistributionConfiguration": { "name": "my-example-image-{{ imagebuilder:buildDate }}" } }, { "region": "us-east-1", "amiDistributionConfiguration": { "name": "my-example-image-{{ imagebuilder:buildDate }}" } } ], "dateCreated": "2026-09-09T19:37:37.231Z", "timeoutMinutes": 720 } } } ], "smithy.api#http": { "method": "GET", "uri": "/GetDistributionConfiguration", "code": 200 } } }, "com.amazonaws.imagebuilder#GetDistributionConfigurationRequest": { "type": "structure", "members": { "distributionConfigurationArn": { "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that you want to\n\t\t\tretrieve.

", "smithy.api#httpQuery": "distributionConfigurationArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetDistributionConfigurationResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "distributionConfiguration": { "target": "com.amazonaws.imagebuilder#DistributionConfiguration", "traits": { "smithy.api#documentation": "

The distribution configuration object.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetImage": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetImageRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetImageResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves an image.

", "smithy.api#examples": [ { "title": "Check the status of an image build", "documentation": "The following example retrieves an image build version to check its status while the build is running. The response is shortened to show a subset of the fields that Image Builder returns.", "input": { "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "output": { "requestId": "4be892f0-e1d1-47f9-8bc1-d08ec5dec640", "image": { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "type": "AMI", "name": "my-example-recipe", "version": "1.0.0/1", "platform": "Linux", "enhancedImageMetadataEnabled": true, "state": { "status": "BUILDING" }, "sourcePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "dateCreated": "2026-09-03T05:44:21.121Z" } } } ], "smithy.api#http": { "method": "GET", "uri": "/GetImage", "code": 200 }, "smithy.waiters#waitable": { "ImageAvailable": { "documentation": "Wait until an image build version reaches the AVAILABLE state, meaning the build completed, including distribution and integration of output resources. The waiter fails if the image reaches the FAILED or CANCELLED state. Specify the full image build version ARN; wildcard version ARNs only resolve to images that are already available.", "acceptors": [ { "state": "success", "matcher": { "output": { "path": "image.state.status", "expected": "AVAILABLE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "image.state.status", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "image.state.status", "expected": "CANCELLED", "comparator": "stringEquals" } } } ], "minDelay": 60 } } } }, "com.amazonaws.imagebuilder#GetImagePipeline": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetImagePipelineRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetImagePipelineResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves an image pipeline.

", "smithy.api#examples": [ { "title": "Get the details of an image pipeline", "documentation": "The following example retrieves an image pipeline that builds a new image every Sunday, including the image tests configuration and schedule start condition defaults that Image Builder applied at creation.", "input": { "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline" }, "output": { "requestId": "b7e58d62-36dc-43a5-87ff-546e04cdabf1", "imagePipeline": { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "name": "my-example-pipeline", "description": "Builds an Amazon Linux 2023 image every Sunday", "platform": "Linux", "enhancedImageMetadataEnabled": true, "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "imageTestsConfiguration": { "imageTestsEnabled": true, "timeoutMinutes": 720 }, "schedule": { "scheduleExpression": "cron(0 0 ? * SUN *)", "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" }, "status": "ENABLED", "dateCreated": "2026-09-09T19:38:26.574Z", "dateUpdated": "2026-09-09T19:38:26.574Z" } } } ], "smithy.api#http": { "method": "GET", "uri": "/GetImagePipeline", "code": 200 } } }, "com.amazonaws.imagebuilder#GetImagePipelineRequest": { "type": "structure", "members": { "imagePipelineArn": { "target": "com.amazonaws.imagebuilder#ImagePipelineArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.

", "smithy.api#httpQuery": "imagePipelineArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetImagePipelineResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "imagePipeline": { "target": "com.amazonaws.imagebuilder#ImagePipeline", "traits": { "smithy.api#documentation": "

The image pipeline object.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetImagePolicy": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetImagePolicyRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetImagePolicyResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves an image policy.

", "smithy.api#examples": [ { "title": "Retrieve the resource policy for an image", "documentation": "The following example retrieves the resource policy for an image build version that was shared with account 444455556666.", "input": { "imageArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "output": { "requestId": "bc0c8348-c0d9-452a-af20-2640430df585", "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetImage\", \"imagebuilder:ListImages\"], \"Resource\": [\"arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1\"]}]}" } } ], "smithy.api#http": { "method": "GET", "uri": "/GetImagePolicy", "code": 200 } } }, "com.amazonaws.imagebuilder#GetImagePolicyRequest": { "type": "structure", "members": { "imageArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.

", "smithy.api#httpQuery": "imageArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetImagePolicyResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "policy": { "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", "traits": { "smithy.api#documentation": "

The resource policy for the image, as a JSON policy document. If the image\n\t\t\thas no policy applied, the response contains an empty JSON object\n\t\t\t({}).

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetImageRecipe": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetImageRecipeRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetImageRecipeResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves an image recipe.

", "smithy.api#examples": [ { "title": "Get the details of an image recipe", "documentation": "The following example retrieves the full definition of an image recipe, including the components it applies and the base image it builds on.", "input": { "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-app-recipe/1.0.0" }, "output": { "requestId": "adb3ff9a-df84-4b4e-8ecf-11d38281ead7", "imageRecipe": { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-app-recipe/1.0.0", "name": "my-example-app-recipe", "description": "An image recipe that installs my application on Amazon Linux 2023", "platform": "Linux", "owner": "111122223333", "version": "1.0.0", "components": [ { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-app/1.0.0/1" } ], "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2023-x86/x.x.x", "dateCreated": "2026-09-09T19:30:21.183Z", "workingDirectory": "/tmp" }, "latestVersionReferences": { "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-app-recipe/x.x.x", "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-app-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-app-recipe/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-app-recipe/1.0.0" } } } ], "smithy.api#http": { "method": "GET", "uri": "/GetImageRecipe", "code": 200 } } }, "com.amazonaws.imagebuilder#GetImageRecipePolicy": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetImageRecipePolicyRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetImageRecipePolicyResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves an image recipe policy.

", "smithy.api#examples": [ { "title": "Get the resource policy for an image recipe", "documentation": "The following example retrieves the resource policy that's applied to the specified image recipe.", "input": { "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0" }, "output": { "requestId": "0cf42efc-4b2c-4ba3-b6e3-542a796fffaf", "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetImageRecipe\", \"imagebuilder:ListImageRecipes\"], \"Resource\": \"arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0\"}]}" } } ], "smithy.api#http": { "method": "GET", "uri": "/GetImageRecipePolicy", "code": 200 } } }, "com.amazonaws.imagebuilder#GetImageRecipePolicyRequest": { "type": "structure", "members": { "imageRecipeArn": { "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe whose policy you want to\n\t\t\tretrieve.

", "smithy.api#httpQuery": "imageRecipeArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetImageRecipePolicyResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "policy": { "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", "traits": { "smithy.api#documentation": "

The resource policy for the image recipe, as a JSON policy document. If no\n\t\t\tpolicy has been applied, the response contains an empty JSON object\n\t\t\t({}).

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetImageRecipeRequest": { "type": "structure", "members": { "imageRecipeArn": { "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that you want to retrieve. You can use the\n\t\t\tx wildcard in trailing version positions to retrieve the latest\n\t\t\tmatching version, for example x.x.x or 1.x.x.

", "smithy.api#httpQuery": "imageRecipeArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetImageRecipeResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "imageRecipe": { "target": "com.amazonaws.imagebuilder#ImageRecipe", "traits": { "smithy.api#documentation": "

The image recipe object.

" } }, "latestVersionReferences": { "target": "com.amazonaws.imagebuilder#LatestVersionReferences", "traits": { "smithy.api#documentation": "

A set of wildcard version ARNs that always reference the latest\n\t\t\tversion of the resource. ARNs are included for the latest version overall, and for the latest\n\t\t\tversions within the same major, minor, and patch levels.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetImageRequest": { "type": "structure", "members": { "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageVersionArnOrBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that you want to get. You can specify a full build\n\t\t\tversion ARN, or a version ARN with or without wildcards\n\t\t\t(x.x.x, 1.x.x, or 1.0.x). A version or\n\t\t\twildcard ARN resolves to the latest matching build version that has reached\n\t\t\tAVAILABLE status. Builds that were later deprecated, disabled,\n\t\t\tor deleted don't resolve. To get an image in any other state, such as a\n\t\t\tfailed or in-progress build, specify the full build version ARN.

", "smithy.api#httpQuery": "imageBuildVersionArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetImageResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "image": { "target": "com.amazonaws.imagebuilder#Image", "traits": { "smithy.api#documentation": "

The image object.

" } }, "latestVersionReferences": { "target": "com.amazonaws.imagebuilder#LatestVersionReferences", "traits": { "smithy.api#documentation": "

A set of wildcard version ARNs that always reference the latest\n\t\t\tversion of the resource. ARNs are included for the latest version overall, and for the latest\n\t\t\tversions within the same major, minor, and patch levels.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetInfrastructureConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetInfrastructureConfigurationRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetInfrastructureConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves an infrastructure configuration.

", "smithy.api#examples": [ { "title": "Get the details of an infrastructure configuration", "documentation": "The following example retrieves an infrastructure configuration that specifies the instance types, instance profile, and instance metadata options that Image Builder uses for build and test instances.", "input": { "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure-configuration" }, "output": { "requestId": "7ba25cd0-0735-4f44-bc67-2f231e96503f", "infrastructureConfiguration": { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure-configuration", "name": "my-example-infrastructure-configuration", "description": "Infrastructure configuration for my application image builds", "instanceTypes": [ "m5.large", "m5.xlarge" ], "instanceProfileName": "EC2InstanceProfileForImageBuilder", "terminateInstanceOnFailure": true, "dateCreated": "2026-09-09T19:36:48.933Z", "resourceTags": { "CostCenter": "12345" }, "instanceMetadataOptions": { "httpTokens": "required", "httpPutResponseHopLimit": 2 }, "tags": { "Environment": "test" } } } } ], "smithy.api#http": { "method": "GET", "uri": "/GetInfrastructureConfiguration", "code": 200 } } }, "com.amazonaws.imagebuilder#GetInfrastructureConfigurationRequest": { "type": "structure", "members": { "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to\n\t\t\tretrieve.

", "smithy.api#httpQuery": "infrastructureConfigurationArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

GetInfrastructureConfiguration request object.

", "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetInfrastructureConfigurationResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "infrastructureConfiguration": { "target": "com.amazonaws.imagebuilder#InfrastructureConfiguration", "traits": { "smithy.api#documentation": "

The infrastructure configuration object.

" } } }, "traits": { "smithy.api#documentation": "

GetInfrastructureConfiguration response object.

", "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetLifecycleExecution": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetLifecycleExecutionRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetLifecycleExecutionResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves runtime information for a lifecycle execution \u2013 a single run of\n\t\t\tlifecycle actions that a lifecycle policy or a\n\t\t\tStartResourceStateUpdate request started.

", "smithy.api#examples": [ { "title": "Get the details of a lifecycle execution", "documentation": "The following example retrieves the runtime status of the specified lifecycle execution. If the execution was started by StartResourceStateUpdate rather than a lifecycle policy run, the response doesn't include the lifecyclePolicyArn field.", "input": { "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503" }, "output": { "lifecycleExecution": { "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503", "resourcesImpactedSummary": { "hasImpactedResources": false }, "state": { "status": "IN_PROGRESS" }, "startTime": "2026-09-09T21:42:29Z" } } } ], "smithy.api#http": { "method": "GET", "uri": "/GetLifecycleExecution", "code": 200 } } }, "com.amazonaws.imagebuilder#GetLifecycleExecutionRequest": { "type": "structure", "members": { "lifecycleExecutionId": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", "traits": { "smithy.api#documentation": "

The unique identifier for a runtime instance of the lifecycle policy.

", "smithy.api#httpQuery": "lifecycleExecutionId", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetLifecycleExecutionResponse": { "type": "structure", "members": { "lifecycleExecution": { "target": "com.amazonaws.imagebuilder#LifecycleExecution", "traits": { "smithy.api#documentation": "

Runtime details for the specified runtime instance of the lifecycle policy.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves details for the specified image lifecycle policy.

", "smithy.api#examples": [ { "title": "Get the details of a lifecycle policy", "documentation": "The following example retrieves the full definition of the specified lifecycle policy.", "input": { "lifecyclePolicyArn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-lifecycle-policy" }, "output": { "lifecyclePolicy": { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-lifecycle-policy", "name": "my-example-lifecycle-policy", "description": "Deletes AMIs and snapshots for builds older than six months, keeping at least the five most recent", "status": "ENABLED", "executionRole": "arn:aws:iam::111122223333:role/my-example-lifecycle-role", "resourceType": "AMI_IMAGE", "policyDetails": [ { "action": { "type": "DELETE", "includeResources": { "amis": true, "snapshots": true } }, "filter": { "type": "AGE", "value": 6, "unit": "MONTHS", "retainAtLeast": 5 } } ], "resourceSelection": { "tagMap": { "Environment": "my-example-environment" } }, "dateCreated": "2026-09-09T19:34:38Z" } } } ], "smithy.api#http": { "method": "GET", "uri": "/GetLifecyclePolicy", "code": 200 } } }, "com.amazonaws.imagebuilder#GetLifecyclePolicyRequest": { "type": "structure", "members": { "lifecyclePolicyArn": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", "traits": { "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the image lifecycle policy resource to get.

", "smithy.api#httpQuery": "lifecyclePolicyArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetLifecyclePolicyResponse": { "type": "structure", "members": { "lifecyclePolicy": { "target": "com.amazonaws.imagebuilder#LifecyclePolicy", "traits": { "smithy.api#documentation": "

The details of the lifecycle policy that the request retrieved.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetMarketplaceResource": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetMarketplaceResourceRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetMarketplaceResourceResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Verifies the subscription and performs resource dependency checks on the\n\t\t\trequested Amazon Web Services Marketplace resource. The caller must be entitled to the resource. For\n\t\t\tAmazon Web Services Marketplace components, the response contains fields to download the components\n\t\t\tand their artifacts.

", "smithy.api#http": { "method": "POST", "uri": "/GetMarketplaceResource", "code": 200 } } }, "com.amazonaws.imagebuilder#GetMarketplaceResourceRequest": { "type": "structure", "members": { "resourceType": { "target": "com.amazonaws.imagebuilder#MarketplaceResourceType", "traits": { "smithy.api#documentation": "

Specifies which type of Amazon Web Services Marketplace resource Image Builder retrieves.

", "smithy.api#required": {} } }, "resourceArn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies an Amazon Web Services Marketplace resource.

", "smithy.api#required": {} } }, "resourceLocation": { "target": "com.amazonaws.imagebuilder#MarketplaceResourceLocation", "traits": { "smithy.api#documentation": "

The Amazon S3 location of the component artifact to retrieve, in\n\t\t\ts3://bucket/key form.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetMarketplaceResourceResponse": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Amazon Web Services Marketplace resource that was requested.

" } }, "url": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

A time-limited presigned URL for downloading the component artifact from\n\t\t\tAmazon S3.

" } }, "data": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Returns obfuscated data that contains the YAML content of the component.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetWorkflow": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetWorkflowRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetWorkflowResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves a workflow resource object.

", "smithy.api#examples": [ { "title": "Get the details of a workflow build version", "documentation": "The following example retrieves a workflow build version. The response includes the YAML workflow document in the data field and the parameters that Image Builder extracted from it when the workflow was created.", "input": { "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1" }, "output": { "workflow": { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1", "name": "my-example-workflow", "version": "1.0.0", "description": "Builds an AMI, and then waits for an external action before the workflow completes", "changeDescription": "Initial version", "type": "BUILD", "owner": "111122223333", "data": "name: my-example-workflow\ndescription: Workflow to build an AMI, then wait for an external action before it completes\nschemaVersion: 1.0\n\nparameters:\n - name: waitForActionAtEnd\n type: boolean\n default: true\n\nsteps:\n - name: LaunchBuildInstance\n action: LaunchInstance\n onFailure: Abort\n inputs:\n waitFor: \"ssmAgent\"\n\n - name: ApplyBuildComponents\n action: ExecuteComponents\n onFailure: Abort\n inputs:\n instanceId.$: \"$.stepOutputs.LaunchBuildInstance.instanceId\"\n\n - name: CreateOutputAMI\n action: CreateImage\n onFailure: Abort\n inputs:\n instanceId.$: \"$.stepOutputs.LaunchBuildInstance.instanceId\"\n\n - name: TerminateBuildInstance\n action: TerminateInstance\n onFailure: Continue\n inputs:\n instanceId.$: \"$.stepOutputs.LaunchBuildInstance.instanceId\"\n\n - name: WaitForActionAtEnd\n action: WaitForAction\n if:\n booleanEquals: true\n value: \"$.parameters.waitForActionAtEnd\"\n", "dateCreated": "2026-09-09T19:55:55.731Z", "parameters": [ { "name": "waitForActionAtEnd", "type": "boolean", "defaultValue": [ "true" ] } ] }, "latestVersionReferences": { "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/x.x.x", "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0" } } } ], "smithy.api#http": { "method": "GET", "uri": "/GetWorkflow", "code": 200 } } }, "com.amazonaws.imagebuilder#GetWorkflowExecution": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetWorkflowExecutionRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetWorkflowExecutionResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves runtime information for a specific runtime instance \n\t\t\tof the workflow.

", "smithy.api#examples": [ { "title": "Get the runtime details for a workflow execution", "documentation": "The following example retrieves runtime status and step counts for the build workflow that ran for an image build version, using the workflow execution ID returned by ListWorkflowExecutions.", "input": { "workflowExecutionId": "wf-165b1cb6-3a62-4618-a021-94ddcbe32908" }, "output": { "requestId": "cd69c813-51c3-4261-8e59-382a1af96f73", "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:aws:workflow/build/build-image/1.0.3/1", "workflowExecutionId": "wf-165b1cb6-3a62-4618-a021-94ddcbe32908", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "type": "BUILD", "status": "COMPLETED", "totalStepCount": 7, "totalStepsSucceeded": 5, "totalStepsFailed": 0, "totalStepsSkipped": 2, "startTime": "2026-09-09T19:12:23.175Z", "endTime": "2026-09-09T19:19:06.158Z" } } ], "smithy.api#http": { "method": "GET", "uri": "/GetWorkflowExecution", "code": 200 } } }, "com.amazonaws.imagebuilder#GetWorkflowExecutionRequest": { "type": "structure", "members": { "workflowExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", "traits": { "smithy.api#documentation": "

Use the unique identifier for a runtime instance of the workflow to get \n\t\t\truntime details.

", "smithy.api#httpQuery": "workflowExecutionId", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetWorkflowExecutionResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "workflowBuildVersionArn": { "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource \n\t\t\tthat defines the specified runtime instance of the workflow.

" } }, "workflowExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", "traits": { "smithy.api#documentation": "

The unique identifier that Image Builder assigned to keep track of runtime details\n\t\t\twhen it ran the workflow.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image build version that owns the specified runtime\n\t\t\tinstance of the workflow.

" } }, "type": { "target": "com.amazonaws.imagebuilder#WorkflowType", "traits": { "smithy.api#documentation": "

The type of workflow that Image Builder ran for the specified runtime instance of the workflow.

" } }, "status": { "target": "com.amazonaws.imagebuilder#WorkflowExecutionStatus", "traits": { "smithy.api#documentation": "

The current runtime status for the specified runtime instance of the workflow.\n\t\t\tCOMPLETED, FAILED, ROLLBACK_COMPLETED,\n\t\t\tCANCELLED, and SKIPPED are terminal states.

" } }, "message": { "target": "com.amazonaws.imagebuilder#WorkflowExecutionMessage", "traits": { "smithy.api#documentation": "

The output message from the specified runtime instance of the workflow, if applicable.

" } }, "totalStepCount": { "target": "com.amazonaws.imagebuilder#WorkflowStepCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The total number of steps that the workflow document defines for this runtime\n\t\t\tinstance of the workflow. Image Builder sets this count before any steps run. The sum of\n\t\t\tsucceeded, skipped, and failed steps only reaches this total if every step\n\t\t\tfinishes in one of those states.

" } }, "totalStepsSucceeded": { "target": "com.amazonaws.imagebuilder#WorkflowStepCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

A runtime count for the number of steps that ran successfully in the specified runtime \n\t\t\tinstance of the workflow.

" } }, "totalStepsFailed": { "target": "com.amazonaws.imagebuilder#WorkflowStepCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

A runtime count for the number of steps that failed in the specified runtime instance \n\t\t\tof the workflow.

" } }, "totalStepsSkipped": { "target": "com.amazonaws.imagebuilder#WorkflowStepCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

A runtime count for the number of steps that were skipped in the specified runtime \n\t\t\tinstance of the workflow.

" } }, "startTime": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the specified runtime instance of the workflow started.

" } }, "endTime": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the specified runtime instance of the workflow finished.

" } }, "parallelGroup": { "target": "com.amazonaws.imagebuilder#ParallelGroup", "traits": { "smithy.api#documentation": "

The name of the parallel group that this runtime instance of the workflow\n\t\t\tran in, if configured. Parallel groups apply only to test workflows.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetWorkflowRequest": { "type": "structure", "members": { "workflowBuildVersionArn": { "target": "com.amazonaws.imagebuilder#WorkflowVersionArnOrBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource that you want to get. You can specify a\n\t\t\tbuild version ARN, or a version ARN with or without wildcards (x)\n\t\t\tin its version segments. Image Builder resolves version and wildcard ARNs to the most\n\t\t\trecent matching build version.

", "smithy.api#httpQuery": "workflowBuildVersionArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetWorkflowResponse": { "type": "structure", "members": { "workflow": { "target": "com.amazonaws.imagebuilder#Workflow", "traits": { "smithy.api#documentation": "

The workflow resource specified in the request.

" } }, "latestVersionReferences": { "target": "com.amazonaws.imagebuilder#LatestVersionReferences", "traits": { "smithy.api#documentation": "

A set of wildcard version ARNs that always reference the latest\n\t\t\tversion of the resource. ARNs are included for the latest version overall, and for the latest\n\t\t\tversions within the same major, minor, and patch levels.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#GetWorkflowStepExecution": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#GetWorkflowStepExecutionRequest" }, "output": { "target": "com.amazonaws.imagebuilder#GetWorkflowStepExecutionResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves runtime information for a specific runtime instance of \n\t\t\tthe workflow step.

", "smithy.api#examples": [ { "title": "Get the runtime details of a workflow step", "documentation": "The following example retrieves runtime details for the step that launched the build instance during an image build, with the step's input parameters and output values returned as JSON-encoded strings.", "input": { "stepExecutionId": "step-2e6fef0d-657c-4b7e-8706-ff24da9afa01" }, "output": { "requestId": "9ba63d27-9568-4ea3-bfed-6b1ad4c09200", "stepExecutionId": "step-2e6fef0d-657c-4b7e-8706-ff24da9afa01", "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:aws:workflow/build/build-image/1.0.3/1", "workflowExecutionId": "wf-165b1cb6-3a62-4618-a021-94ddcbe32908", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "name": "LaunchBuildInstance", "action": "LaunchInstance", "status": "COMPLETED", "inputs": "{\"waitFor\": \"ssmAgent\"}", "outputs": "{\"instanceId\": \"i-1234567890abcdef0\"}", "startTime": "2026-09-09T19:12:23.418Z", "endTime": "2026-09-09T19:14:50.822Z", "onFailure": "Abort", "timeoutSeconds": 4500 } } ], "smithy.api#http": { "method": "GET", "uri": "/GetWorkflowStepExecution", "code": 200 } } }, "com.amazonaws.imagebuilder#GetWorkflowStepExecutionRequest": { "type": "structure", "members": { "stepExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionId", "traits": { "smithy.api#documentation": "

The unique identifier for the runtime instance of the workflow step that you\n\t\t\twant to get runtime details for. To get the identifiers for the steps that ran\n\t\t\tin a workflow, call ListWorkflowStepExecutions.

", "smithy.api#httpQuery": "stepExecutionId", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#GetWorkflowStepExecutionResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "stepExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionId", "traits": { "smithy.api#documentation": "

The unique identifier for the runtime instance of the workflow step that you specified\n\t\t\tin the request.

" } }, "workflowBuildVersionArn": { "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource\n\t\t\tthat defines this workflow step.

" } }, "workflowExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", "traits": { "smithy.api#documentation": "

The unique identifier that Image Builder assigned to keep track of runtime details\n\t\t\twhen it ran the workflow.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image build version that owns the specified runtime\n\t\t\tinstance of the workflow step.

" } }, "name": { "target": "com.amazonaws.imagebuilder#WorkflowStepName", "traits": { "smithy.api#documentation": "

The name of the specified runtime instance of the workflow step.

" } }, "description": { "target": "com.amazonaws.imagebuilder#WorkflowStepDescription", "traits": { "smithy.api#documentation": "

Describes the specified workflow step.

" } }, "action": { "target": "com.amazonaws.imagebuilder#WorkflowStepAction", "traits": { "smithy.api#documentation": "

The name of the action that the specified step performs.

" } }, "status": { "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionStatus", "traits": { "smithy.api#documentation": "

The current status for the specified runtime instance of the workflow step.

" } }, "rollbackStatus": { "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionRollbackStatus", "traits": { "smithy.api#documentation": "

Reports on the rollback status of the specified runtime instance of the\n\t\t\tworkflow step, if applicable. Rollback runs when the workflow execution fails,\n\t\t\tand undoes the work that completed steps performed.

" } }, "message": { "target": "com.amazonaws.imagebuilder#WorkflowStepMessage", "traits": { "smithy.api#documentation": "

The output message from the specified runtime instance of the workflow step, if applicable.

" } }, "inputs": { "target": "com.amazonaws.imagebuilder#WorkflowStepInputs", "traits": { "smithy.api#documentation": "

Input parameters that Image Builder provided for the specified runtime instance of\n\t\t\tthe workflow step, as a JSON-encoded string.

" } }, "outputs": { "target": "com.amazonaws.imagebuilder#WorkflowStepOutputs", "traits": { "smithy.api#documentation": "

The output values that the specified runtime instance of the workflow step\n\t\t\tproduced, as a JSON-encoded string. For example, a step that launches an\n\t\t\tinstance outputs the instance ID. If the step failed, this field contains the\n\t\t\terror message.

" } }, "startTime": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the specified runtime instance of the workflow step started.

" } }, "endTime": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the specified runtime instance of the workflow step finished.

" } }, "onFailure": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The action that the workflow takes if this step fails, as configured in the\n\t\t\tworkflow document. Abort fails the workflow and rolls back\n\t\t\tcompleted steps. Continue proceeds to the next step. If the\n\t\t\tstep doesn't set a value, it defaults to Abort.

" } }, "timeoutSeconds": { "target": "com.amazonaws.imagebuilder#WorkflowStepTimeoutSecondsInteger", "traits": { "smithy.api#documentation": "

The maximum duration in seconds for this step to complete its action. If the\n\t\t\tworkflow document doesn't set a timeout for the step, Image Builder applies the\n\t\t\tdefault timeout for the step's action. This field returns that value.

" } }, "attemptNumber": { "target": "com.amazonaws.imagebuilder#WorkflowStepAttemptCount", "traits": { "smithy.api#documentation": "

The current attempt number for the specified runtime instance of the workflow\n\t\t\tstep. The first run is attempt one. The number increases by one for each retry.

" } }, "maxAttempts": { "target": "com.amazonaws.imagebuilder#WorkflowStepAttemptCount", "traits": { "smithy.api#documentation": "

The maximum number of attempts allowed for the specified runtime instance of\n\t\t\tthe workflow step, based on the retry configuration in the workflow document.\n\t\t\tIf the step doesn't configure retries, the maximum is one attempt.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#HttpPutResponseHopLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 64 } } }, "com.amazonaws.imagebuilder#HttpTokens": { "type": "string", "traits": { "smithy.api#pattern": "^optional|required$" } }, "com.amazonaws.imagebuilder#IdempotentParameterMismatchException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

You have specified a client token for an operation using parameter values that differ\n\t\t\tfrom a previous request that used the same client token.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.imagebuilder#Image": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image.

\n \n

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

\n
    \n
  1. \n

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

    \n
  2. \n
  3. \n

    Version ARNs have only the first three nodes: ..

    \n
  4. \n
  5. \n

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

    \n
  6. \n
\n
" } }, "type": { "target": "com.amazonaws.imagebuilder#ImageType", "traits": { "smithy.api#documentation": "

Specifies whether this image produces an AMI or a container image.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the image.

" } }, "version": { "target": "com.amazonaws.imagebuilder#VersionNumberWithBuild", "traits": { "smithy.api#documentation": "

The semantic version of the image.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes, you can assign any positive integer value, including \n\tzero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

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

\n

\n Filtering: You can use wildcards (x) to specify the most recent versions or nodes when \n\tselecting the base image or components for your recipe. When you use a wildcard in any node, all nodes \n\tto the right of the first wildcard must also be wildcards.

\n
" } }, "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

The image operating system platform, such as Linux or Windows.

" } }, "enhancedImageMetadataEnabled": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Indicates whether Image Builder collects additional information about the image, such as \n\t\t\tthe operating system (OS) version and package list.

" } }, "osVersion": { "target": "com.amazonaws.imagebuilder#OsVersion", "traits": { "smithy.api#documentation": "

The operating system version for instances that launch from this image. For example, \n\t\t\tAmazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

" } }, "state": { "target": "com.amazonaws.imagebuilder#ImageState", "traits": { "smithy.api#documentation": "

The state of the image.

" } }, "imageRecipe": { "target": "com.amazonaws.imagebuilder#ImageRecipe", "traits": { "smithy.api#documentation": "

For images that distribute an AMI, this is the image recipe that Image Builder used to \n\t\t\tcreate the image. For container images, this is empty.

" } }, "containerRecipe": { "target": "com.amazonaws.imagebuilder#ContainerRecipe", "traits": { "smithy.api#documentation": "

For container images, this is the container recipe that Image Builder used to create the \n\t\t\timage. For images that distribute an AMI, this is empty.

" } }, "sourcePipelineName": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the image pipeline that created this image. Image Builder doesn't return\n\t\t\tthis field for new images. Use sourcePipelineArn instead.

" } }, "sourcePipelineArn": { "target": "com.amazonaws.imagebuilder#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that created this image. This field is only\n\t\t\tpresent for images that a pipeline execution created.

" } }, "infrastructureConfiguration": { "target": "com.amazonaws.imagebuilder#InfrastructureConfiguration", "traits": { "smithy.api#documentation": "

The infrastructure that Image Builder used to create this image.

" } }, "distributionConfiguration": { "target": "com.amazonaws.imagebuilder#DistributionConfiguration", "traits": { "smithy.api#documentation": "

The distribution configuration that Image Builder used to create this image.

" } }, "imageTestsConfiguration": { "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", "traits": { "smithy.api#documentation": "

The image test settings that Image Builder used when it created this image.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which Image Builder created this image.

" } }, "outputResources": { "target": "com.amazonaws.imagebuilder#OutputResources", "traits": { "smithy.api#documentation": "

The output resources that Image Builder produces for this image.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags that apply to this image.

" } }, "buildType": { "target": "com.amazonaws.imagebuilder#BuildType", "traits": { "smithy.api#documentation": "

Indicates the type of build that created this image. The build can be initiated in the\n\t\t\tfollowing ways:

\n " } }, "imageSource": { "target": "com.amazonaws.imagebuilder#ImageSource", "traits": { "smithy.api#documentation": "

The origin of the base image that Image Builder used to build this image.

" } }, "scanState": { "target": "com.amazonaws.imagebuilder#ImageScanState", "traits": { "smithy.api#documentation": "

Contains information about the current state of scans for this image.

" } }, "imageScanningConfiguration": { "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", "traits": { "smithy.api#documentation": "

The settings that determine whether and how Amazon Inspector scans this\n\t\t\timage.

" } }, "deprecationTime": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The time when deprecation occurs for an image resource. This can be a past or future date.

" } }, "lifecycleExecutionId": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", "traits": { "smithy.api#documentation": "

Identifies the last runtime instance of the lifecycle policy to take action on the image.

" } }, "executionRole": { "target": "com.amazonaws.imagebuilder#RoleNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) for the IAM role you create that grants \n\t\t\tImage Builder access to perform workflow actions.

" } }, "workflows": { "target": "com.amazonaws.imagebuilder#WorkflowConfigurationList", "traits": { "smithy.api#documentation": "

The build, test, and distribution workflow configurations that are\n\t\t\tassociated with the image.

" } }, "loggingConfiguration": { "target": "com.amazonaws.imagebuilder#ImageLoggingConfiguration", "traits": { "smithy.api#documentation": "

The logging configuration that's defined for the image. Image Builder uses the defined settings \n\t\t\tto direct execution log output during image creation.

" } } }, "traits": { "smithy.api#documentation": "

An Image Builder image resource that keeps track of all of the settings used to create,\n\t\t\tconfigure, and distribute output for that image. An image that Image Builder built\n\t\t\tfrom a recipe contains exactly one recipe \u2013 either a container recipe\n\t\t\t(containerRecipe), which creates a container image, or an image\n\t\t\trecipe (imageRecipe), which creates an AMI. Imported images\n\t\t\tdon't contain a recipe.

" } }, "com.amazonaws.imagebuilder#ImageAggregation": { "type": "structure", "members": { "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the image for this aggregation.

" } }, "severityCounts": { "target": "com.amazonaws.imagebuilder#SeverityCounts", "traits": { "smithy.api#documentation": "

Counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings for the specified image.

" } } }, "traits": { "smithy.api#documentation": "

Contains vulnerability counts for a specific image.

" } }, "com.amazonaws.imagebuilder#ImageBuildMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 500 } } }, "com.amazonaws.imagebuilder#ImageBuildVersionArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):image/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" } }, "com.amazonaws.imagebuilder#ImageBuilderArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-9]+))(?:/[0-9]+)?)?$" } }, "com.amazonaws.imagebuilder#ImageConfigurationStep": { "type": "enum", "members": { "ASSOCIATE_LICENSES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSOCIATE_LICENSES" } }, "UPDATE_LAUNCH_TEMPLATES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_LAUNCH_TEMPLATES" } }, "PUT_SSM_PARAMETERS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PUT_SSM_PARAMETERS" } }, "UPDATE_FAST_LAUNCH_CONFIGURATIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_FAST_LAUNCH_CONFIGURATIONS" } }, "EXPORT_AMI": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPORT_AMI" } } } }, "com.amazonaws.imagebuilder#ImageFailureContext": { "type": "structure", "members": { "imageStatus": { "target": "com.amazonaws.imagebuilder#ImageStatus", "traits": { "smithy.api#documentation": "

The status that the image had when the failure occurred. This indicates the stage\n\t\t\tof the image creation process where the image failed, for example\n\t\t\tBUILDING or DISTRIBUTING.

" } }, "workflowExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", "traits": { "smithy.api#documentation": "

The unique identifier of the workflow execution that was running when the image\n\t\t\tfailed.

" } }, "workflowArn": { "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow build version that was running when the image\n\t\t\tfailed.

" } }, "stepExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionId", "traits": { "smithy.api#documentation": "

The unique identifier of the workflow step execution that failed.

" } }, "failedStep": { "target": "com.amazonaws.imagebuilder#WorkflowStepName", "traits": { "smithy.api#documentation": "

The name of the workflow step that failed, as it appears in the workflow\n\t\t\tdocument.

" } }, "componentFailure": { "target": "com.amazonaws.imagebuilder#ComponentFailureContext", "traits": { "smithy.api#documentation": "

The details about the component that failed, if the failure occurred while a\n\t\t\tcomponent was running.

" } }, "distributionFailure": { "target": "com.amazonaws.imagebuilder#DistributionFailureContext", "traits": { "smithy.api#documentation": "

The details about the distribution failure, if the failure occurred while Image Builder\n\t\t\tdistributed or configured the image.

" } } }, "traits": { "smithy.api#documentation": "

Contains details about the failure when the image creation process fails.\n\t\t\tProperties appear in the failure context when the related information is available\n\t\t\tfor the failure.

" } }, "com.amazonaws.imagebuilder#ImageLoggingConfiguration": { "type": "structure", "members": { "logGroupName": { "target": "com.amazonaws.imagebuilder#LogGroupName", "traits": { "smithy.api#documentation": "

The log group name that Image Builder uses for image creation. If not specified, the log group \n\t\t\tname defaults to /aws/imagebuilder/image-name.

" } } }, "traits": { "smithy.api#documentation": "

The logging configuration that's defined for the image. Image Builder uses the defined settings \n\t\t\tto direct execution log output during image creation.

" } }, "com.amazonaws.imagebuilder#ImagePackage": { "type": "structure", "members": { "packageName": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the package that's reported to the operating system package \n\t\t\tmanager.

" } }, "packageVersion": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The version of the package that's reported to the operating system package \n\t\t\tmanager.

" } } }, "traits": { "smithy.api#documentation": "

A software package that's installed on an image, as detected by Amazon Web Services Systems Manager\n\t\t\tInventory at build time. The list includes packages that shipped with the\n\t\t\tbase image.

" } }, "com.amazonaws.imagebuilder#ImagePackageList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ImagePackage" } }, "com.amazonaws.imagebuilder#ImagePipeline": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the image pipeline.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the image pipeline.

" } }, "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

The platform of the image pipeline, inherited from the recipe that the\n\t\t\tpipeline uses.

" } }, "enhancedImageMetadataEnabled": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether to collect additional information about the image being created, including the operating\n\t\t\tsystem (OS) version and package list. Defaults to true.

" } }, "imageRecipeArn": { "target": "com.amazonaws.imagebuilder#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe associated with this image\n\t\t\tpipeline.

" } }, "containerRecipeArn": { "target": "com.amazonaws.imagebuilder#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that is used for this\n\t\t\tpipeline.

" } }, "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration associated with\n\t\t\tthis image pipeline.

" } }, "distributionConfigurationArn": { "target": "com.amazonaws.imagebuilder#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration associated with this\n\t\t\timage pipeline.

" } }, "imageTestsConfiguration": { "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", "traits": { "smithy.api#documentation": "

The image tests configuration of the image pipeline.

" } }, "schedule": { "target": "com.amazonaws.imagebuilder#Schedule", "traits": { "smithy.api#documentation": "

The schedule of the image pipeline.

" } }, "status": { "target": "com.amazonaws.imagebuilder#PipelineStatus", "traits": { "smithy.api#documentation": "

The status of the image pipeline. A disabled pipeline doesn't run on its\n\t\t\tschedule, but you can still start builds manually. Image Builder can also disable a\n\t\t\tpipeline automatically when consecutive scheduled builds fail.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which this image pipeline was created.

" } }, "dateUpdated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which this image pipeline was last updated.

" } }, "dateLastRun": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which this image pipeline was last run.

" } }, "lastRunStatus": { "target": "com.amazonaws.imagebuilder#ImageStatus", "traits": { "smithy.api#documentation": "

The status of the last image that this pipeline built, such as \n\t\t\tBUILDING, TESTING, FAILED, \n\t\t\tor AVAILABLE.

" } }, "dateNextRun": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The next date when the pipeline is scheduled to run.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags of this image pipeline.

" } }, "imageScanningConfiguration": { "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", "traits": { "smithy.api#documentation": "

The settings that determine whether and how Amazon Inspector scans the images that\n\t\t\tthe pipeline creates.

" } }, "imageTags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags that Image Builder applies to the Image Builder image resource that this\n\t\t\tpipeline's scheduled executions create. These tags don't apply to the\n\t\t\toutput AMI. Builds that you start manually use the tags from the\n\t\t\tStartImagePipelineExecution request instead.

" } }, "executionRole": { "target": "com.amazonaws.imagebuilder#RoleNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) for the IAM role you create that grants \n\t\t\tImage Builder access to perform workflow actions.

" } }, "workflows": { "target": "com.amazonaws.imagebuilder#WorkflowConfigurationList", "traits": { "smithy.api#documentation": "

Contains the workflows that run for the image pipeline.

" } }, "loggingConfiguration": { "target": "com.amazonaws.imagebuilder#PipelineLoggingConfiguration", "traits": { "smithy.api#documentation": "

The CloudWatch Logs configuration for the pipeline: the log group for\n\t\t\timage build logs and the log group for pipeline execution logs.

" } }, "consecutiveFailures": { "target": "com.amazonaws.imagebuilder#ConsecutiveFailures", "traits": { "smithy.api#documentation": "

Image Builder tracks the number of consecutive failures for scheduled pipeline \n\t\t\texecutions and takes one of the following actions each time it runs on a schedule:

\n \n

The consecutive failure count is also reset to zero under the following \n\t\t\tconditions:

\n \n

If the pipeline runs manually and fails, the count remains the same. The next \n\t\t\tscheduled run continues to increment where it left off before.

" } } }, "traits": { "smithy.api#documentation": "

Defines the automation configuration for building, testing, and\n\t\t\tdistributing images. A pipeline references the resources that its builds\n\t\t\tuse, such as the recipe and infrastructure configuration. It also holds\n\t\t\tthe settings that control its builds, such as the schedule and custom\n\t\t\tworkflows.

" } }, "com.amazonaws.imagebuilder#ImagePipelineAggregation": { "type": "structure", "members": { "imagePipelineArn": { "target": "com.amazonaws.imagebuilder#ImagePipelineArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the image pipeline for this\n\t\t\taggregation.

" } }, "severityCounts": { "target": "com.amazonaws.imagebuilder#SeverityCounts", "traits": { "smithy.api#documentation": "

Counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings for the specified image pipeline.

" } } }, "traits": { "smithy.api#documentation": "

Contains vulnerability counts for a specific image pipeline.

" } }, "com.amazonaws.imagebuilder#ImagePipelineArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-pipeline/[a-z0-9-_]+$" } }, "com.amazonaws.imagebuilder#ImagePipelineList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ImagePipeline" } }, "com.amazonaws.imagebuilder#ImageRecipe": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

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

" } }, "type": { "target": "com.amazonaws.imagebuilder#ImageType", "traits": { "smithy.api#documentation": "

The output image type. For an image recipe, this is always AMI. Container\n\t\t\timages are built from container recipes, a separate resource. This field\n\t\t\tisn't currently returned in responses.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the image recipe.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the image recipe.

" } }, "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

The platform of the image recipe.

" } }, "owner": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The owner of the image recipe.

" } }, "version": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { "smithy.api#documentation": "

The version of the image recipe.

" } }, "components": { "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", "traits": { "smithy.api#documentation": "

The components that are included in the image recipe. A recipe can contain a maximum of 20 build and test components\n\t\t\tin any combination, by default. This maximum is an adjustable quota. For more information, see\n\t\t\tEC2 Image Builder endpoints and quotas\n\t\t\tin the Amazon Web Services General Reference.

" } }, "parentImage": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The base image for customizations specified in the image recipe. You can specify the \n\t\t\tparent image using one of the following options:

\n " } }, "blockDeviceMappings": { "target": "com.amazonaws.imagebuilder#InstanceBlockDeviceMappings", "traits": { "smithy.api#documentation": "

The block device mappings to apply when creating images from this recipe.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which this image recipe was created.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags of the image recipe.

" } }, "workingDirectory": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The working directory used during build and test workflows. If you\n\t\t\tdon't specify a working directory, Image Builder uses /tmp for\n\t\t\tLinux and macOS build instances, and C:/ for Windows build\n\t\t\tinstances.

" } }, "additionalInstanceConfiguration": { "target": "com.amazonaws.imagebuilder#AdditionalInstanceConfiguration", "traits": { "smithy.api#documentation": "

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test\n\t\t\tyour image configuration. Instance configuration adds a layer of control over those\n\t\t\tinstances. You can define settings and add scripts to run when Image Builder launches\n\t\t\tyour build instance.

" } }, "amiTags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

Tags that are applied to the AMI that Image Builder creates during the Build phase\n\t\t\tprior to image distribution.

" } }, "amiWatermarks": { "target": "com.amazonaws.imagebuilder#AmiWatermarksList", "traits": { "smithy.api#documentation": "

The AMI watermark names attached to the output AMI from this recipe.\n\t\t\tAMI watermarks are lineage markers that automatically propagate to\n\t\t\tderivative AMIs when the source AMI is copied or distributed.

" } } }, "traits": { "smithy.api#documentation": "

An image recipe.

" } }, "com.amazonaws.imagebuilder#ImageRecipeArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-recipe/[a-z0-9-_]+/(?:[0-9]+|x)\\.(?:[0-9]+|x)\\.(?:[0-9]+|x)$" } }, "com.amazonaws.imagebuilder#ImageRecipeSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

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

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the image recipe.

" } }, "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

The platform of the image recipe.

" } }, "owner": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The owner of the image recipe.

" } }, "parentImage": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The base image of the image recipe.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which this image recipe was created.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags of the image recipe.

" } } }, "traits": { "smithy.api#documentation": "

A summary of an image recipe.

" } }, "com.amazonaws.imagebuilder#ImageRecipeSummaryList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ImageRecipeSummary" } }, "com.amazonaws.imagebuilder#ImageScanFinding": { "type": "structure", "members": { "awsAccountId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID that's associated with the finding.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image build version that's associated with the\n\t\t\tfinding.

" } }, "imagePipelineArn": { "target": "com.amazonaws.imagebuilder#ImagePipelineArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that's associated with the\n\t\t\tfinding.

" } }, "type": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The type of the finding. Image Builder looks for findings of the type\n\t\t\t\tPACKAGE_VULNERABILITY that apply to output images, and excludes other\n\t\t\ttypes.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the finding.

" } }, "title": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The title of the finding.

" } }, "remediation": { "target": "com.amazonaws.imagebuilder#Remediation", "traits": { "smithy.api#documentation": "

An object that contains the details about how to remediate the finding.

" } }, "severity": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The severity of the finding. For more information, see Severity levels for Amazon Inspector findings in the\n\t\t\t\tAmazon Inspector User Guide.

" } }, "firstObservedAt": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The date and time when the finding was first observed.

" } }, "updatedAt": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The timestamp when the finding was last updated.

" } }, "inspectorScore": { "target": "com.amazonaws.imagebuilder#NonNegativeDouble", "traits": { "smithy.api#documentation": "

The score that Amazon Inspector assigned for the finding.

" } }, "inspectorScoreDetails": { "target": "com.amazonaws.imagebuilder#InspectorScoreDetails", "traits": { "smithy.api#documentation": "

An object that contains details of the Amazon Inspector score.

" } }, "packageVulnerabilityDetails": { "target": "com.amazonaws.imagebuilder#PackageVulnerabilityDetails", "traits": { "smithy.api#documentation": "

An object that contains the details of a package vulnerability finding.

" } }, "fixAvailable": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Details about whether a fix is available for any of the packages that are identified\n\t\t\tin the finding through a version update. Valid values include:

\n " } } }, "traits": { "smithy.api#documentation": "

Contains details about a vulnerability scan finding that Amazon Inspector generated\n\t\t\tfor an image.

" } }, "com.amazonaws.imagebuilder#ImageScanFindingAggregation": { "type": "structure", "members": { "accountAggregation": { "target": "com.amazonaws.imagebuilder#AccountAggregation", "traits": { "smithy.api#documentation": "

Returns an object that contains severity counts based on an account ID.

" } }, "imageAggregation": { "target": "com.amazonaws.imagebuilder#ImageAggregation", "traits": { "smithy.api#documentation": "

Returns an object that contains severity counts based on the Amazon Resource Name (ARN) for a specific image.

" } }, "imagePipelineAggregation": { "target": "com.amazonaws.imagebuilder#ImagePipelineAggregation", "traits": { "smithy.api#documentation": "

Returns an object that contains severity counts based on an image pipeline ARN.

" } }, "vulnerabilityIdAggregation": { "target": "com.amazonaws.imagebuilder#VulnerabilityIdAggregation", "traits": { "smithy.api#documentation": "

Returns an object that contains severity counts based on vulnerability ID.

" } } }, "traits": { "smithy.api#documentation": "

This returns exactly one type of aggregation, based on the filter that Image Builder applies in\n\t\t\tits API action.

" } }, "com.amazonaws.imagebuilder#ImageScanFindingAggregationsList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ImageScanFindingAggregation" } }, "com.amazonaws.imagebuilder#ImageScanFindingsFilter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#FilterName", "traits": { "smithy.api#documentation": "

The name of the image scan finding filter. Filter names are case-sensitive.\n\t\t\tValid filter names are:

\n " } }, "values": { "target": "com.amazonaws.imagebuilder#ImageScanFindingsFilterValues", "traits": { "smithy.api#documentation": "

The filter values. Filter values are case-sensitive.

" } } }, "traits": { "smithy.api#documentation": "

A name value pair that Image Builder applies to streamline results from the\n\t\t\tvulnerability scan findings list action.

" } }, "com.amazonaws.imagebuilder#ImageScanFindingsFilterList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ImageScanFindingsFilter" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.imagebuilder#ImageScanFindingsFilterValues": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#FilterValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.imagebuilder#ImageScanFindingsList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ImageScanFinding" } }, "com.amazonaws.imagebuilder#ImageScanState": { "type": "structure", "members": { "status": { "target": "com.amazonaws.imagebuilder#ImageScanStatus", "traits": { "smithy.api#documentation": "

The current state of vulnerability scans for the image. The scan starts as\n\t\t\tPENDING and moves through SCANNING and\n\t\t\tCOLLECTING to COMPLETED. Image Builder sets the status to\n\t\t\tABANDONED if the image reaches a terminal state before the scan\n\t\t\tfinding collection completes. A scan can also end as FAILED or\n\t\t\tTIMED_OUT.

" } }, "reason": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The reason for the scan status for the image.

" } } }, "traits": { "smithy.api#documentation": "

Shows the vulnerability scan status for a specific image, and the reason for that\n\t\t\tstatus.

" } }, "com.amazonaws.imagebuilder#ImageScanStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "SCANNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SCANNING" } }, "COLLECTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COLLECTING" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "ABANDONED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ABANDONED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "TIMED_OUT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIMED_OUT" } } } }, "com.amazonaws.imagebuilder#ImageScanningConfiguration": { "type": "structure", "members": { "imageScanningEnabled": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether Amazon Inspector scans for vulnerabilities when you create a new\n\t\t\timage. You must also enable image tests. For AMI output,\n\t\t\timageScanningTypes sets whether Amazon Inspector scans the test instance or\n\t\t\tthe output AMI. For container output, Amazon Inspector scans the container image that\n\t\t\tImage Builder pushes to the Amazon ECR repository from your ecrConfiguration\n\t\t\tsettings.

\n

To use container image scans, you must activate Amazon Inspector for Amazon ECR\n\t\t\tscanning in the account and Amazon Web Services Region where the build runs. Amazon Inspector\n\t\t\tactivation is Regional. The Image Builder\n\t\t\tListImageScanFindings operation returns the findings of these\n\t\t\tscans.

" } }, "ecrConfiguration": { "target": "com.amazonaws.imagebuilder#EcrConfiguration", "traits": { "smithy.api#documentation": "

Contains Amazon ECR settings for vulnerability scans.

" } }, "imageScanningTypes": { "target": "com.amazonaws.imagebuilder#ImageScanningTypeList", "traits": { "smithy.api#documentation": "

The type of vulnerability scan that Image Builder runs for AMI output when\n\t\t\timageScanningEnabled is true. Specify a single\n\t\t\tvalue. If you omit imageScanningTypes, Image Builder uses\n\t\t\tTEST_INSTANCE_CVE. The scan types work as follows:

\n " } }, "scanResultCondition": { "target": "com.amazonaws.imagebuilder#ScanResultCondition", "traits": { "smithy.api#documentation": "

The condition that the output AMI's scan results must meet for the image\n\t\t\tto pass. You can set scanResultCondition only when\n\t\t\timageScanningTypes is ON_DEMAND_AMI_CVE. If you\n\t\t\tomit it, Image Builder starts the scan but does not wait for it or use its results\n\t\t\tto pass or fail the image.

\n

When you set scanResultCondition, the test phase waits for\n\t\t\tthe scan to finish. Then Image Builder checks the findings against the condition.\n\t\t\tBy default, Image Builder counts only findings that have a fix available. To count\n\t\t\tevery finding, set fixAvailable to false. If a counted\n\t\t\tfinding exceeds maximumSeverityLabel, Image Builder fails the image in\n\t\t\tthe test phase and does not distribute the AMI.

" } } }, "traits": { "smithy.api#documentation": "

Contains settings for Image Builder image resource and container image scans.

" } }, "com.amazonaws.imagebuilder#ImageScanningType": { "type": "enum", "members": { "TEST_INSTANCE_CVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEST_INSTANCE_CVE" } }, "ON_DEMAND_AMI_CVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ON_DEMAND_AMI_CVE" } } } }, "com.amazonaws.imagebuilder#ImageScanningTypeList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ImageScanningType" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.imagebuilder#ImageSource": { "type": "enum", "members": { "AMAZON_MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMAZON_MANAGED" } }, "AWS_MARKETPLACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_MARKETPLACE" } }, "IMPORTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPORTED" } }, "CUSTOM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOM" } } } }, "com.amazonaws.imagebuilder#ImageState": { "type": "structure", "members": { "status": { "target": "com.amazonaws.imagebuilder#ImageStatus", "traits": { "smithy.api#documentation": "

The status of the image. A new image moves through build, test, and\n\t\t\tdistribution statuses during creation, and ends in the\n\t\t\tAVAILABLE, FAILED, or CANCELLED\n\t\t\tstate. The DEPRECATED, DISABLED, and\n\t\t\tDELETED statuses come from later resource management\n\t\t\tactions.

" } }, "reason": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The reason for the status of the image.

" } }, "failureContext": { "target": "com.amazonaws.imagebuilder#ImageFailureContext", "traits": { "smithy.api#documentation": "

The details about the failure, for images that failed to complete. Image Builder only\n\t\t\tsets this property when the image status is FAILED.

" } } }, "traits": { "smithy.api#documentation": "

Image status and the reason for that status.

" } }, "com.amazonaws.imagebuilder#ImageStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "BUILDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BUILDING" } }, "TESTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TESTING" } }, "DISTRIBUTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISTRIBUTING" } }, "INTEGRATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTEGRATING" } }, "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "DEPRECATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPRECATED" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.imagebuilder#ImageSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the image.

" } }, "type": { "target": "com.amazonaws.imagebuilder#ImageType", "traits": { "smithy.api#documentation": "

Specifies whether this image produces an AMI or a container image.

" } }, "version": { "target": "com.amazonaws.imagebuilder#VersionNumberWithBuild", "traits": { "smithy.api#documentation": "

The version of the image.

" } }, "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

The image operating system platform, such as Linux or Windows.

" } }, "osVersion": { "target": "com.amazonaws.imagebuilder#OsVersion", "traits": { "smithy.api#documentation": "

The operating system version of the instances that launch from this image. For \n\t\t\texample, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

" } }, "state": { "target": "com.amazonaws.imagebuilder#ImageState", "traits": { "smithy.api#documentation": "

The state of the image.

" } }, "owner": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The owner of the image.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which Image Builder created this image.

" } }, "outputResources": { "target": "com.amazonaws.imagebuilder#OutputResources", "traits": { "smithy.api#documentation": "

The output resources that Image Builder produced when it created this image.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags that apply to this image.

" } }, "buildType": { "target": "com.amazonaws.imagebuilder#BuildType", "traits": { "smithy.api#documentation": "

Indicates the type of build that created this image. The build can be initiated in the\n\t\t\tfollowing ways:

\n " } }, "imageSource": { "target": "com.amazonaws.imagebuilder#ImageSource", "traits": { "smithy.api#documentation": "

The origin of the base image that Image Builder used to build this image.

" } }, "deprecationTime": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The time when deprecation occurs for an image resource. This can be a past or future date.

" } }, "lifecycleExecutionId": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", "traits": { "smithy.api#documentation": "

Identifies the last runtime instance of the lifecycle policy to take action on the image.

" } }, "loggingConfiguration": { "target": "com.amazonaws.imagebuilder#ImageLoggingConfiguration", "traits": { "smithy.api#documentation": "

The logging configuration that's defined for the image.

" } } }, "traits": { "smithy.api#documentation": "

An image summary.

" } }, "com.amazonaws.imagebuilder#ImageSummaryList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ImageSummary" } }, "com.amazonaws.imagebuilder#ImageTestsConfiguration": { "type": "structure", "members": { "imageTestsEnabled": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether tests run after building the image. \n\t\t\tWhen enabled, tests run after the image build and before image distribution.\n\t\t\tDefaults to true.

" } }, "timeoutMinutes": { "target": "com.amazonaws.imagebuilder#ImageTestsTimeoutMinutes", "traits": { "smithy.api#documentation": "

The maximum time in minutes that tests are permitted to run. If you don't\n\t\t\tspecify a value, Image Builder stores and returns 720.

\n \n

The timeout property is not currently active. This value is\n\t\t\t\tignored.

\n
" } } }, "traits": { "smithy.api#documentation": "

Configure image tests for your pipeline build. Tests run after building the image, to\n\t\t\tverify that the AMI or container image is valid before distributing it.

" } }, "com.amazonaws.imagebuilder#ImageTestsTimeoutMinutes": { "type": "integer", "traits": { "smithy.api#range": { "min": 60, "max": 1440 } } }, "com.amazonaws.imagebuilder#ImageType": { "type": "enum", "members": { "AMI": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMI" } }, "DOCKER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DOCKER" } } } }, "com.amazonaws.imagebuilder#ImageVersion": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a specific version of an Image Builder image.

\n \n

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

\n
    \n
  1. \n

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

    \n
  2. \n
  3. \n

    Version ARNs have only the first three nodes: ..

    \n
  4. \n
  5. \n

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

    \n
  6. \n
\n
" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of this specific version of an Image Builder image.

" } }, "type": { "target": "com.amazonaws.imagebuilder#ImageType", "traits": { "smithy.api#documentation": "

Specifies whether this image produces an AMI or a container image.

" } }, "version": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { "smithy.api#documentation": "

The semantic version of the image. This version follows the semantic\n\t\t\tversion syntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes, you can assign any positive integer value, including \n\tzero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

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

\n

\n Filtering: You can use wildcards (x) to specify the most recent versions or nodes when \n\tselecting the base image or components for your recipe. When you use a wildcard in any node, all nodes \n\tto the right of the first wildcard must also be wildcards.

\n
" } }, "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

The operating system platform of the image version, for example \"Windows\" or \n\t\t\t\"Linux\".

" } }, "osVersion": { "target": "com.amazonaws.imagebuilder#OsVersion", "traits": { "smithy.api#documentation": "

The operating system version of the image. For example, Amazon Linux 2023\n\t\t\tor Microsoft Windows Server 2022.

" } }, "owner": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The owner of the image version.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which this specific version of the Image Builder image was created.

" } }, "buildType": { "target": "com.amazonaws.imagebuilder#BuildType", "traits": { "smithy.api#documentation": "

Indicates the type of build that created this image. The build can be initiated in the\n\t\t\tfollowing ways:

\n " } }, "imageSource": { "target": "com.amazonaws.imagebuilder#ImageSource", "traits": { "smithy.api#documentation": "

The origin of the base image that Image Builder used to build this image.

" } } }, "traits": { "smithy.api#documentation": "

The defining characteristics of a specific version of an Image Builder image.

" } }, "com.amazonaws.imagebuilder#ImageVersionArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):image/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" } }, "com.amazonaws.imagebuilder#ImageVersionArnOrBuildVersionArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):image/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$" } }, "com.amazonaws.imagebuilder#ImageVersionList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ImageVersion" } }, "com.amazonaws.imagebuilder#ImportComponent": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ImportComponentRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ImportComponentResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#InvalidVersionNumberException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Imports a component and transforms its data into a component document. For\n\t\t\tthe SHELL format, Image Builder wraps your script in a component\n\t\t\tdocument with a single step that runs the script.

", "smithy.api#examples": [ { "title": "Import a component from a shell script", "documentation": "The following example imports a plain shell script as a Linux build component.", "input": { "name": "my-example-imported-component", "semanticVersion": "1.0.0", "description": "Installs my application from an imported shell script", "type": "BUILD", "format": "SHELL", "platform": "Linux", "data": "sudo yum update -y\nsudo yum -y install my-app\n", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE88888" }, "output": { "requestId": "e62cb87f-e291-4fb2-9305-54a7878c3b99", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE88888", "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-imported-component/1.0.0/1" } } ], "smithy.api#http": { "method": "PUT", "uri": "/ImportComponent", "code": 200 } } }, "com.amazonaws.imagebuilder#ImportComponentRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the component. Image Builder generates the component ARN from a\n\t\t\tnormalized form of the name, so names that differ only in case, spaces, or\n\t\t\tunderscores count as the same name. If a component with the same name and\n\t\t\tsemantic version already exists in your account in the same Amazon Web Services Region,\n\t\t\tthe request creates a new build version for it. If the content is also\n\t\t\tidentical to the latest build version, the request fails because the\n\t\t\tcomponent already exists.

", "smithy.api#required": {} } }, "semanticVersion": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { "smithy.api#documentation": "

The semantic version of the component. This version follows the semantic version\n\t\t\tsyntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes, you can assign any positive integer value, including \n\tzero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

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

\n
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the component. Describes the contents of the component.

" } }, "changeDescription": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The change description of the component. This description indicates the change that\n\t\t\thas been made in this version, or what makes this version different from other versions\n\t\t\tof the component.

" } }, "type": { "target": "com.amazonaws.imagebuilder#ComponentType", "traits": { "smithy.api#documentation": "

The type of the component denotes whether the component is used to build the image, or\n\t\t\tonly to test it.

", "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.imagebuilder#ComponentFormat", "traits": { "smithy.api#documentation": "

The format of the resource that you want to import as a component.

", "smithy.api#required": {} } }, "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

The platform of the component.

", "smithy.api#required": {} } }, "data": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The data of the component. For the SHELL format, this is the\n\t\t\tplain script content. You must specify exactly one of the data\n\t\t\tor uri properties. For scripts that exceed the inline length\n\t\t\tconstraint, use the uri property.

" } }, "uri": { "target": "com.amazonaws.imagebuilder#Uri", "traits": { "smithy.api#documentation": "

The uri of the component. Must be an Amazon S3 URL and you must have permission\n\t\t\tto access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your\n\t\t\tservice quota. Either data or uri can be used to specify the\n\t\t\tdata within the component.

" } }, "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that is used to encrypt this component.\n\t\t\tThis can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide. If you don't specify a key, Image Builder encrypts the\n\t\t\tcomponent data with a KMS key that Image Builder owns.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags of the component.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ImportComponentResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "componentBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the imported component.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ImportDiskImage": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ImportDiskImageRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ImportDiskImageResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#AccessDeniedException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" }, { "target": "com.amazonaws.imagebuilder#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Imports a Windows operating system image from a verified Microsoft ISO disk\n\t\t\tfile. The following disk images are supported:

\n \n

The response returns as soon as Image Builder creates the new image resource in the\n\t\t\tPENDING state. The conversion from ISO file to AMI then runs\n\t\t\tasynchronously on an EC2 instance that Image Builder launches with the specified\n\t\t\tinfrastructure configuration.

", "smithy.api#examples": [ { "title": "Import a Windows 11 ISO disk image", "documentation": "The following example starts an image build that converts a Windows 11 ISO disk file stored in Amazon S3 into an AMI; the imageBuildVersionArn in the response identifies the Image Builder image resource that tracks the build, not the output AMI.", "input": { "name": "my-example-imported-image", "semanticVersion": "1.0.0", "platform": "Windows", "osVersion": "Microsoft Windows 11", "uri": "s3://amzn-s3-demo-bucket/Win11_23H2_English_x64.iso", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE12345" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE12345", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-imported-image/1.0.0/1" } } ], "smithy.api#http": { "method": "PUT", "uri": "/ImportDiskImage", "code": 200 } } }, "com.amazonaws.imagebuilder#ImportDiskImageRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the image resource that's created from the import. Image Builder\n\t\t\tgenerates the image ARN from a normalized form of the name, so names that\n\t\t\tdiffer only in case, spaces, or underscores count as the same name. If an\n\t\t\timage with the same name and semantic version already exists in your\n\t\t\taccount in the same Amazon Web Services Region, the import creates a new build version\n\t\t\tfor it.

", "smithy.api#required": {} } }, "semanticVersion": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { "smithy.api#documentation": "

The semantic version to attach to the image that's created during the import\n\t\t\tprocess. This version follows the semantic version syntax.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description for your disk image import.

" } }, "platform": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The operating system platform for the imported image. Allowed values include \n\t\t\tthe following: Windows.

", "smithy.api#required": {} } }, "osVersion": { "target": "com.amazonaws.imagebuilder#OsVersion", "traits": { "smithy.api#documentation": "

The operating system version for the imported image. The only supported\n\t\t\tvalue is Microsoft Windows 11.

", "smithy.api#required": {} } }, "executionRole": { "target": "com.amazonaws.imagebuilder#RoleNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access\n\t\t\tto perform workflow actions to import an image from a Microsoft ISO file.\n\t\t\tIf you don't provide a role, Image Builder uses the Image Builder service-linked role in your\n\t\t\taccount, and creates it if it doesn't exist.

" } }, "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration resource that's used for \n\t\t\tlaunching the EC2 instance on which the ISO image is built.

", "smithy.api#required": {} } }, "uri": { "target": "com.amazonaws.imagebuilder#Uri", "traits": { "smithy.api#documentation": "

The uri of the ISO disk file that's stored in Amazon S3, in\n\t\t\ts3://bucket/key format. The key must end with the\n\t\t\t.iso, .ISO, or .Iso extension, and the\n\t\t\tbucket must be owned by the account that makes the request.

", "smithy.api#required": {} } }, "loggingConfiguration": { "target": "com.amazonaws.imagebuilder#ImageLoggingConfiguration", "traits": { "smithy.api#documentation": "

The CloudWatch Logs log group where Image Builder sends the import logs. If you\n\t\t\tspecify a log group name outside of the /aws/imagebuilder/\n\t\t\tnamespace, you must also provide an executionRole that has\n\t\t\tpermission to write to that log group.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

Tags that are attached to image resources created from the import.

" } }, "registerImageOptions": { "target": "com.amazonaws.imagebuilder#RegisterImageOptions", "traits": { "smithy.api#documentation": "

Configures Secure Boot and UEFI settings for the \n\t\t\timported image.

" } }, "windowsConfiguration": { "target": "com.amazonaws.imagebuilder#WindowsConfiguration", "traits": { "smithy.api#documentation": "

Specifies Windows settings for ISO imports.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ImportDiskImageResponse": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Image Builder image resource that this request created. The AMI\n\t\t\tdoesn't exist yet when the response returns. The import runs asynchronously,\n\t\t\tand the output AMI appears in the image's output resources when the import\n\t\t\tcompletes.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ImportVmImage": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ImportVmImageRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ImportVmImageResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates an Image Builder image resource from an Amazon EC2 VM import task. The response\n\t\t\treturns as soon as Image Builder creates the image resource in the\n\t\t\tPENDING state. Image Builder then monitors the import task\n\t\t\tasynchronously. When the task completes, Image Builder records the AMI that it\n\t\t\tproduced as the new image's output resource and marks the image\n\t\t\tAVAILABLE. You can then use the imported image as the base\n\t\t\timage for your recipes.

\n

To create the VM import task, use the Amazon EC2 API ImportImage\n\t\t\toperation, or the import-image\n\t\t\tCLI command.

", "smithy.api#examples": [ { "title": "Import a virtual machine as an Image Builder image", "documentation": "The following example registers the output of an EC2 VM Import/Export task (import-ami) as a new Image Builder image, so you can use the imported virtual machine as a base image.", "input": { "name": "my-example-imported-image", "semanticVersion": "1.0.0", "platform": "Linux", "osVersion": "Amazon Linux 2", "vmImportTaskId": "import-ami-1234567890abcdef0", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE00000" }, "output": { "requestId": "f8a1d0ce-42b7-4d6a-9b12-3c84a02e5f19", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE00000", "imageArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-imported-image/1.0.0/1" } } ], "smithy.api#http": { "method": "PUT", "uri": "/ImportVmImage", "code": 200 } } }, "com.amazonaws.imagebuilder#ImportVmImageRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the base image that is created by the import process. Image Builder\n\t\t\tgenerates the image ARN from a normalized form of the name, so names that\n\t\t\tdiffer only in case, spaces, or underscores count as the same name. If an\n\t\t\timage with the same name and semantic version already exists in your\n\t\t\taccount in the same Amazon Web Services Region, the import creates a new build version\n\t\t\tfor it.

", "smithy.api#required": {} } }, "semanticVersion": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { "smithy.api#documentation": "

The semantic version to attach to the base image that was created during the import\n\t\t\tprocess. This version follows the semantic version syntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes, you can assign any positive integer value, including \n\tzero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

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

\n
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description for the base image that is created by the import process.

" } }, "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { "smithy.api#documentation": "

The operating system platform for the imported VM.

", "smithy.api#required": {} } }, "osVersion": { "target": "com.amazonaws.imagebuilder#OsVersion", "traits": { "smithy.api#documentation": "

The operating system version for the imported VM.

" } }, "vmImportTaskId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The importTaskId (API) or ImportTaskId (CLI) from the\n\t\t\tAmazon EC2 VM import process. The import task doesn't need to be complete when you\n\t\t\tcall ImportVmImage - Image Builder monitors the task and finishes creating the image\n\t\t\twhen the task completes.

", "smithy.api#required": {} } }, "loggingConfiguration": { "target": "com.amazonaws.imagebuilder#ImageLoggingConfiguration", "traits": { "smithy.api#documentation": "

The CloudWatch Logs log group where Image Builder sends the import logs. For\n\t\t\tImportVmImage, the log group name must be within the\n\t\t\t/aws/imagebuilder/ namespace.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

Tags that are attached to the import resources.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ImportVmImageResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "imageArn": { "target": "com.amazonaws.imagebuilder#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Image Builder image resource that this request created. Image Builder\n\t\t\trecords the AMI from the VM import task in the image's output resources\n\t\t\tafter the task completes.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#InfrastructureConfiguration": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the infrastructure configuration.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the infrastructure configuration.

" } }, "instanceTypes": { "target": "com.amazonaws.imagebuilder#InstanceTypeList", "traits": { "smithy.api#documentation": "

The instance types of the infrastructure configuration.

" } }, "instanceProfileName": { "target": "com.amazonaws.imagebuilder#InstanceProfileNameType", "traits": { "smithy.api#documentation": "

The instance profile of the infrastructure configuration.

" } }, "securityGroupIds": { "target": "com.amazonaws.imagebuilder#SecurityGroupIds", "traits": { "smithy.api#documentation": "

The security group IDs of the infrastructure configuration.

" } }, "subnetId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The subnet ID of the infrastructure configuration.

" } }, "logging": { "target": "com.amazonaws.imagebuilder#Logging", "traits": { "smithy.api#documentation": "

The logging configuration of the infrastructure configuration. When you\n\t\t\tconfigure S3 logs, Image Builder writes logs from the build and test process to the\n\t\t\tspecified bucket under the key prefix.

" } }, "keyPair": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon EC2 key pair of the infrastructure configuration.

" } }, "terminateInstanceOnFailure": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Indicates whether Image Builder terminates the build and test instances when the image\n\t\t\tbuild fails. When false, Image Builder retains the instance so that you\n\t\t\tcan debug it.

" } }, "snsTopicArn": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic to which Image Builder\n\t\t\tsends image build event notifications. Specify a standard topic. Image Builder doesn't support FIFO\n\t\t\ttopics.

\n \n

EC2 Image Builder can't send notifications to SNS topics that are encrypted using keys\n\t\t\t\tfrom other accounts. If your SNS topic is encrypted, the key must be owned by the\n\t\t\t\tsame account that owns your Image Builder resources.

\n
" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which the infrastructure configuration was created.

" } }, "dateUpdated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which the infrastructure configuration was last updated.

" } }, "resourceTags": { "target": "com.amazonaws.imagebuilder#ResourceTagMap", "traits": { "smithy.api#documentation": "

The metadata tags assigned to the Amazon EC2 build and test instances that Image Builder\n\t\t\tlaunches during image creation.

" } }, "instanceMetadataOptions": { "target": "com.amazonaws.imagebuilder#InstanceMetadataOptions", "traits": { "smithy.api#documentation": "

The instance metadata option settings for the infrastructure configuration.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags of the infrastructure configuration.

" } }, "placement": { "target": "com.amazonaws.imagebuilder#Placement", "traits": { "smithy.api#documentation": "

The instance placement settings that define where the build and test\n\t\t\tinstances that Image Builder launches during image creation run. These settings\n\t\t\tdon't affect instances that you launch from the output image.

" } }, "terminateInstanceOnCompletion": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether Image Builder terminates build and test instances when image creation\n\t\t\tends without a failure.

" } }, "parentInstance": { "target": "com.amazonaws.imagebuilder#ParentInstanceConfiguration", "traits": { "smithy.api#documentation": "

The Amazon EC2 Auto Scaling group that Image Builder takes the build instance from, instead of\n\t\t\tlaunching a new instance. This applies only to the build phase.

" } } }, "traits": { "smithy.api#documentation": "

Details of the infrastructure configuration.

" } }, "com.amazonaws.imagebuilder#InfrastructureConfigurationArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$" } }, "com.amazonaws.imagebuilder#InfrastructureConfigurationSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the infrastructure configuration.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the infrastructure configuration.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which the infrastructure configuration was created.

" } }, "dateUpdated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The date on which the infrastructure configuration was last updated.

" } }, "resourceTags": { "target": "com.amazonaws.imagebuilder#ResourceTagMap", "traits": { "smithy.api#documentation": "

The metadata tags assigned to the Amazon EC2 build and test instances that Image Builder\n\t\t\tlaunches during image creation.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags of the infrastructure configuration.

" } }, "instanceTypes": { "target": "com.amazonaws.imagebuilder#InstanceTypeList", "traits": { "smithy.api#documentation": "

The instance types of the infrastructure configuration.

" } }, "instanceProfileName": { "target": "com.amazonaws.imagebuilder#InstanceProfileNameType", "traits": { "smithy.api#documentation": "

The instance profile of the infrastructure configuration.

" } }, "placement": { "target": "com.amazonaws.imagebuilder#Placement", "traits": { "smithy.api#documentation": "

The instance placement settings that define where the build and test\n\t\t\tinstances that Image Builder launches during image creation run. These settings\n\t\t\tdon't affect instances that you launch from the output image.

" } } }, "traits": { "smithy.api#documentation": "

Contains a high-level summary of an infrastructure configuration, including\n\t\t\tthe environment settings that Image Builder uses to build and test images.

" } }, "com.amazonaws.imagebuilder#InfrastructureConfigurationSummaryList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationSummary" } }, "com.amazonaws.imagebuilder#InlineComponentData": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 16000 }, "smithy.api#pattern": "^[^\\x00]+$" } }, "com.amazonaws.imagebuilder#InlineDockerFileTemplate": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 16000 }, "smithy.api#pattern": "^[^\\x00]+$" } }, "com.amazonaws.imagebuilder#InlineWorkflowData": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 16000 }, "smithy.api#pattern": "^[^\\x00]+$" } }, "com.amazonaws.imagebuilder#InspectorScoreDetails": { "type": "structure", "members": { "adjustedCvss": { "target": "com.amazonaws.imagebuilder#CvssScoreDetails", "traits": { "smithy.api#documentation": "

The CVSS score that Amazon Inspector assigned to the finding after applying its\n\t\t\tadjustments. It includes the score source, CVSS version, scoring vector,\n\t\t\tand the adjustments applied.

" } } }, "traits": { "smithy.api#documentation": "

Information about the factors that influenced the score that Amazon Inspector assigned for a\n\t\t\tfinding.

" } }, "com.amazonaws.imagebuilder#InstanceBlockDeviceMapping": { "type": "structure", "members": { "deviceName": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The device to which these mappings apply.

" } }, "ebs": { "target": "com.amazonaws.imagebuilder#EbsInstanceBlockDeviceSpecification", "traits": { "smithy.api#documentation": "

The Amazon EBS-specific configuration for this mapping.

" } }, "virtualName": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The virtual device name for instance ephemeral devices.

" } }, "noDevice": { "target": "com.amazonaws.imagebuilder#EmptyString", "traits": { "smithy.api#documentation": "

Specifies a mapping to remove from the base image.

" } } }, "traits": { "smithy.api#documentation": "

Defines block device mappings for the instance used to configure your image.

" } }, "com.amazonaws.imagebuilder#InstanceBlockDeviceMappings": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#InstanceBlockDeviceMapping" } }, "com.amazonaws.imagebuilder#InstanceConfiguration": { "type": "structure", "members": { "image": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The base image for a container build and test instance. This can contain an AMI ID \n\t\t\tor it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, \n\t\t\tfollowed by the parameter name or ARN.

\n

If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.

" } }, "blockDeviceMappings": { "target": "com.amazonaws.imagebuilder#InstanceBlockDeviceMappings", "traits": { "smithy.api#documentation": "

Defines the block device mappings for the EC2 instance that Image Builder launches\n\t\t\tto build and test your container image.

" } } }, "traits": { "smithy.api#documentation": "

Defines a custom base AMI and block device mapping configurations of an instance used\n\t\t\tfor building and testing container images.

" } }, "com.amazonaws.imagebuilder#InstanceMetadataOptions": { "type": "structure", "members": { "httpTokens": { "target": "com.amazonaws.imagebuilder#HttpTokens", "traits": { "smithy.api#documentation": "

Indicates whether a signed token header is required for instance metadata retrieval\n\t\t\trequests. The values affect the response as follows:

\n \n

If you don't set a value, the EC2 launch default applies to the\n\t\t\tbuild and test instances. That default depends on the base AMI and any\n\t\t\taccount-level instance metadata defaults. For more information, see Configure the instance metadata options in the\n\t\t\t\t\n Amazon EC2 User Guide\n .

" } }, "httpPutResponseHopLimit": { "target": "com.amazonaws.imagebuilder#HttpPutResponseHopLimit", "traits": { "smithy.api#documentation": "

Limit the number of hops that an instance metadata request can traverse to\n\t\t\treach its destination. If you don't set a value, the EC2 launch default\n\t\t\tfor the instance applies. If HTTP tokens are required, container image\n\t\t\tbuilds need a minimum of two hops.

" } } }, "traits": { "smithy.api#documentation": "

The instance metadata service (IMDS) settings that Image Builder applies to the EC2\n\t\t\tbuild and test instances it launches. These settings control how software\n\t\t\ton those instances retrieves instance metadata and IAM role\n\t\t\tcredentials.

" } }, "com.amazonaws.imagebuilder#InstanceProfileNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } }, "com.amazonaws.imagebuilder#InstanceType": { "type": "string" }, "com.amazonaws.imagebuilder#InstanceTypeList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#InstanceType" } }, "com.amazonaws.imagebuilder#InvalidPaginationTokenException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

You have provided an invalid pagination token in your request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.imagebuilder#InvalidParameterCombinationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

You have specified a combination of parameters that isn't valid. For\n\t\t\texample, two mutually exclusive parameters, or a parameter without its\n\t\t\trequired companion parameter. Review the error message for details.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.imagebuilder#InvalidParameterException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The specified parameter is invalid. Review the available parameters for the API\n\t\t\trequest.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.imagebuilder#InvalidParameterValueException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The value that you provided for the specified parameter is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.imagebuilder#InvalidRequestException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The request is malformed or otherwise invalid. Verify the request and try\n\t\t\tagain.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.imagebuilder#InvalidVersionNumberException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

Your version number is out of bounds or does not follow the required syntax.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.imagebuilder#LatestVersionReferences": { "type": "structure", "members": { "latestVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The latest version Amazon Resource Name (ARN) of the Image Builder resource.

" } }, "latestMajorVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.

" } }, "latestMinorVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.

" } }, "latestPatchVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.

" } } }, "traits": { "smithy.api#documentation": "

A set of wildcard version ARNs that always reference the latest\n\t\t\tversion of the resource. ARNs are included for the latest version overall, and for the latest\n\t\t\tversions within the same major, minor, and patch levels.

" } }, "com.amazonaws.imagebuilder#LaunchPermissionConfiguration": { "type": "structure", "members": { "userIds": { "target": "com.amazonaws.imagebuilder#AccountList", "traits": { "smithy.api#documentation": "

The Amazon Web Services account IDs to grant launch permission to. Each listed account can\n\t\t\tuse the distributed AMI to launch instances.

" } }, "userGroups": { "target": "com.amazonaws.imagebuilder#StringList", "traits": { "smithy.api#documentation": "

The name of the group that you want to grant launch permission to. The only\n\t\t\tsupported value is all, which makes the distributed AMI\n\t\t\tpublic.

" } }, "organizationArns": { "target": "com.amazonaws.imagebuilder#OrganizationArnList", "traits": { "smithy.api#documentation": "

The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more\n\t\t\tinformation, see What is\n\t\t\t\tOrganizations?.

" } }, "organizationalUnitArns": { "target": "com.amazonaws.imagebuilder#OrganizationalUnitArnList", "traits": { "smithy.api#documentation": "

The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.\n\t\t\tFor more information about key concepts for Organizations, see Organizations\n\t\t\t\tterminology and concepts.

" } } }, "traits": { "smithy.api#documentation": "

Describes the configuration for a launch permission. The launch permission\n\t\t\tmodification request is sent to the Amazon EC2\n\t\t\t\tModifyImageAttribute API on behalf of the user for each Region they have\n\t\t\tselected to distribute the AMI. To make an AMI public, set userGroups\n\t\t\tto the value all. See the examples for making an AMI public at\n\t\t\t\tAmazon EC2\n\t\t\t\tModifyImageAttribute.

" } }, "com.amazonaws.imagebuilder#LaunchTemplateConfiguration": { "type": "structure", "members": { "launchTemplateId": { "target": "com.amazonaws.imagebuilder#LaunchTemplateId", "traits": { "smithy.api#documentation": "

Identifies the Amazon EC2 launch template to use.

", "smithy.api#required": {} } }, "accountId": { "target": "com.amazonaws.imagebuilder#AccountId", "traits": { "smithy.api#documentation": "

The account ID that this configuration applies to.

" } }, "setDefaultVersion": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether to make the new launch template version that Image Builder creates\n\t\t\tthe default version of the launch template. If you don't set a value,\n\t\t\tImage Builder treats it as true.

" } } }, "traits": { "smithy.api#documentation": "

Identifies an Amazon EC2 launch template to use for a specific account.

" } }, "com.amazonaws.imagebuilder#LaunchTemplateConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#LaunchTemplateConfiguration" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.imagebuilder#LaunchTemplateId": { "type": "string", "traits": { "smithy.api#pattern": "^lt-[a-z0-9-_]{17}$" } }, "com.amazonaws.imagebuilder#LicenseConfigurationArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:license-manager:[^:]+:[0-9]{12}:license-configuration:lic-[a-z0-9-_]{32}$" } }, "com.amazonaws.imagebuilder#LicenseConfigurationArnList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#LicenseConfigurationArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.imagebuilder#LifecycleExecution": { "type": "structure", "members": { "lifecycleExecutionId": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", "traits": { "smithy.api#documentation": "

Identifies the lifecycle policy runtime instance.

" } }, "lifecyclePolicyArn": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lifecycle policy that ran.

" } }, "resourcesImpactedSummary": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionResourcesImpactedSummary", "traits": { "smithy.api#documentation": "

A summary flag that indicates whether the lifecycle execution identified any\n\t\t\tresources to take lifecycle actions on.

" } }, "state": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionState", "traits": { "smithy.api#documentation": "

Runtime state that reports whether the lifecycle execution is in progress,\n\t\t\tsucceeded, or failed.

" } }, "startTime": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The timestamp when the lifecycle runtime instance started.

" } }, "endTime": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The timestamp when the lifecycle runtime instance completed.

" } } }, "traits": { "smithy.api#documentation": "

Contains metadata from a runtime instance of a lifecycle policy.

" } }, "com.amazonaws.imagebuilder#LifecycleExecutionId": { "type": "string", "traits": { "smithy.api#pattern": "^lce-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } }, "com.amazonaws.imagebuilder#LifecycleExecutionResource": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The account that owns the impacted resource.

" } }, "resourceId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Identifies the impacted resource. The resource ID depends on the type of \n\t\t\tresource, as follows.

\n " } }, "state": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionResourceState", "traits": { "smithy.api#documentation": "

The runtime state of the lifecycle action for this resource.

" } }, "action": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionResourceAction", "traits": { "smithy.api#documentation": "

The action to take for the identified resource.

" } }, "region": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region where the lifecycle execution resource is stored.

" } }, "snapshots": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionSnapshotResourceList", "traits": { "smithy.api#documentation": "

A list of associated resource snapshots for the impacted resource if \n\t\t\tit\u2019s an AMI.

" } }, "imageUris": { "target": "com.amazonaws.imagebuilder#StringList", "traits": { "smithy.api#documentation": "

For an impacted container image, this identifies a list of URIs for associated \n\t\t\tcontainer images distributed to ECR repositories.

" } }, "startTime": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The starting timestamp from the lifecycle action that was applied to the resource.

" } }, "endTime": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The ending timestamp from the lifecycle action that was applied to the resource.

" } } }, "traits": { "smithy.api#documentation": "

Contains details for a resource that the runtime instance of the \n\t\t\tlifecycle policy identified for action.

" } }, "com.amazonaws.imagebuilder#LifecycleExecutionResourceAction": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionResourceActionName", "traits": { "smithy.api#documentation": "

The name of the lifecycle action that was identified for the resource.

" } }, "reason": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The reason why the lifecycle policy action is taken.

" } } }, "traits": { "smithy.api#documentation": "

The lifecycle policy action that was identified for the impacted resource.

" } }, "com.amazonaws.imagebuilder#LifecycleExecutionResourceActionName": { "type": "enum", "members": { "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "DELETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE" } }, "DEPRECATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPRECATE" } }, "DISABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLE" } } } }, "com.amazonaws.imagebuilder#LifecycleExecutionResourceList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionResource" } }, "com.amazonaws.imagebuilder#LifecycleExecutionResourceState": { "type": "structure", "members": { "status": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionResourceStatus", "traits": { "smithy.api#documentation": "

The runtime status of the lifecycle action taken for the \n\t\t\timpacted resource.

" } }, "reason": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Messaging that clarifies the reason for the assigned status.

" } } }, "traits": { "smithy.api#documentation": "

Contains the state of an impacted resource that the runtime instance \n\t\t\tof the lifecycle policy identified for action.

" } }, "com.amazonaws.imagebuilder#LifecycleExecutionResourceStatus": { "type": "enum", "members": { "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "SKIPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SKIPPED" } }, "SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCESS" } } } }, "com.amazonaws.imagebuilder#LifecycleExecutionResourcesImpactedSummary": { "type": "structure", "members": { "hasImpactedResources": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the lifecycle execution identified any resources to take\n\t\t\tlifecycle actions on.

" } } }, "traits": { "smithy.api#documentation": "

Contains an indicator that shows whether the lifecycle execution identified\n\t\t\tany resources to take lifecycle actions on.

" } }, "com.amazonaws.imagebuilder#LifecycleExecutionSnapshotResource": { "type": "structure", "members": { "snapshotId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Identifies the impacted snapshot resource.

" } }, "state": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionResourceState", "traits": { "smithy.api#documentation": "

The runtime status of the lifecycle action taken for the snapshot.

" } } }, "traits": { "smithy.api#documentation": "

Contains the state of an impacted snapshot resource that the runtime \n\t\t\tinstance of the lifecycle policy identified for action.

" } }, "com.amazonaws.imagebuilder#LifecycleExecutionSnapshotResourceList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionSnapshotResource" } }, "com.amazonaws.imagebuilder#LifecycleExecutionState": { "type": "structure", "members": { "status": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionStatus", "traits": { "smithy.api#documentation": "

The runtime status of the lifecycle execution.

" } }, "reason": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The reason for the current status.

" } } }, "traits": { "smithy.api#documentation": "

The current state of the runtime instance of the lifecycle policy.

" } }, "com.amazonaws.imagebuilder#LifecycleExecutionStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } }, "CANCELLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCESS" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } } } }, "com.amazonaws.imagebuilder#LifecycleExecutionsList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#LifecycleExecution" } }, "com.amazonaws.imagebuilder#LifecyclePolicy": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lifecycle policy resource.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the lifecycle policy.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Optional description for the lifecycle policy.

" } }, "status": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyStatus", "traits": { "smithy.api#documentation": "

Indicates whether the lifecycle policy resource is enabled. Only enabled\n\t\t\tpolicies run on their schedule. Disabling or deleting a policy removes its\n\t\t\tschedule and cancels any in-flight lifecycle execution.

" } }, "executionRole": { "target": "com.amazonaws.imagebuilder#RoleNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy. \n\t\t\tThis is a custom role that you create.

" } }, "resourceType": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceType", "traits": { "smithy.api#documentation": "

The type of resources the lifecycle policy targets.

" } }, "policyDetails": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetails", "traits": { "smithy.api#documentation": "

The list of rules for the lifecycle policy. Each rule pairs an action with a\n\t\t\tfilter and optional exclusion rules. A policy can contain at most one rule\n\t\t\tper action type.

" } }, "resourceSelection": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelection", "traits": { "smithy.api#documentation": "

Resource selection criteria used to run the lifecycle policy.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The timestamp when Image Builder created the lifecycle policy resource.

" } }, "dateUpdated": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The timestamp when Image Builder updated the lifecycle policy resource.

" } }, "dateLastRun": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The timestamp for the last time Image Builder ran the lifecycle policy.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

To help manage your lifecycle policy resources, you can assign your own \n\t\t\tmetadata to each resource in the form of tags. Each tag consists of a key and \n\t\t\tan optional value, both of which you define.

" } } }, "traits": { "smithy.api#documentation": "

Defines a lifecycle policy resource: its identity, status, execution role,\n\t\t\tresource type, rules, resource selection, timestamps, and tags.

" } }, "com.amazonaws.imagebuilder#LifecyclePolicyArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws):lifecycle-policy/[a-z0-9-_]+$" } }, "com.amazonaws.imagebuilder#LifecyclePolicyDetail": { "type": "structure", "members": { "action": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailAction", "traits": { "smithy.api#documentation": "

Configuration details for the policy action.

", "smithy.api#required": {} } }, "filter": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilter", "traits": { "smithy.api#documentation": "

Specifies the resources that the lifecycle policy applies to.

", "smithy.api#required": {} } }, "exclusionRules": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRules", "traits": { "smithy.api#documentation": "

Additional rules to specify resources that should be exempt from policy actions.

" } } }, "traits": { "smithy.api#documentation": "

Defines one lifecycle policy rule: the action to take, the filter that\n\t\t\tdetermines which resources the rule applies to, and optional exclusion\n\t\t\trules.

" } }, "com.amazonaws.imagebuilder#LifecyclePolicyDetailAction": { "type": "structure", "members": { "type": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailActionType", "traits": { "smithy.api#documentation": "

Specifies the lifecycle action to take. DELETE deletes the\n\t\t\timage resource and, with includeResources, also removes\n\t\t\tdistributed AMIs, snapshots, or container images. DEPRECATE and\n\t\t\tDISABLE set the corresponding status on the image resource and,\n\t\t\tif includeResources.amis is set, on its distributed AMIs.

", "smithy.api#required": {} } }, "includeResources": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailActionIncludeResources", "traits": { "smithy.api#documentation": "

Specifies which underlying resources the action extends to beyond the Image Builder\n\t\t\timage resource itself: distributed AMIs, their snapshots, or distributed\n\t\t\tcontainer images. DELETE rules can include all three,\n\t\t\tDEPRECATE and DISABLE rules can include AMIs only,\n\t\t\tand you can only include snapshots together with AMIs.

" } } }, "traits": { "smithy.api#documentation": "

Contains the action configuration for a lifecycle policy rule: the action to\n\t\t\ttake, and which underlying resources the action extends to.

" } }, "com.amazonaws.imagebuilder#LifecyclePolicyDetailActionIncludeResources": { "type": "structure", "members": { "amis": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the lifecycle action should apply to distributed AMIs.

" } }, "snapshots": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.

" } }, "containers": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the lifecycle action should apply to distributed containers.

" } } }, "traits": { "smithy.api#documentation": "

Specifies how the lifecycle policy should apply actions to selected resources.

" } }, "com.amazonaws.imagebuilder#LifecyclePolicyDetailActionType": { "type": "enum", "members": { "DELETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE" } }, "DEPRECATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPRECATE" } }, "DISABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLE" } } } }, "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRules": { "type": "structure", "members": { "tagMap": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image \n\t\t\tresources that have them.

" } }, "amis": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRulesAmis", "traits": { "smithy.api#documentation": "

Lists configuration values that apply to AMIs that Image Builder should exclude \n\t\t\tfrom the lifecycle action.

" } } }, "traits": { "smithy.api#documentation": "

Specifies resources that lifecycle policy actions should not apply to.

" } }, "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRulesAmis": { "type": "structure", "members": { "isPublic": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Configures whether public AMIs are excluded from the lifecycle action.

" } }, "regions": { "target": "com.amazonaws.imagebuilder#StringList", "traits": { "smithy.api#documentation": "

Configures Amazon Web Services Regions that are excluded from the lifecycle action.

" } }, "sharedAccounts": { "target": "com.amazonaws.imagebuilder#AccountList", "traits": { "smithy.api#documentation": "

The lifecycle action doesn't apply to AMIs that are shared with any of\n\t\t\tthe specified Amazon Web Services accounts.

" } }, "lastLaunched": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRulesAmisLastLaunched", "traits": { "smithy.api#documentation": "

Configures Image Builder to exclude AMIs that were launched within the specified time\n\t\t\tperiod from lifecycle actions. AMIs with no recorded last-launched time\n\t\t\taren't excluded by this rule.

" } }, "tagMap": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

Lifecycle actions don't apply to AMIs that have any of these tags. Both\n\t\t\tthe key and the value must match.

" } } }, "traits": { "smithy.api#documentation": "

Defines criteria for AMIs that are excluded from lifecycle actions.

" } }, "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRulesAmisLastLaunched": { "type": "structure", "members": { "value": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRulesAmisLastLaunchedValue", "traits": { "smithy.api#documentation": "

The integer number of units for the time period. For example 6 (months).

", "smithy.api#required": {} } }, "unit": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyTimeUnit", "traits": { "smithy.api#documentation": "

Defines the unit of time that the lifecycle policy uses to calculate elapsed\n\t\t\ttime since the last launch.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines criteria to exclude AMIs from lifecycle actions based on the last \n\t\t\ttime they were used to launch an instance.

" } }, "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRulesAmisLastLaunchedValue": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 365 } } }, "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilter": { "type": "structure", "members": { "type": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilterType", "traits": { "smithy.api#documentation": "

Filter resources based on either AGE or COUNT.\n\t\t\tYou can only use the count filter with the DELETE action\n\t\t\ttype.

", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilterValue", "traits": { "smithy.api#documentation": "

The number of units for the time period or for the count. For example, a value of \n\t\t\t6 might refer to six months or six AMIs.

\n \n

For count-based filters, this value represents the minimum number of resources \n\t\t\t\tto keep on hand. If you have fewer resources than this number, the resource is \n\t\t\t\texcluded from lifecycle actions.

\n
", "smithy.api#required": {} } }, "unit": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyTimeUnit", "traits": { "smithy.api#documentation": "

Defines the unit of time that the lifecycle policy uses to determine impacted \n\t\t\tresources. This is required for age-based rules.

" } }, "retainAtLeast": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilterRetainAtLeast", "traits": { "smithy.api#documentation": "

For age-based filters, this is the number of resources to keep on hand after the lifecycle \n\t\t\tDELETE action is applied. Impacted resources are only deleted if you have more than \n\t\t\tthis number of resources. If you have fewer resources than this number, the impacted resource \n\t\t\tis not deleted.

" } } }, "traits": { "smithy.api#documentation": "

Defines filters that the lifecycle policy uses to determine impacted resource.

" } }, "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilterRetainAtLeast": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 10 } } }, "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilterType": { "type": "enum", "members": { "AGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AGE" } }, "COUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COUNT" } } } }, "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilterValue": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.imagebuilder#LifecyclePolicyDetails": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetail" }, "traits": { "smithy.api#length": { "min": 1, "max": 3 } } }, "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelection": { "type": "structure", "members": { "recipes": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelectionRecipes", "traits": { "smithy.api#documentation": "

A list of recipes that are used as selection criteria for the output \n\t\t\timages that the lifecycle policy applies to.

" } }, "tagMap": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

A list of tags that are used as selection criteria for the Image Builder image \n\t\t\tresources that the lifecycle policy applies to.

" } } }, "traits": { "smithy.api#documentation": "

Resource selection criteria for the lifecycle policy. You must provide\n\t\t\texactly one selection criteria: either recipes or a tag map, not both.

" } }, "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelectionRecipe": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of an Image Builder recipe that the lifecycle policy uses for resource selection.

", "smithy.api#required": {} } }, "semanticVersion": { "target": "com.amazonaws.imagebuilder#WildcardVersionNumber", "traits": { "smithy.api#documentation": "

The version of the Image Builder recipe specified by the name field.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies an Image Builder recipe that the lifecycle policy uses for resource selection.

" } }, "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelectionRecipes": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelectionRecipe" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.imagebuilder#LifecyclePolicyResourceType": { "type": "enum", "members": { "AMI_IMAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMI_IMAGE" } }, "CONTAINER_IMAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTAINER_IMAGE" } } } }, "com.amazonaws.imagebuilder#LifecyclePolicyStatus": { "type": "enum", "members": { "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } } } }, "com.amazonaws.imagebuilder#LifecyclePolicySummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lifecycle policy.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the lifecycle policy.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Optional description for the lifecycle policy.

" } }, "status": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyStatus", "traits": { "smithy.api#documentation": "

The lifecycle policy resource status.

" } }, "executionRole": { "target": "com.amazonaws.imagebuilder#RoleNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy.

" } }, "resourceType": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceType", "traits": { "smithy.api#documentation": "

The type of resources the lifecycle policy targets.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The timestamp when Image Builder created the lifecycle policy resource.

" } }, "dateUpdated": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The timestamp when Image Builder updated the lifecycle policy resource.

" } }, "dateLastRun": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The timestamp for the last time Image Builder ran the lifecycle policy.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

To help manage your lifecycle policy resources, you can assign your own \n\t\t\tmetadata to each resource in the form of tags. Each tag consists of a key and \n\t\t\tan optional value, both of which you define.

" } } }, "traits": { "smithy.api#documentation": "

Contains a summary of lifecycle policy resources.

" } }, "com.amazonaws.imagebuilder#LifecyclePolicySummaryList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#LifecyclePolicySummary" } }, "com.amazonaws.imagebuilder#LifecyclePolicyTimeUnit": { "type": "enum", "members": { "DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DAYS" } }, "WEEKS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WEEKS" } }, "MONTHS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MONTHS" } }, "YEARS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "YEARS" } } } }, "com.amazonaws.imagebuilder#ListComponentBuildVersions": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListComponentBuildVersionsRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListComponentBuildVersionsResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of component build versions for the specified component\n\t\t\tversion ARN. You can only list build versions for components that your\n\t\t\taccount owns. Deprecated build versions aren't included in the\n\t\t\tresults.

", "smithy.api#examples": [ { "title": "List the build versions of a component", "documentation": "The following example lists the build versions that exist for version 1.0.0 of the specified component. The list returns the most recent build version first.", "input": { "componentVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0" }, "output": { "componentSummaryList": [ { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/2", "name": "my-example-component", "version": "1.0.0", "platform": "Linux", "supportedOsVersions": [ "Amazon Linux 2023" ], "state": { "status": "ACTIVE" }, "type": "BUILD", "owner": "111122223333", "description": "Installs the latest version of my application", "changeDescription": "Updated the install command to use dnf", "dateCreated": "2026-09-09T18:35:23.098Z", "tags": { "Environment": "Production" } }, { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1", "name": "my-example-component", "version": "1.0.0", "platform": "Linux", "supportedOsVersions": [ "Amazon Linux 2023" ], "state": { "status": "ACTIVE" }, "type": "BUILD", "owner": "111122223333", "description": "Installs the latest version of my application", "changeDescription": "Initial version", "dateCreated": "2026-09-09T18:35:20.731Z", "tags": { "Environment": "Production" } } ], "requestId": "1d8693f0-26e1-42d7-ba35-d95ace1ce7e0" } } ], "smithy.api#http": { "method": "POST", "uri": "/ListComponentBuildVersions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "componentSummaryList", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListComponentBuildVersionsRequest": { "type": "structure", "members": { "componentVersionArn": { "target": "com.amazonaws.imagebuilder#ComponentVersionArn", "traits": { "smithy.api#documentation": "

The component version ARN whose build versions you want to list. The ARN\n\t\t\tmust specify an exact version, without a build number suffix. If you\n\t\t\tdon't specify an ARN, Image Builder returns build versions for the components\n\t\t\tthat your account owns.

\n

If the ARN that you specify doesn't exist, Image Builder returns an empty list\n\t\t\trather than a ResourceNotFoundException error.

" } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListComponentBuildVersionsResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "componentSummaryList": { "target": "com.amazonaws.imagebuilder#ComponentSummaryList", "traits": { "smithy.api#documentation": "

The list of component summaries. Each summary represents one build version\n\t\t\tof the specified component version, or of the components that your account\n\t\t\towns if you didn't specify an ARN. Deprecated build versions aren't\n\t\t\tincluded.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListComponents": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListComponentsRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListComponentsResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns the list of components that you have access to. By default, the\n\t\t\tresponse doesn't include components in the\n\t\t\tDEPRECATED state. To list deprecated components, use the\n\t\t\tstatus filter with the value DEPRECATED.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Filtering: You can use wildcards (x) to specify the most recent versions or nodes when \n\tselecting the base image or components for your recipe. When you use a wildcard in any node, all nodes \n\tto the right of the first wildcard must also be wildcards.

\n
", "smithy.api#examples": [ { "title": "List components that you own", "documentation": "The following example lists the component versions that your account owns, filtered to components for the Linux platform.", "input": { "owner": "Self", "filters": [ { "name": "platform", "values": [ "Linux" ] } ] }, "output": { "componentVersionList": [ { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0", "name": "my-example-component", "version": "1.0.0", "description": "Installs my example application", "platform": "Linux", "supportedOsVersions": [ "Amazon Linux 2023" ], "type": "BUILD", "owner": "111122223333", "dateCreated": "2026-09-09T18:31:49.661Z", "status": "ACTIVE" }, { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-imported-component/1.0.0", "name": "my-example-imported-component", "version": "1.0.0", "description": "Installs my application from an imported shell script", "platform": "Linux", "type": "BUILD", "owner": "111122223333", "dateCreated": "2026-09-09T18:31:21.941Z", "status": "ACTIVE" }, { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-test-component/1.0.0", "name": "my-example-test-component", "version": "1.0.0", "description": "Verifies that my example application is installed", "platform": "Linux", "type": "TEST", "owner": "111122223333", "dateCreated": "2026-09-09T18:31:52.888Z", "status": "ACTIVE" } ], "requestId": "fc51d989-ca0a-4ac7-9ca6-fb7786e70955" } } ], "smithy.api#http": { "method": "POST", "uri": "/ListComponents", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "componentVersionList", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListComponentsRequest": { "type": "structure", "members": { "owner": { "target": "com.amazonaws.imagebuilder#Ownership", "traits": { "smithy.api#documentation": "

Filters results based on the type of owner for the component. By default, this request\n\t\t\treturns a list of components that your account owns. To see results for other types of\n\t\t\towners, you can specify components that Amazon manages, components from the\n\t\t\tAmazon Web Services Marketplace, third party components, or components that other accounts have shared\n\t\t\twith you.

" } }, "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { "smithy.api#documentation": "

Use the following filters to streamline results:

\n " } }, "byName": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether to return one entry per component name, with all versions\n\t\t\tof each component aggregated. Defaults to false, which returns\n\t\t\tone entry per component version. You can't combine this option with the\n\t\t\tversion filter.

" } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListComponentsResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "componentVersionList": { "target": "com.amazonaws.imagebuilder#ComponentVersionList", "traits": { "smithy.api#documentation": "

The list of component semantic versions.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n
" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListContainerRecipes": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListContainerRecipesRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListContainerRecipesResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of container recipes.

", "smithy.api#examples": [ { "title": "List the container recipes you own", "documentation": "The following example lists the container recipes that you own.", "input": { "owner": "Self" }, "output": { "requestId": "883e6f0e-8883-4c1a-9710-791afb74be0d", "containerRecipeSummaryList": [ { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0", "containerType": "DOCKER", "name": "my-example-container-recipe", "platform": "Linux", "owner": "111122223333", "parentImage": "amazonlinux:latest", "dateCreated": "2026-09-09T19:31:26.363Z" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListContainerRecipes", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "containerRecipeSummaryList", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListContainerRecipesRequest": { "type": "structure", "members": { "owner": { "target": "com.amazonaws.imagebuilder#Ownership", "traits": { "smithy.api#documentation": "

Returns container recipes belonging to the specified owner, that have been\n\t\t\tshared with you. You can omit this field to return container recipes\n\t\t\tbelonging to your account. For container recipes, the valid owner values are\n\t\t\tSelf, Shared, and Amazon.

" } }, "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { "smithy.api#documentation": "

Use the following filters to streamline results:

\n " } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListContainerRecipesResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "containerRecipeSummaryList": { "target": "com.amazonaws.imagebuilder#ContainerRecipeSummaryList", "traits": { "smithy.api#documentation": "

The list of container recipes returned for the request.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListDistributionConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListDistributionConfigurationsRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListDistributionConfigurationsResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of distribution configurations.

", "smithy.api#examples": [ { "title": "List distribution configurations that match a name filter", "documentation": "The following example lists the distribution configurations whose name matches the filter value.", "input": { "filters": [ { "name": "name", "values": [ "my-example-distribution-configuration" ] } ] }, "output": { "requestId": "1057325c-6b4a-4e16-ac6e-12f1d8fcc6f9", "distributionConfigurationSummaryList": [ { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution-configuration", "name": "my-example-distribution-configuration", "description": "Distributes AMIs to us-west-2", "dateCreated": "2026-09-09T21:09:02.581Z", "regions": [ "us-west-2" ] } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListDistributionConfigurations", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "distributionConfigurationSummaryList", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListDistributionConfigurationsRequest": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { "smithy.api#documentation": "

You can filter on name to streamline results.

" } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListDistributionConfigurationsResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "distributionConfigurationSummaryList": { "target": "com.amazonaws.imagebuilder#DistributionConfigurationSummaryList", "traits": { "smithy.api#documentation": "

The list of distributions.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListImageBuildVersions": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListImageBuildVersionsRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListImageBuildVersionsResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of image build versions.

", "smithy.api#examples": [ { "title": "List the build versions of an image", "documentation": "The following example lists the build versions that exist for version 1.0.0 of the specified image, with the output AMI that each build produced.", "input": { "imageVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0" }, "output": { "requestId": "b4808907-dcad-4951-ada5-dd151e93135a", "imageSummaryList": [ { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "name": "my-example-recipe", "type": "AMI", "version": "1.0.0/1", "platform": "Linux", "osVersion": "Amazon Linux 2023", "state": { "status": "AVAILABLE" }, "owner": "111122223333", "dateCreated": "2026-09-09T19:12:18.677Z", "outputResources": { "amis": [ { "region": "us-west-2", "image": "ami-1234567890abcdef0", "name": "my-example-recipe 2026-09-09T19-19-08.103311Z", "accountId": "111122223333" } ] }, "buildType": "USER_INITIATED" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListImageBuildVersions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "imageSummaryList", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListImageBuildVersionsRequest": { "type": "structure", "members": { "imageVersionArn": { "target": "com.amazonaws.imagebuilder#ImageVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image version whose build versions you want to retrieve.\n\t\t\tThe ARN must specify an exact version\n\t\t\t(..) - wildcards aren't allowed.\n\t\t\tThis parameter is optional. If you don't specify it, Image Builder returns build\n\t\t\tversions for all of the images in your account.

\n

If the ARN that you specify doesn't exist, Image Builder returns an empty list\n\t\t\trather than a ResourceNotFoundException error.

" } }, "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { "smithy.api#documentation": "

Use the following filters to streamline results:

\n " } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListImageBuildVersionsResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "imageSummaryList": { "target": "com.amazonaws.imagebuilder#ImageSummaryList", "traits": { "smithy.api#documentation": "

The list of image build versions.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListImagePackages": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListImagePackagesRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListImagePackagesResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Lists the packages that are associated with an image build version, as determined by\n\t\t\tAmazon Web Services Systems Manager Inventory at build time.

", "smithy.api#examples": [ { "title": "List the packages in an image build version", "documentation": "The following example lists the operating system packages that Image Builder detected in the specified image build version.", "input": { "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "output": { "requestId": "0363bd96-1a54-4736-a307-7ac6095744e0", "imagePackageList": [ { "packageName": "passwd", "packageVersion": "0.80" }, { "packageName": "dracut-config-ec2", "packageVersion": "3.1" }, { "packageName": "libsolv", "packageVersion": "0.7.22" }, { "packageName": "libxcrypt", "packageVersion": "4.4.33" }, { "packageName": "python3-policycoreutils", "packageVersion": "3.4" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListImagePackages", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "imagePackageList", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListImagePackagesRequest": { "type": "structure", "members": { "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image build version whose packages you want to list. The\n\t\t\tvalue must be a full build version ARN.

", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListImagePackagesResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "imagePackageList": { "target": "com.amazonaws.imagebuilder#ImagePackageList", "traits": { "smithy.api#documentation": "

The list of Image Packages returned in the response.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListImagePipelineImages": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListImagePipelineImagesRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListImagePipelineImagesResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of images created by the specified pipeline.

", "smithy.api#examples": [ { "title": "List the images that an image pipeline created", "documentation": "The following example lists the images that the specified pipeline created, including a build that is still in progress.", "input": { "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline" }, "output": { "requestId": "071a0ecb-b07d-4485-832c-e6b88de8ebed", "imageSummaryList": [ { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "name": "my-example-recipe", "type": "AMI", "version": "1.0.0/1", "platform": "Linux", "state": { "status": "BUILDING" }, "owner": "111122223333", "dateCreated": "2026-09-09T19:39:20.458Z", "outputResources": { "amis": [] }, "buildType": "USER_INITIATED" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListImagePipelineImages", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "imageSummaryList", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListImagePipelineImagesRequest": { "type": "structure", "members": { "imagePipelineArn": { "target": "com.amazonaws.imagebuilder#ImagePipelineArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline whose images you want to\n\t\t\tview.

\n

If the ARN that you specify doesn't exist, Image Builder returns an empty list\n\t\t\trather than a ResourceNotFoundException error.

", "smithy.api#required": {} } }, "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { "smithy.api#documentation": "

Use the following filters to streamline results:

\n " } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListImagePipelineImagesResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "imageSummaryList": { "target": "com.amazonaws.imagebuilder#ImageSummaryList", "traits": { "smithy.api#documentation": "

The list of images built by this pipeline.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListImagePipelines": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListImagePipelinesRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListImagePipelinesResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of image pipelines.

", "smithy.api#examples": [ { "title": "List image pipelines filtered by name", "documentation": "The following example lists the image pipelines in your account, using a filter to match a specific pipeline name.", "input": { "filters": [ { "name": "name", "values": [ "my-example-pipeline" ] } ] }, "output": { "requestId": "b818f3f9-b851-4de7-95f3-8fabed4e1841", "imagePipelineList": [ { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "name": "my-example-pipeline", "description": "Builds a new version of my image every Sunday", "platform": "Linux", "enhancedImageMetadataEnabled": true, "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "imageTestsConfiguration": { "imageTestsEnabled": true, "timeoutMinutes": 720 }, "schedule": { "scheduleExpression": "cron(0 9 ? * SUN *)", "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" }, "status": "ENABLED", "dateCreated": "2026-09-09T19:52:05.146Z", "dateUpdated": "2026-09-09T19:52:05.146Z" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListImagePipelines", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "imagePipelineList", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListImagePipelinesRequest": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { "smithy.api#documentation": "

Use the following filters to streamline results:

\n " } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListImagePipelinesResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "imagePipelineList": { "target": "com.amazonaws.imagebuilder#ImagePipelineList", "traits": { "smithy.api#documentation": "

The list of image pipelines.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListImageRecipes": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListImageRecipesRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListImageRecipesResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of image recipes.

", "smithy.api#examples": [ { "title": "List the image recipes that you own", "documentation": "The following example lists the image recipes that you own.", "input": { "owner": "Self" }, "output": { "requestId": "4b036f1a-3716-441d-a401-419249f6569e", "imageRecipeSummaryList": [ { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-linux-recipe/1.0.0", "name": "my-example-linux-recipe", "platform": "Linux", "owner": "111122223333", "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2023-x86/x.x.x", "dateCreated": "2026-09-09T19:30:33.064Z" }, { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-windows-recipe/1.0.0", "name": "my-example-windows-recipe", "platform": "Windows", "owner": "111122223333", "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2022-english-full-base-x86/x.x.x", "dateCreated": "2026-09-09T19:30:35.110Z" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListImageRecipes", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "imageRecipeSummaryList", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListImageRecipesRequest": { "type": "structure", "members": { "owner": { "target": "com.amazonaws.imagebuilder#Ownership", "traits": { "smithy.api#documentation": "

You can specify the recipe owner to filter results by that owner. By default, this request will\n\t\t\tonly show image recipes owned by your account. To filter by a different owner, specify one of the \n\t\t\tValid Values that are listed for this parameter.

" } }, "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { "smithy.api#documentation": "

Use the following filters to streamline results:

\n " } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListImageRecipesResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "imageRecipeSummaryList": { "target": "com.amazonaws.imagebuilder#ImageRecipeSummaryList", "traits": { "smithy.api#documentation": "

A list of ImageRecipeSummary objects that contain identifying characteristics for the \n\t\t\timage recipe, such as the name, the Amazon Resource Name (ARN), and the date created, along with other key details.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListImageScanFindingAggregations": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of image scan aggregations for your account. You can filter by the type\n\t\t\tof key that Image Builder uses to group results. For example, if you want to get a list of\n\t\t\tfindings by severity level for one of your pipelines, you might specify your pipeline\n\t\t\twith the imagePipelineArn filter. If you don't specify a filter, Image Builder\n\t\t\treturns an aggregation for your account.

\n

To streamline results, you can use the following filters in your request:

\n ", "smithy.api#examples": [ { "title": "List image scan finding aggregations for an image pipeline", "documentation": "The following example aggregates vulnerability findings for images that the specified pipeline created, with counts grouped by severity level.", "input": { "filter": { "name": "imagePipelineArn", "values": [ "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline" ] } }, "output": { "requestId": "b1c9dd23-7a9c-4a52-a1f7-3b8e9e17b2c4", "aggregationType": "imagePipelineArn", "responses": [ { "imagePipelineAggregation": { "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "severityCounts": { "all": 25, "critical": 1, "high": 7, "medium": 12 } } } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListImageScanFindingAggregations", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "responses" } } }, "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsRequest": { "type": "structure", "members": { "filter": { "target": "com.amazonaws.imagebuilder#Filter", "traits": { "smithy.api#documentation": "

A filter name and value pair that determines the type of aggregation\n\t\t\tthat Image Builder returns. Use one of the following filter names:

\n \n

If you don't specify a filter, Image Builder returns an aggregation for your account.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "aggregationType": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The aggregation type specifies what type of key is used to group the image scan\n\t\t\tfindings. Image Builder returns results based on the request filter. If you didn't specify a\n\t\t\tfilter in the request, the type defaults to accountId.

\n

\n Aggregation types\n

\n \n

Each aggregation includes counts by severity level for medium severity and higher\n\t\t\tlevel findings, plus a total for all of the findings for each key value.

" } }, "responses": { "target": "com.amazonaws.imagebuilder#ImageScanFindingAggregationsList", "traits": { "smithy.api#documentation": "

An array of image scan finding aggregations that match the filter criteria.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListImageScanFindings": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListImageScanFindingsRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListImageScanFindingsResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of image scan findings for your account. Amazon Inspector generates the\n\t\t\tfindings when it scans images that have scanning enabled.

", "smithy.api#examples": [ { "title": "List vulnerability findings for an image build", "documentation": "The following example lists the vulnerability findings that Amazon Inspector detected for the specified image build version.", "input": { "filters": [ { "name": "imageBuildVersionArn", "values": [ "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" ] } ] }, "output": { "requestId": "233de8e7-3b58-4319-a6af-f6774cf7d371", "findings": [ { "awsAccountId": "111122223333", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "type": "PACKAGE_VULNERABILITY", "description": "In the Linux kernel, the following vulnerability has been resolved:\n\nvirtio: break and reset virtio devices on device_shutdown()", "title": "CVE-2025-38064 - kernel", "remediation": { "recommendation": { "text": "None Provided" } }, "severity": "HIGH", "firstObservedAt": "2026-01-06T20:12:57Z", "updatedAt": "2026-01-06T20:12:57Z", "inspectorScore": 7.0, "inspectorScoreDetails": { "adjustedCvss": { "scoreSource": "AMAZON_CVE", "cvssSource": "AMAZON_CVE", "version": "3.1", "score": 7.0, "scoringVector": "CVSS:3.1/AV:L/AC:H/PR:L/UI:N/S:U/C:H/I:H/A:H", "adjustments": [] } }, "packageVulnerabilityDetails": { "vulnerabilityId": "CVE-2025-38064", "vulnerablePackages": [ { "name": "kernel", "version": "4.14.355", "epoch": 0, "release": "280.652.amzn2", "arch": "X86_64", "packageManager": "OS", "fixedInVersion": "0:5.15.189-131.202.amzn2", "remediation": "yum update kernel" } ], "source": "AMAZON_CVE", "cvss": [ { "baseScore": 7.0, "scoringVector": "CVSS:3.1/AV:L/AC:H/PR:L/UI:N/S:U/C:H/I:H/A:H", "version": "3.1", "source": "AMAZON_CVE" } ], "relatedVulnerabilities": [ "ALAS2-2025-2955", "ALAS2023-2025-1130" ], "sourceUrl": "https://alas.aws.amazon.com/cve/json/v1/CVE-2025-38064.json", "vendorSeverity": "Important", "vendorCreatedAt": "2025-06-18T00:00:00Z", "vendorUpdatedAt": "2025-06-25T00:00:00Z", "referenceUrls": [ "https://alas.aws.amazon.com/AL2/ALAS2-2025-2955.html", "https://alas.aws.amazon.com/AL2023/ALAS2023-2025-1130.html" ] }, "fixAvailable": "YES" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListImageScanFindings", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "findings", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListImageScanFindingsRequest": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.imagebuilder#ImageScanFindingsFilterList", "traits": { "smithy.api#documentation": "

An array of name value pairs that you can use to filter your results. You can use the\n\t\t\tfollowing filters to streamline results:

\n \n

If you don't request a filter, then all findings in your account are listed.

" } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListImageScanFindingsResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "findings": { "target": "com.amazonaws.imagebuilder#ImageScanFindingsList", "traits": { "smithy.api#documentation": "

The image scan findings for your account that meet your request filter\n\t\t\tcriteria.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListImages": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListImagesRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListImagesResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns the list of images that you have access to.

", "smithy.api#examples": [ { "title": "List images that you own", "documentation": "The following example lists the image versions that you own. Setting byName to false returns each image version as its own entry, instead of grouping build versions under their image name.", "input": { "owner": "Self", "byName": false }, "output": { "requestId": "19794296-a45f-4079-8741-e00d3c916318", "imageVersionList": [ { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0", "name": "my-example-recipe", "type": "AMI", "version": "1.0.0", "platform": "Linux", "osVersion": "Amazon Linux 2023", "owner": "111122223333", "dateCreated": "2026-09-09T19:12:18.677Z", "buildType": "USER_INITIATED" }, { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-windows-image/1.0.0", "name": "my-example-windows-image", "type": "AMI", "version": "1.0.0", "platform": "Windows", "osVersion": "Microsoft Windows Server 2025", "owner": "111122223333", "dateCreated": "2026-03-10T19:57:27.323Z", "buildType": "USER_INITIATED" }, { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-windows-image/1.0.1", "name": "my-example-windows-image", "type": "AMI", "version": "1.0.1", "platform": "Windows", "osVersion": "Microsoft Windows Server 2025", "owner": "111122223333", "dateCreated": "2026-03-10T20:32:31.795Z", "buildType": "USER_INITIATED" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListImages", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "imageVersionList", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListImagesRequest": { "type": "structure", "members": { "owner": { "target": "com.amazonaws.imagebuilder#Ownership", "traits": { "smithy.api#documentation": "

Filters the list to images owned by you, by Amazon, or shared with you by other accounts. \n\t\tBy default, only your account's images are returned.

" } }, "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { "smithy.api#documentation": "

Use the following filters to streamline results:

\n " } }, "byName": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether to return one entry per image name, with all versions of\n\t\t\teach image aggregated. Defaults to false, which returns one\n\t\t\tentry per image version. You can't combine this option with the\n\t\t\tversion filter.

" } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } }, "includeDeprecated": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether to include deprecated Amazon-managed images in the\n\t\t\tresults. Deprecated images that you own are always returned. Defaults to\n\t\t\tfalse.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListImagesResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "imageVersionList": { "target": "com.amazonaws.imagebuilder#ImageVersionList", "traits": { "smithy.api#documentation": "

The list of image semantic versions.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Filtering: You can use wildcards (x) to specify the most recent versions or nodes when \n\tselecting the base image or components for your recipe. When you use a wildcard in any node, all nodes \n\tto the right of the first wildcard must also be wildcards.

\n
" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListInfrastructureConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of infrastructure configurations.

", "smithy.api#examples": [ { "title": "List infrastructure configurations by name", "documentation": "The following example lists your infrastructure configurations, filtered to a specific resource name.", "input": { "filters": [ { "name": "name", "values": [ "my-example-infrastructure-configuration" ] } ] }, "output": { "requestId": "dbadaf86-3a9d-48fc-8e34-6062ef0a70f2", "infrastructureConfigurationSummaryList": [ { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure-configuration", "name": "my-example-infrastructure-configuration", "description": "An example infrastructure configuration for Amazon Linux builds", "dateCreated": "2026-09-09T19:37:17.350Z", "tags": { "Environment": "test" }, "instanceTypes": [ "m5.large", "m5.xlarge" ], "instanceProfileName": "EC2InstanceProfileForImageBuilder" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListInfrastructureConfigurations", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "infrastructureConfigurationSummaryList", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsRequest": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { "smithy.api#documentation": "

You can filter on name to streamline results.

" } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "infrastructureConfigurationSummaryList": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationSummaryList", "traits": { "smithy.api#documentation": "

The list of infrastructure configurations.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListLifecycleExecutionResources": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListLifecycleExecutionResourcesRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListLifecycleExecutionResourcesResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Lists resources that the runtime instance of the image lifecycle identified for lifecycle actions.

", "smithy.api#examples": [ { "title": "List the resources that a lifecycle execution acted on", "documentation": "The following example lists the resources that the specified lifecycle execution acted on. For a scheduled resource state update that hasn't started to apply changes yet, the resources list is empty.", "input": { "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503" }, "output": { "resources": [], "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503", "lifecycleExecutionState": { "status": "IN_PROGRESS" } } } ], "smithy.api#http": { "method": "POST", "uri": "/ListLifecycleExecutionResources", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "resources", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListLifecycleExecutionResourcesRequest": { "type": "structure", "members": { "lifecycleExecutionId": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", "traits": { "smithy.api#documentation": "

The unique identifier for a runtime instance of the lifecycle policy.

", "smithy.api#required": {} } }, "parentResourceId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an image build version to get the output resources for,\n\t\t\tsuch as AMIs or container images in Amazon ECR. You can get this value from the\n\t\t\tresourceId in the top-level response. If you leave this\n\t\t\tproperty empty, the response lists the Image Builder resources that the lifecycle\n\t\t\texecution identified for lifecycle actions. If the image build version that\n\t\t\tyou specify in parentResourceId wasn't part of this\n\t\t\tlifecycle execution, the response contains an empty list.

" } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListLifecycleExecutionResourcesResponse": { "type": "structure", "members": { "lifecycleExecutionId": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", "traits": { "smithy.api#documentation": "

The unique identifier for the runtime instance of the lifecycle policy.

" } }, "lifecycleExecutionState": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionState", "traits": { "smithy.api#documentation": "

The current state of the lifecycle runtime instance.

" } }, "resources": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionResourceList", "traits": { "smithy.api#documentation": "

A list of resources that were identified for lifecycle actions.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListLifecycleExecutions": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListLifecycleExecutionsRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListLifecycleExecutionsResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves the lifecycle runtime history for the specified resource.

", "smithy.api#examples": [ { "title": "List lifecycle executions for an image build version", "documentation": "The following example lists the lifecycle executions that have run against the specified image build version. The execution shown was started with StartResourceStateUpdate rather than a lifecycle policy, so it has no lifecyclePolicyArn.", "input": { "resourceArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "output": { "lifecycleExecutions": [ { "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503", "resourcesImpactedSummary": { "hasImpactedResources": false }, "state": { "status": "IN_PROGRESS" }, "startTime": "2026-09-09T21:42:29Z" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListLifecycleExecutions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "lifecycleExecutions", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListLifecycleExecutionsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } }, "resourceArn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which to list lifecycle executions. Specify a\n\t\t\tlifecycle policy ARN to list its executions, or an image build version ARN\n\t\t\tto list the executions that StartResourceStateUpdate\n\t\t\tstarted for that image. Other ARN types aren't valid for this\n\t\t\trequest.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListLifecycleExecutionsResponse": { "type": "structure", "members": { "lifecycleExecutions": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionsList", "traits": { "smithy.api#documentation": "

A list of lifecycle runtime instances for the specified resource.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListLifecyclePolicies": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListLifecyclePoliciesRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListLifecyclePoliciesResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retrieves a list of lifecycle policies in your Amazon Web Services account.

", "smithy.api#examples": [ { "title": "List enabled lifecycle policies", "documentation": "The following example lists the lifecycle policies in your account that have ENABLED status.", "input": { "filters": [ { "name": "status", "values": [ "ENABLED" ] } ] }, "output": { "lifecyclePolicySummaryList": [ { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-ami-policy", "name": "my-example-ami-policy", "description": "Deletes AMI image builds after they reach 6 months old", "status": "ENABLED", "executionRole": "arn:aws:iam::111122223333:role/my-example-lifecycle-role", "resourceType": "AMI_IMAGE", "dateCreated": "2026-09-09T19:36:17Z" }, { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-container-policy", "name": "my-example-container-policy", "description": "Deletes container image builds after they reach 6 months old", "status": "ENABLED", "executionRole": "arn:aws:iam::111122223333:role/my-example-lifecycle-role", "resourceType": "CONTAINER_IMAGE", "dateCreated": "2026-09-09T19:36:19Z" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListLifecyclePolicies", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "lifecyclePolicySummaryList", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListLifecyclePoliciesRequest": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { "smithy.api#documentation": "

Use the following filters to streamline results: name,\n\t\t\tresourceType, and status. Filter names are\n\t\t\tmatched exactly as shown.

" } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListLifecyclePoliciesResponse": { "type": "structure", "members": { "lifecyclePolicySummaryList": { "target": "com.amazonaws.imagebuilder#LifecyclePolicySummaryList", "traits": { "smithy.api#documentation": "

A list of lifecycle policies in your Amazon Web Services account that meet the criteria \n\t\t\tspecified in the request.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#InvalidParameterException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" } ], "traits": { "smithy.api#documentation": "

Returns the list of tags for the specified resource.

", "smithy.api#examples": [ { "title": "List the tags for a resource", "documentation": "The following example lists the tags that are assigned to an existing component build version.", "input": { "resourceArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1" }, "output": { "tags": { "CostCenter": "12345", "Environment": "Production" } } } ], "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.imagebuilder#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags for the specified resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListWaitingWorkflowSteps": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListWaitingWorkflowStepsRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListWaitingWorkflowStepsResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Lists the workflow steps in your Amazon Web Services account that have paused at a\n\t\t\tWaitForAction step, and are waiting for you to respond. To send\n\t\t\ta response, call SendWorkflowStepAction.

", "smithy.api#examples": [ { "title": "List workflow steps that are waiting for an action", "documentation": "The following example lists the workflow steps in your account that are paused at a WaitForAction step, waiting for you to resume or stop the workflow with SendWorkflowStepAction.", "input": { "maxResults": 25 }, "output": { "steps": [ { "stepExecutionId": "step-8eb24d7a-036e-46b5-94a3-90a5d8b5ac4a", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-wait-recipe/1.0.0/1", "workflowExecutionId": "wf-782460a6-8dc5-4262-90ff-0509eef0053c", "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-wait-workflow/1.0.0/1", "name": "WaitForApproval", "action": "WaitForAction", "startTime": "2026-09-09T20:02:59.931Z" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListWaitingWorkflowSteps", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "steps", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListWaitingWorkflowStepsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListWaitingWorkflowStepsResponse": { "type": "structure", "members": { "steps": { "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionList", "traits": { "smithy.api#documentation": "

An array of the workflow steps that are waiting for action in your\n\t\t\tAmazon Web Services account. Each step is paused at a WaitForAction step, and\n\t\t\tremains in the list until you respond with\n\t\t\tSendWorkflowStepAction or the wait times out.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListWorkflowBuildVersions": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListWorkflowBuildVersionsRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListWorkflowBuildVersionsResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of build versions for a specific workflow resource.

", "smithy.api#examples": [ { "title": "List the build versions of a workflow", "documentation": "The following example lists the build versions that exist for version 1.0.0 of the specified workflow, with the most recent build version first and the change description for each build version showing what changed.", "input": { "workflowVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0" }, "output": { "workflowSummaryList": [ { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/2", "name": "my-example-workflow", "version": "1.0.0", "description": "Workflow to build my example image", "changeDescription": "Added a step to collect image metadata from the build instance", "type": "BUILD", "owner": "111122223333", "dateCreated": "2026-09-09T19:56:38.339Z" }, { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1", "name": "my-example-workflow", "version": "1.0.0", "description": "Workflow to build my example image", "changeDescription": "Initial version", "type": "BUILD", "owner": "111122223333", "dateCreated": "2026-09-09T19:41:14.997Z" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListWorkflowBuildVersions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "workflowSummaryList", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListWorkflowBuildVersionsRequest": { "type": "structure", "members": { "workflowVersionArn": { "target": "com.amazonaws.imagebuilder#WorkflowWildcardVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource for which to get a list of build versions.\n\t\t\tThe version segments can contain wildcards (x) to match multiple\n\t\t\tversions of the workflow. If you don't specify an ARN, the response lists build\n\t\t\tversions for all of the workflows in your account.

" } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListWorkflowBuildVersionsResponse": { "type": "structure", "members": { "workflowSummaryList": { "target": "com.amazonaws.imagebuilder#WorkflowSummaryList", "traits": { "smithy.api#documentation": "

A list that contains metadata for the build versions of the workflow\n\t\t\tresource specified in the request.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListWorkflowExecutions": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListWorkflowExecutionsRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListWorkflowExecutionsResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of workflow runtime instance metadata objects for a specific image build\n\t\t\tversion.

", "smithy.api#examples": [ { "title": "List the workflow runtime instances for an image build version", "documentation": "The following example lists the workflow runtime instances that ran for the specified image build version, which was built with the Image Builder default build and test workflows.", "input": { "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "output": { "requestId": "c78ef9a3-cce8-4e7d-ae96-426fb7e59f5d", "workflowExecutions": [ { "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:aws:workflow/build/build-image/1.0.3/1", "workflowExecutionId": "wf-165b1cb6-3a62-4618-a021-94ddcbe32908", "type": "BUILD", "status": "COMPLETED", "totalStepCount": 7, "totalStepsSucceeded": 5, "totalStepsFailed": 0, "totalStepsSkipped": 2, "startTime": "2026-09-09T19:12:23.175Z", "endTime": "2026-09-09T19:19:06.158Z", "retried": false }, { "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:aws:workflow/test/test-image/1.0.3/1", "workflowExecutionId": "wf-1a3639b8-1366-4b73-8347-706874020dad", "type": "TEST", "status": "COMPLETED", "totalStepCount": 4, "totalStepsSucceeded": 2, "totalStepsFailed": 0, "totalStepsSkipped": 2, "startTime": "2026-09-09T19:19:11.709Z", "endTime": "2026-09-09T19:21:47.830Z", "retried": false } ], "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" } } ], "smithy.api#http": { "method": "POST", "uri": "/ListWorkflowExecutions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "workflowExecutions", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListWorkflowExecutionsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

List all workflow runtime instances for the specified image build version \n\t\t\tresource ARN.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListWorkflowExecutionsResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "workflowExecutions": { "target": "com.amazonaws.imagebuilder#WorkflowExecutionsList", "traits": { "smithy.api#documentation": "

An array of runtime details that represents each time a workflow ran for\n\t\t\tthe requested image build version. Image Builder retains workflow execution records\n\t\t\tfor a limited time, so this array can be empty for older image build\n\t\t\tversions.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The resource Amazon Resource Name (ARN) of the image build version for which you requested a list of \n\t\t\tworkflow runtime details.

" } }, "message": { "target": "com.amazonaws.imagebuilder#ImageBuildMessage", "traits": { "smithy.api#documentation": "

The failure reason for the image build version, if it's in a failed state.\n\t\t\tThis comes from the image itself, not from an individual workflow, so it's\n\t\t\tavailable even when no workflow executions remain for the image.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListWorkflowStepExecutions": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListWorkflowStepExecutionsRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListWorkflowStepExecutionsResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns runtime data for each step in a runtime instance of the workflow \n\t\t\tthat you specify in the request.

", "smithy.api#examples": [ { "title": "List the steps that ran in a workflow execution", "documentation": "The following example lists runtime details for each step in the specified runtime instance of a workflow, in this case the build workflow from an image build.", "input": { "workflowExecutionId": "wf-165b1cb6-3a62-4618-a021-94ddcbe32908" }, "output": { "requestId": "c6258beb-bc78-40dc-8bf9-fa5a8a93d3f3", "steps": [ { "stepExecutionId": "step-2e6fef0d-657c-4b7e-8706-ff24da9afa01", "name": "LaunchBuildInstance", "action": "LaunchInstance", "status": "COMPLETED", "inputs": "{\"waitFor\": \"ssmAgent\"}", "outputs": "{\"instanceId\": \"i-1234567890abcdef0\"}", "startTime": "2026-09-09T19:12:23.418Z", "endTime": "2026-09-09T19:14:50.822Z" }, { "stepExecutionId": "step-f76c24fe-dc70-435b-8dc1-987a0ca6d5a5", "name": "ApplyBuildComponents", "action": "ExecuteComponents", "status": "SKIPPED", "inputs": "{\"instanceId.$\": \"$.stepOutputs.LaunchBuildInstance.instanceId\"}", "startTime": "2026-09-09T19:14:51.229Z", "endTime": "2026-09-09T19:14:51.229Z" }, { "stepExecutionId": "step-aa880a39-e72c-4561-aa05-eb3de860441a", "name": "InventoryCollection", "action": "CollectImageMetadata", "status": "COMPLETED", "inputs": "{\"instanceId\": \"i-1234567890abcdef0\"}", "outputs": "{\"osVersion\": \"Amazon Linux 2023\", \"associationId\": \"7416ce2e-4ee8-4660-8c42-a09a03f61010\"}", "startTime": "2026-09-09T19:14:51.818Z", "endTime": "2026-09-09T19:16:26.267Z" }, { "stepExecutionId": "step-572bdd17-25c4-4729-9f2e-7fd611807751", "name": "RunSanitizeScript", "action": "SanitizeInstance", "status": "COMPLETED", "outputs": "{\"status\": \"Success\", \"output\": \"Skipping cleanup\\n\", \"runCommandId\": \"9eef9fe1-12e8-4c97-8e9a-4e79632864f4\"}", "startTime": "2026-09-09T19:16:26.742Z", "endTime": "2026-09-09T19:16:36.559Z" }, { "stepExecutionId": "step-06026579-939d-4b1b-b36e-fa58cb712a48", "name": "RunSysPrepScript", "action": "RunSysPrep", "status": "SKIPPED", "inputs": "{\"instanceId.$\": \"$.stepOutputs.LaunchBuildInstance.instanceId\"}", "startTime": "2026-09-09T19:16:36.973Z", "endTime": "2026-09-09T19:16:36.973Z" }, { "stepExecutionId": "step-50e4312d-400c-453e-957c-714cbee6961c", "name": "CreateOutputAMI", "action": "CreateImage", "status": "COMPLETED", "inputs": "{\"instanceId\": \"i-1234567890abcdef0\"}", "outputs": "{\"imageId\": \"ami-1234567890abcdef0\"}", "startTime": "2026-09-09T19:16:37.499Z", "endTime": "2026-09-09T19:19:02.135Z" }, { "stepExecutionId": "step-22673db0-e280-4948-b9b5-789791531c34", "name": "TerminateBuildInstance", "action": "TerminateInstance", "status": "COMPLETED", "inputs": "{\"instanceId\": \"i-1234567890abcdef0\"}", "startTime": "2026-09-09T19:19:02.546Z", "endTime": "2026-09-09T19:19:06.132Z" } ], "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:aws:workflow/build/build-image/1.0.3/1", "workflowExecutionId": "wf-165b1cb6-3a62-4618-a021-94ddcbe32908", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" } } ], "smithy.api#http": { "method": "POST", "uri": "/ListWorkflowStepExecutions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "steps", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListWorkflowStepExecutionsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } }, "workflowExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", "traits": { "smithy.api#documentation": "

The unique identifier that Image Builder assigned to keep track of runtime details\n\t\t\twhen it ran the workflow.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListWorkflowStepExecutionsResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "steps": { "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionsList", "traits": { "smithy.api#documentation": "

Contains an array of runtime details that represents each step in this runtime \n\t\t\tinstance of the workflow.

" } }, "workflowBuildVersionArn": { "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", "traits": { "smithy.api#documentation": "

The build version Amazon Resource Name (ARN) for the Image Builder workflow resource that defines the steps for \n\t\t\tthis runtime instance of the workflow.

" } }, "workflowExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", "traits": { "smithy.api#documentation": "

The unique identifier that Image Builder assigned to keep track of runtime details\n\t\t\twhen it ran the workflow.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The image build version resource Amazon Resource Name (ARN) that's associated with the specified runtime \n\t\t\tinstance of the workflow.

" } }, "message": { "target": "com.amazonaws.imagebuilder#ImageBuildMessage", "traits": { "smithy.api#documentation": "

The output message from the list action, if applicable.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ListWorkflows": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#ListWorkflowsRequest" }, "output": { "target": "com.amazonaws.imagebuilder#ListWorkflowsResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Lists workflow versions based on filtering parameters. To list the build\n\t\t\tversions of a specific workflow version, call\n\t\t\tListWorkflowBuildVersions.

", "smithy.api#examples": [ { "title": "List workflows that you own", "documentation": "The following example lists the workflow versions that you own.", "input": { "owner": "Self" }, "output": { "workflowVersionList": [ { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-build-workflow/1.0.0", "name": "my-example-build-workflow", "version": "1.0.0", "description": "Builds my example image", "type": "BUILD", "owner": "111122223333", "dateCreated": "2026-09-09T19:56:09.033Z" }, { "arn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/test/my-example-test-workflow/1.0.0", "name": "my-example-test-workflow", "version": "1.0.0", "description": "Tests my example image", "type": "TEST", "owner": "111122223333", "dateCreated": "2026-09-09T19:56:12.440Z" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/ListWorkflows", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "workflowVersionList", "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListWorkflowsRequest": { "type": "structure", "members": { "owner": { "target": "com.amazonaws.imagebuilder#Ownership", "traits": { "smithy.api#documentation": "

Filters results based on the workflow owner. By default, this request returns\n\t\t\tthe workflows that your account owns (Self). Specify\n\t\t\tAmazon to list the workflows that Image Builder manages. Image Builder rejects\n\t\t\tthe Shared and ThirdParty owner values for\n\t\t\tworkflows, and AWSMarketplace returns no results.

" } }, "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { "smithy.api#documentation": "

Filters to narrow the list of workflows. You can filter on\n\t\t\tname, version, description, and\n\t\t\ttype.

" } }, "byName": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether to return one entry per workflow name, with all versions of\n\t\t\teach workflow aggregated. Defaults to false, which returns one\n\t\t\tentry per workflow version. You can't combine this option with the\n\t\t\tversion filter.

" } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to return in a single request. If you don't specify\n\ta value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items.\n\tA page can contain fewer items than the maximum, with a nextToken to continue paging.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. Use the nextToken value \n\tfrom a previously truncated response.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#ListWorkflowsResponse": { "type": "structure", "members": { "workflowVersionList": { "target": "com.amazonaws.imagebuilder#WorkflowVersionList", "traits": { "smithy.api#documentation": "

A list of workflow versions that match the request criteria.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#LogGroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^[a-zA-Z0-9\\-_/\\.]{1,512}$" } }, "com.amazonaws.imagebuilder#Logging": { "type": "structure", "members": { "s3Logs": { "target": "com.amazonaws.imagebuilder#S3Logs", "traits": { "smithy.api#documentation": "

The Amazon S3 logging configuration.

" } } }, "traits": { "smithy.api#documentation": "

Logging configuration defines where Image Builder uploads your logs.

" } }, "com.amazonaws.imagebuilder#MarketplaceResourceLocation": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^s3://[^/]+/.+[^/]$" } }, "com.amazonaws.imagebuilder#MarketplaceResourceType": { "type": "enum", "members": { "COMPONENT_DATA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPONENT_DATA" } }, "COMPONENT_ARTIFACT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPONENT_ARTIFACT" } } } }, "com.amazonaws.imagebuilder#MaxParallelLaunches": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.imagebuilder#MaximumSeverityLabel": { "type": "enum", "members": { "INFORMATIONAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INFORMATIONAL" } }, "LOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOW" } }, "MEDIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEDIUM" } }, "HIGH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HIGH" } } } }, "com.amazonaws.imagebuilder#NonEmptyMaxLengthString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 384000 } } }, "com.amazonaws.imagebuilder#NonEmptyString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.imagebuilder#NonEmptyStringList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#NonEmptyString" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.imagebuilder#NonNegativeDouble": { "type": "double", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.imagebuilder#NullableBoolean": { "type": "boolean" }, "com.amazonaws.imagebuilder#OnWorkflowFailure": { "type": "enum", "members": { "CONTINUE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTINUE" } }, "ABORT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ABORT" } } } }, "com.amazonaws.imagebuilder#OrganizationArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:organizations::[0-9]{12}:organization/o-[a-z0-9]{10,32}$" } }, "com.amazonaws.imagebuilder#OrganizationArnList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#OrganizationArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.imagebuilder#OrganizationalUnitArn": { "type": "string", "traits": { "smithy.api#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}$" } }, "com.amazonaws.imagebuilder#OrganizationalUnitArnList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#OrganizationalUnitArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.imagebuilder#OsVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.imagebuilder#OsVersionList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#OsVersion" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.imagebuilder#OutputResources": { "type": "structure", "members": { "amis": { "target": "com.amazonaws.imagebuilder#AmiList", "traits": { "smithy.api#documentation": "

The Amazon EC2 AMIs created by this image. The list contains one entry per\n\t\t\tAMI, including copies that distribution created in each target\n\t\t\tAmazon Web Services Region and account.

" } }, "containers": { "target": "com.amazonaws.imagebuilder#ContainerList", "traits": { "smithy.api#documentation": "

The container images that Image Builder created when it built this image, stored in\n\t\t\tthe output Amazon ECR repository.

" } } }, "traits": { "smithy.api#documentation": "

The resources produced by this image.

" } }, "com.amazonaws.imagebuilder#Ownership": { "type": "enum", "members": { "SELF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Self" } }, "SHARED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Shared" } }, "AMAZON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Amazon" } }, "THIRDPARTY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ThirdParty" } }, "AWS_MARKETPLACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWSMarketplace" } } } }, "com.amazonaws.imagebuilder#PackageArchitecture": { "type": "string" }, "com.amazonaws.imagebuilder#PackageEpoch": { "type": "integer" }, "com.amazonaws.imagebuilder#PackageVulnerabilityDetails": { "type": "structure", "members": { "vulnerabilityId": { "target": "com.amazonaws.imagebuilder#VulnerabilityId", "traits": { "smithy.api#documentation": "

A unique identifier for this vulnerability.

", "smithy.api#required": {} } }, "vulnerablePackages": { "target": "com.amazonaws.imagebuilder#VulnerablePackageList", "traits": { "smithy.api#documentation": "

The packages that this vulnerability impacts.

" } }, "source": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The source of the vulnerability information.

" } }, "cvss": { "target": "com.amazonaws.imagebuilder#CvssScoreList", "traits": { "smithy.api#documentation": "

The CVSS scores for the vulnerability in this finding, as published\n\t\t\tby the vulnerability sources. Sources include NVD and the operating system\n\t\t\tvendor, and scores can span CVSS versions.

" } }, "relatedVulnerabilities": { "target": "com.amazonaws.imagebuilder#VulnerabilityIdList", "traits": { "smithy.api#documentation": "

Vulnerabilities that are often related to the findings for the package.

" } }, "sourceUrl": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

A link to the source of the vulnerability information.

" } }, "vendorSeverity": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The severity that the vendor assigned to this vulnerability type.

" } }, "vendorCreatedAt": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The date and time when this vulnerability was first added to the vendor's\n\t\t\tdatabase.

" } }, "vendorUpdatedAt": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The date and time when the vendor last updated this vulnerability in their\n\t\t\tdatabase.

" } }, "referenceUrls": { "target": "com.amazonaws.imagebuilder#NonEmptyStringList", "traits": { "smithy.api#documentation": "

Links to web pages that contain details about the vulnerabilities that Amazon Inspector\n\t\t\tidentified for the package.

" } } }, "traits": { "smithy.api#documentation": "

Information about package vulnerability findings.

" } }, "com.amazonaws.imagebuilder#PaginationToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 65535 } } }, "com.amazonaws.imagebuilder#ParallelGroup": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9-_+#]{0,99}$" } }, "com.amazonaws.imagebuilder#ParentInstanceConfiguration": { "type": "structure", "members": { "autoScalingGroup": { "target": "com.amazonaws.imagebuilder#AutoScalingGroupConfiguration", "traits": { "smithy.api#documentation": "

The Amazon EC2 Auto Scaling group that Image Builder takes the build instance from. This is\n\t\t\trequired when you specify parentInstance.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Settings for building on an instance that is already running, instead of an\n\t\t\tinstance that Image Builder launches for the build.

" } }, "com.amazonaws.imagebuilder#PipelineExecutionStartCondition": { "type": "enum", "members": { "EXPRESSION_MATCH_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPRESSION_MATCH_ONLY" } }, "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" } } } }, "com.amazonaws.imagebuilder#PipelineLoggingConfiguration": { "type": "structure", "members": { "imageLogGroupName": { "target": "com.amazonaws.imagebuilder#LogGroupName", "traits": { "smithy.api#documentation": "

Specifies the CloudWatch Logs log group name for image build logs.\n\t\t\tThe log group name can contain alphanumeric characters, hyphens,\n\t\t\tunderscores, forward slashes, and periods, up to 512 characters.\n\t\t\tLog group names not starting with /aws/imagebuilder/\n\t\t\trequire an executionRole with CloudWatch Logs write\n\t\t\tpermissions. If not specified, defaults to\n\t\t\t/aws/imagebuilder/image-name.

" } }, "pipelineLogGroupName": { "target": "com.amazonaws.imagebuilder#LogGroupName", "traits": { "smithy.api#documentation": "

Specifies the CloudWatch Logs log group name for pipeline execution\n\t\t\tlogs. The log group name can contain alphanumeric characters, hyphens,\n\t\t\tunderscores, forward slashes, and periods, up to 512 characters.\n\t\t\tLog group names not starting with /aws/imagebuilder/\n\t\t\trequire an executionRole with CloudWatch Logs write\n\t\t\tpermissions. If not specified, defaults to\n\t\t\t/aws/imagebuilder/pipeline/pipeline-name.

" } } }, "traits": { "smithy.api#documentation": "

The logging configuration that's defined for pipeline execution.

" } }, "com.amazonaws.imagebuilder#PipelineStatus": { "type": "enum", "members": { "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } } } }, "com.amazonaws.imagebuilder#Placement": { "type": "structure", "members": { "availabilityZone": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Availability Zone where your build and test instances will launch.

" } }, "tenancy": { "target": "com.amazonaws.imagebuilder#TenancyType", "traits": { "smithy.api#documentation": "

The tenancy of the instance. An instance with a tenancy of dedicated \n\t\t\truns on single-tenant hardware. An instance with a tenancy of host runs \n\t\t\ton a Dedicated Host.

\n

If tenancy is set to host, then you can optionally specify one target \n\t\t\tfor placement \u2013 either host ID or host resource group ARN. If automatic placement \n\t\t\tis enabled for your host, and you don't specify any placement target, Amazon EC2 will try to \n\t\t\tfind an available host for your build and test instances.

" } }, "hostId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The ID of the Dedicated Host on which build and test instances run. This only\n\t\t\tapplies if tenancy is host.

" } }, "hostResourceGroupArn": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances.\n\t\t\tThis only applies if tenancy is host.

" } } }, "traits": { "smithy.api#documentation": "

By default, EC2 instances run on shared tenancy hardware. This means that multiple \n\t\t\tAmazon Web Services accounts might share the same physical hardware. When you use dedicated hardware, \n\t\t\tthe physical server that hosts your instances is dedicated to your Amazon Web Services account. \n\t\t\tInstance placement settings contain the details for the physical hardware where \n\t\t\tinstances that Image Builder launches during image creation will run.

" } }, "com.amazonaws.imagebuilder#Platform": { "type": "enum", "members": { "WINDOWS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Windows" } }, "LINUX": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Linux" } }, "MACOS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "macOS" } } } }, "com.amazonaws.imagebuilder#ProductCodeId": { "type": "string", "traits": { "smithy.api#pattern": "^[A-Za-z0-9]{1,25}$" } }, "com.amazonaws.imagebuilder#ProductCodeList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#ProductCodeListItem" } }, "com.amazonaws.imagebuilder#ProductCodeListItem": { "type": "structure", "members": { "productCodeId": { "target": "com.amazonaws.imagebuilder#ProductCodeId", "traits": { "smithy.api#documentation": "

For Amazon Web Services Marketplace components, this contains the product code ID that can be stamped onto \n\t\t\tan EC2 AMI to ensure that components are billed correctly. If this property is empty, \n\t\t\tit might mean that the component is not published.

", "smithy.api#required": {} } }, "productCodeType": { "target": "com.amazonaws.imagebuilder#ProductCodeType", "traits": { "smithy.api#documentation": "

The owner of the product code that's billed. If this property is \n\t\t\tempty, it might mean that the component is not published.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Information about a single product code.

" } }, "com.amazonaws.imagebuilder#ProductCodeType": { "type": "enum", "members": { "MARKETPLACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "marketplace" } } } }, "com.amazonaws.imagebuilder#PutComponentPolicy": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#PutComponentPolicyRequest" }, "output": { "target": "com.amazonaws.imagebuilder#PutComponentPolicyResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidParameterValueException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Applies a policy to a component. The preferred way to share resources is with\n\t\t\tthe RAM API CreateResourceShare. If you use the PutComponentPolicy operation instead, you\n\t\t\tmust also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource\n\t\t\tisn't visible to the principals that it's shared with.

", "smithy.api#examples": [ { "title": "Share a component with another account", "documentation": "The following example applies a resource policy that grants another account permission to get and list the component.", "input": { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-shared-component/1.0.0/1", "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetComponent\", \"imagebuilder:ListComponents\"], \"Resource\": [\"arn:aws:imagebuilder:us-west-2:111122223333:component/my-shared-component/1.0.0/1\"]}]}" }, "output": { "requestId": "ad5a3a66-95c0-4eb5-b34e-f28980256275", "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-shared-component/1.0.0/1" } } ], "smithy.api#http": { "method": "PUT", "uri": "/PutComponentPolicy", "code": 200 } } }, "com.amazonaws.imagebuilder#PutComponentPolicyRequest": { "type": "structure", "members": { "componentArn": { "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that this policy should be applied\n\t\t\tto.

", "smithy.api#required": {} } }, "policy": { "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", "traits": { "smithy.api#documentation": "

The policy to apply.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#PutComponentPolicyResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "componentArn": { "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that this policy was applied\n\t\t\tto.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#PutContainerRecipePolicy": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#PutContainerRecipePolicyRequest" }, "output": { "target": "com.amazonaws.imagebuilder#PutContainerRecipePolicyResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidParameterValueException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Applies a policy to a container recipe. The preferred way to share resources is with\n\t\t\tthe RAM API CreateResourceShare. If you use the PutContainerRecipePolicy operation instead, you\n\t\t\tmust also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource\n\t\t\tisn't visible to the principals that it's shared with.

", "smithy.api#examples": [ { "title": "Share a container recipe with another account", "documentation": "The following example applies a resource policy that grants another AWS account permission to view and use the specified container recipe.", "input": { "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe-shared/1.0.0", "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Sid\": \"AllowSharedAccountContainerRecipeAccess\", \"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetContainerRecipe\", \"imagebuilder:ListContainerRecipes\"], \"Resource\": \"arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe-shared/1.0.0\"}]}" }, "output": { "requestId": "dd917975-9d5d-49ce-9d94-daa753088dec", "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe-shared/1.0.0" } } ], "smithy.api#http": { "method": "PUT", "uri": "/PutContainerRecipePolicy", "code": 200 } } }, "com.amazonaws.imagebuilder#PutContainerRecipePolicyRequest": { "type": "structure", "members": { "containerRecipeArn": { "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that this policy should be\n\t\t\tapplied to.

", "smithy.api#required": {} } }, "policy": { "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", "traits": { "smithy.api#documentation": "

The policy to apply to the container recipe.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#PutContainerRecipePolicyResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "containerRecipeArn": { "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that this policy was applied\n\t\t\tto.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#PutImagePolicy": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#PutImagePolicyRequest" }, "output": { "target": "com.amazonaws.imagebuilder#PutImagePolicyResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidParameterValueException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Applies a policy to an image. The preferred way to share resources is with\n\t\t\tthe RAM API CreateResourceShare. If you use the PutImagePolicy operation instead, you\n\t\t\tmust also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource\n\t\t\tisn't visible to the principals that it's shared with.

", "smithy.api#examples": [ { "title": "Share an image with another AWS account", "documentation": "The following example applies a resource policy to an image build version that grants another AWS account permission to view the image.", "input": { "imageArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetImage\", \"imagebuilder:ListImages\"], \"Resource\": [\"arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1\"]}]}" }, "output": { "requestId": "7bbf7e76-0f08-430d-b77e-17c161725825", "imageArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" } } ], "smithy.api#http": { "method": "PUT", "uri": "/PutImagePolicy", "code": 200 } } }, "com.amazonaws.imagebuilder#PutImagePolicyRequest": { "type": "structure", "members": { "imageArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that this policy should be applied\n\t\t\tto.

", "smithy.api#required": {} } }, "policy": { "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", "traits": { "smithy.api#documentation": "

The resource policy to apply to the image, as a JSON policy document.\n\t\t\tImage Builder validates the policy with Amazon Web Services RAM before applying it, and rejects\n\t\t\tinvalid policies with InvalidParameterValueException.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#PutImagePolicyResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "imageArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that this policy was applied to.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#PutImageRecipePolicy": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#PutImageRecipePolicyRequest" }, "output": { "target": "com.amazonaws.imagebuilder#PutImageRecipePolicyResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#InvalidParameterValueException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Applies a policy to an image recipe. The preferred way to share resources is with\n\t\t\tthe RAM API CreateResourceShare. If you use the PutImageRecipePolicy operation instead, you\n\t\t\tmust also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource\n\t\t\tisn't visible to the principals that it's shared with.

", "smithy.api#examples": [ { "title": "Share an image recipe with another account", "documentation": "The following example applies a resource policy that grants another AWS account permission to view the specified image recipe.", "input": { "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetImageRecipe\", \"imagebuilder:ListImageRecipes\"], \"Resource\": \"arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0\"}]}" }, "output": { "requestId": "3a27bb63-329e-40ab-88f2-c1638504bd35", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0" } } ], "smithy.api#http": { "method": "PUT", "uri": "/PutImageRecipePolicy", "code": 200 } } }, "com.amazonaws.imagebuilder#PutImageRecipePolicyRequest": { "type": "structure", "members": { "imageRecipeArn": { "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that this policy should be applied\n\t\t\tto.

", "smithy.api#required": {} } }, "policy": { "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", "traits": { "smithy.api#documentation": "

The policy to apply.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#PutImageRecipePolicyResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "imageRecipeArn": { "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that this policy was applied\n\t\t\tto.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#RegionFailure": { "type": "structure", "members": { "region": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Region where the failure occurred.

" } }, "status": { "target": "com.amazonaws.imagebuilder#RegionFailureStatus", "traits": { "smithy.api#documentation": "

The failure status for the Region. Indicates whether the process failed, was\n\t\t\tcanceled, or timed out.

" } }, "imageConfigurationStep": { "target": "com.amazonaws.imagebuilder#ImageConfigurationStep", "traits": { "smithy.api#documentation": "

The image configuration step where the failure occurred. Image Builder sets this property\n\t\t\twhen the failure happened during post-distribution configuration, such as launch\n\t\t\ttemplate updates or virtual machine (VM) export. This property doesn't appear\n\t\t\tfor failures that occurred while Image Builder copied the image to the Region.

" } }, "errorMessage": { "target": "com.amazonaws.imagebuilder#NonEmptyMaxLengthString", "traits": { "smithy.api#documentation": "

The error message for the failure in the Region.

" } }, "targetAccountId": { "target": "com.amazonaws.imagebuilder#AccountId", "traits": { "smithy.api#documentation": "

The account ID of the account that the image was distributed to in the\n\t\t\tRegion.

" } } }, "traits": { "smithy.api#documentation": "

Contains details about a distribution or image configuration failure for a single\n\t\t\tRegion.

" } }, "com.amazonaws.imagebuilder#RegionFailureList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#RegionFailure" }, "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.imagebuilder#RegionFailureStatus": { "type": "enum", "members": { "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } }, "TIMED_OUT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIMED_OUT" } } } }, "com.amazonaws.imagebuilder#RegionList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#NonEmptyString" } }, "com.amazonaws.imagebuilder#RegisterImageOptions": { "type": "structure", "members": { "secureBootEnabled": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether Secure Boot is enabled for the output AMI. \n\t\t\tThe default value is true. To disable Secure Boot \n\t\t\tfor custom unsigned drivers, set this value to false.

" } }, "uefiData": { "target": "com.amazonaws.imagebuilder#UefiData", "traits": { "smithy.api#documentation": "

A Base64-encoded representation of the non-volatile UEFI variable store. \n\t\t\tYou can specify this parameter only when \n\t\t\tsecureBootEnabled is true or \n\t\t\tunspecified. You can inspect and modify the UEFI data by using \n\t\t\tthe python-uefivars tool on GitHub.

\n

For more information, see UEFI \n\t\t\t\tvariables for Amazon EC2 instances.

" } } }, "traits": { "smithy.api#documentation": "

Controls Secure Boot and UEFI data settings for the resulting image \n\t\t\tduring ISO imports. For more information, see UEFI Secure Boot for Amazon EC2 instances in \n\t\t\tthe \n Amazon EC2 User Guide\n .

" } }, "com.amazonaws.imagebuilder#Remediation": { "type": "structure", "members": { "recommendation": { "target": "com.amazonaws.imagebuilder#RemediationRecommendation", "traits": { "smithy.api#documentation": "

An object that contains information about the recommended course of action to\n\t\t\tremediate the finding.

" } } }, "traits": { "smithy.api#documentation": "

Information about how to remediate a finding.

" } }, "com.amazonaws.imagebuilder#RemediationRecommendation": { "type": "structure", "members": { "text": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The recommended course of action to remediate the finding.

" } }, "url": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

A link to more information about the recommended remediation for this\n\t\t\tvulnerability.

" } } }, "traits": { "smithy.api#documentation": "

Details about the recommended course of action to remediate the finding.

" } }, "com.amazonaws.imagebuilder#ResourceAlreadyExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The resource that you are trying to create already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.imagebuilder#ResourceDependencyException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

You have attempted to mutate or delete a resource with a dependency that prohibits\n\t\t\tthis action. See the error message for more details.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.imagebuilder#ResourceInUseException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The resource that you are trying to operate on is currently in use. Review the message\n\t\t\tdetails and retry later.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.imagebuilder#ResourceName": { "type": "string", "traits": { "smithy.api#pattern": "^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$" } }, "com.amazonaws.imagebuilder#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

At least one of the resources referenced by your request does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.imagebuilder#ResourcePolicyDocument": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 30000 } } }, "com.amazonaws.imagebuilder#ResourceState": { "type": "structure", "members": { "status": { "target": "com.amazonaws.imagebuilder#ResourceStatus", "traits": { "smithy.api#documentation": "

The status to which you want to move the image resource. Set the status to\n\t\t\tAVAILABLE to restore an image that's currently deprecated\n\t\t\tor disabled.

" } } }, "traits": { "smithy.api#documentation": "

The state to apply to the image resource in a resource state update\n\t\t\trequest.

" } }, "com.amazonaws.imagebuilder#ResourceStateUpdateExclusionRules": { "type": "structure", "members": { "amis": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRulesAmis", "traits": { "smithy.api#documentation": "

Defines criteria for AMIs that Image Builder should exclude from the resource\n\t\t\tstate update.

" } } }, "traits": { "smithy.api#documentation": "

Additional rules to specify resources that should be exempt from ad-hoc lifecycle actions.

" } }, "com.amazonaws.imagebuilder#ResourceStateUpdateIncludeResources": { "type": "structure", "members": { "amis": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the lifecycle action should apply to distributed AMIs.

" } }, "snapshots": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.

" } }, "containers": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the lifecycle action should apply to distributed containers.

" } } }, "traits": { "smithy.api#documentation": "

Specifies which underlying resources the resource state update applies to,\n\t\t\tin addition to the Image Builder image resource itself: distributed AMIs and their\n\t\t\tsnapshots for AMI images, or distributed container images for container\n\t\t\timages.

" } }, "com.amazonaws.imagebuilder#ResourceStatus": { "type": "enum", "members": { "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "DEPRECATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPRECATED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.imagebuilder#ResourceTagMap": { "type": "map", "key": { "target": "com.amazonaws.imagebuilder#TagKey" }, "value": { "target": "com.amazonaws.imagebuilder#TagValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 30 } } }, "com.amazonaws.imagebuilder#RestrictedInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.imagebuilder#RetryImage": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#RetryImageRequest" }, "output": { "target": "com.amazonaws.imagebuilder#RetryImageResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Retries a failed or canceled image build without rebuilding the phases\n\t\t\tthat already completed. The image re-runs asynchronously in place: the same\n\t\t\tbuild version returns to the test or distribution phase where it failed and\n\t\t\tcontinues from there. No new image build version is created. Retry is only\n\t\t\tsupported for AMI-based images.

", "smithy.api#examples": [ { "title": "Retry an image build", "documentation": "The following example retries a cancelled image build, which resumes in place from the phase where it stopped.", "input": { "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEfffff" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEfffff", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" } } ], "smithy.api#http": { "method": "PUT", "uri": "/RetryImage", "code": 200 } } }, "com.amazonaws.imagebuilder#RetryImageRequest": { "type": "structure", "members": { "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image build version that you want to retry. The image\n\t\t\tmust be in the FAILED or CANCELLED state.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#RetryImageResponse": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The ARN of the image to be retried.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#RoleNameOrArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^(?:arn:aws(?:-[a-z]+)*:iam::[0-9]{12}:role/)?[a-zA-Z_0-9+=,.@\\-_/]+$" } }, "com.amazonaws.imagebuilder#S3ExportConfiguration": { "type": "structure", "members": { "roleName": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the role that grants VM Import/Export permission to export images to your\n\t\t\tS3 bucket.

", "smithy.api#required": {} } }, "diskImageFormat": { "target": "com.amazonaws.imagebuilder#DiskImageFormat", "traits": { "smithy.api#documentation": "

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

\n ", "smithy.api#required": {} } }, "s3Bucket": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The S3 bucket in which to store the output disk images for your VM.

", "smithy.api#required": {} } }, "s3Prefix": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon S3 path for the bucket where the output disk images for your VM are\n\t\t\tstored.

" } } }, "traits": { "smithy.api#documentation": "

Properties that configure exporting the output image to a disk image file in\n\t\t\tan Amazon S3 bucket, in a format that's compatible with your VMs.

" } }, "com.amazonaws.imagebuilder#S3Logs": { "type": "structure", "members": { "s3BucketName": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of an existing Amazon S3 bucket where Image Builder saves build logs. The bucket\n\t\t\tisn't validated when you create or update the configuration, and Image Builder\n\t\t\tdoesn't create it. The instance profile associated with this\n\t\t\tinfrastructure configuration must have permission to write to the\n\t\t\tbucket.

" } }, "s3KeyPrefix": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon S3 key prefix under which Image Builder writes build and test logs in the\n\t\t\tbucket.

" } } }, "traits": { "smithy.api#documentation": "

Amazon S3 logging configuration.

" } }, "com.amazonaws.imagebuilder#ScanResultCondition": { "type": "structure", "members": { "maximumSeverityLabel": { "target": "com.amazonaws.imagebuilder#MaximumSeverityLabel", "traits": { "smithy.api#documentation": "

The maximum severity allowed for findings on the output AMI.\n\t\t\tA finding above this severity fails the image, unless\n\t\t\tfixAvailable excludes it. Valid values are\n\t\t\tINFORMATIONAL, LOW, MEDIUM,\n\t\t\tand HIGH. A CRITICAL finding that counts\n\t\t\talways fails the image.

", "smithy.api#required": {} } }, "fixAvailable": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether only findings that have a fix available count toward\n\t\t\tmaximumSeverityLabel. When false, Image Builder counts\n\t\t\tevery finding. The default is true.

" } } }, "traits": { "smithy.api#documentation": "

A condition that sets which findings from an on-demand AMI scan fail the\n\t\t\timage. Image Builder checks the output AMI's findings against this condition during\n\t\t\tthe test phase.

" } }, "com.amazonaws.imagebuilder#Schedule": { "type": "structure", "members": { "scheduleExpression": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The expression determines how often EC2 Image Builder evaluates your\n\t\t\t\tpipelineExecutionStartCondition. You can specify a cron\n\t\t\t\texpression, or a rate expression such as rate(1 day).

\n

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

" } }, "timezone": { "target": "com.amazonaws.imagebuilder#Timezone", "traits": { "smithy.api#documentation": "

The timezone that applies to the scheduling expression. Specify a value in\n\t\t\tIANA timezone\n\t\t\t\tformat, for example Etc/UTC or\n\t\t\tAmerica/Los_Angeles. If not specified, this defaults to UTC.

" } }, "pipelineExecutionStartCondition": { "target": "com.amazonaws.imagebuilder#PipelineExecutionStartCondition", "traits": { "smithy.api#documentation": "

The start condition configures when the pipeline should trigger a new image build, \n\t\t\tas follows. If no value is set Image Builder defaults to \n\t\t\tEXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.

\n \n \n

If the recipe references its base image through an Amazon Web Services Systems Manager Parameter\n\t\t\t\tStore parameter, a change in the parameter's value also counts as an\n\t\t\t\tavailable dependency update.

\n
" } }, "autoDisablePolicy": { "target": "com.amazonaws.imagebuilder#AutoDisablePolicy", "traits": { "smithy.api#documentation": "

The policy that configures when Image Builder should automatically disable a pipeline that \n\t\t\tis failing.

" } } }, "traits": { "smithy.api#documentation": "

A schedule configures when and how often a pipeline will automatically create a new\n\t\t\timage.

" } }, "com.amazonaws.imagebuilder#SecurityGroupIds": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#NonEmptyString" } }, "com.amazonaws.imagebuilder#SendWorkflowStepAction": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#SendWorkflowStepActionRequest" }, "output": { "target": "com.amazonaws.imagebuilder#SendWorkflowStepActionResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidParameterValueException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Sends an action to a workflow step that has paused at a\n\t\t\tWaitForAction step, so that image creation can continue.\n\t\t\tTo find the steps that are waiting for an action, call\n\t\t\tListWaitingWorkflowSteps.

", "smithy.api#examples": [ { "title": "Stop a workflow step that is waiting for action", "documentation": "The following example sends the STOP action to a workflow step that has paused the image build, identified by the step execution ID that ListWaitingWorkflowSteps returns.", "input": { "stepExecutionId": "step-8eb24d7a-036e-46b5-94a3-90a5d8b5ac4a", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-wait-recipe/1.0.0/1", "action": "STOP", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE67890" }, "output": { "stepExecutionId": "step-8eb24d7a-036e-46b5-94a3-90a5d8b5ac4a", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-wait-recipe/1.0.0/1", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE67890" } } ], "smithy.api#http": { "method": "PUT", "uri": "/SendWorkflowStepAction", "code": 200 } } }, "com.amazonaws.imagebuilder#SendWorkflowStepActionRequest": { "type": "structure", "members": { "stepExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionId", "traits": { "smithy.api#documentation": "

Uniquely identifies the waiting workflow step that you send the action to.\n\t\t\tTo get this identifier, call ListWaitingWorkflowSteps.

", "smithy.api#required": {} } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image build version associated with the workflow\n\t\t\tstep execution. This value must match the image that owns the waiting step.\n\t\t\tIf the ARN does not correspond to the image running the workflow,\n\t\t\tthen the request fails with a validation error.

", "smithy.api#required": {} } }, "action": { "target": "com.amazonaws.imagebuilder#WorkflowStepActionType", "traits": { "smithy.api#documentation": "

The action to perform on the paused workflow step.\n\t\t\tRESUME completes the waiting step, and the workflow continues.\n\t\t\tSTOP fails the step, and the step's onFailure\n\t\t\tsetting determines whether the workflow continues or aborts. The workflow\n\t\t\tstep must be in a waiting state to accept an action. The request fails if\n\t\t\tthe step has already timed out or been actioned.

", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The reason for the action. This value is stored with the step\n\t\t\texecution record and is accessible in subsequent workflow steps\n\t\t\tvia step output references.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#SendWorkflowStepActionResponse": { "type": "structure", "members": { "stepExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionId", "traits": { "smithy.api#documentation": "

The unique identifier for the workflow step that received the action, as\n\t\t\tspecified in the request.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image build version that received the action \n\t\t\trequest.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#ServiceException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

An internal server error occurred while Image Builder processed the request.\n\t\t\tRetrying the request may succeed.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.imagebuilder#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

You have exceeded the number of permitted resources or operations for this service.\n\t\t\tFor service quotas, see EC2 Image Builder endpoints and\n\t\t\t\tquotas.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.imagebuilder#ServiceUnavailableException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The service is unable to process your request at this time.

", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.imagebuilder#SeverityCountNumber": { "type": "long" }, "com.amazonaws.imagebuilder#SeverityCounts": { "type": "structure", "members": { "all": { "target": "com.amazonaws.imagebuilder#SeverityCountNumber", "traits": { "smithy.api#documentation": "

The total number of findings across all severity levels for the specified filter.

" } }, "critical": { "target": "com.amazonaws.imagebuilder#SeverityCountNumber", "traits": { "smithy.api#documentation": "

The number of critical severity findings for the specified filter.

" } }, "high": { "target": "com.amazonaws.imagebuilder#SeverityCountNumber", "traits": { "smithy.api#documentation": "

The number of high severity findings for the specified filter.

" } }, "medium": { "target": "com.amazonaws.imagebuilder#SeverityCountNumber", "traits": { "smithy.api#documentation": "

The number of medium severity findings for the specified filter.

" } } }, "traits": { "smithy.api#documentation": "

Includes counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings for the specified filter.

" } }, "com.amazonaws.imagebuilder#SnsTopicArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:]*:sns:[^:]+:[0-9]{12}:[a-zA-Z0-9-_]{1,256}$" } }, "com.amazonaws.imagebuilder#SourceLayerHash": { "type": "string" }, "com.amazonaws.imagebuilder#SsmParameterConfiguration": { "type": "structure", "members": { "amiAccountId": { "target": "com.amazonaws.imagebuilder#AccountId", "traits": { "smithy.api#documentation": "

Specify the account that will own the Parameter in a given Region. During distribution, \n\t\t\tthis account must be specified in distribution settings as a target account for the \n\t\t\tRegion.

" } }, "parameterName": { "target": "com.amazonaws.imagebuilder#SsmParameterName", "traits": { "smithy.api#documentation": "

This is the name of the Parameter in the target Region or account. The image \n\t\t\tdistribution creates the Parameter if it doesn't already exist. Otherwise, it updates \n\t\t\tthe parameter.

", "smithy.api#required": {} } }, "dataType": { "target": "com.amazonaws.imagebuilder#SsmParameterDataType", "traits": { "smithy.api#documentation": "

The type of value the parameter contains.\n\t\tWe recommend the aws:ec2:image data type.

" } } }, "traits": { "smithy.api#documentation": "

Configuration for a single Parameter in the Amazon Web Services Systems Manager (SSM) Parameter Store in \n\t\t\ta given Region.

" } }, "com.amazonaws.imagebuilder#SsmParameterConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#SsmParameterConfiguration" } }, "com.amazonaws.imagebuilder#SsmParameterDataType": { "type": "enum", "members": { "TEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "text" } }, "AWS_EC2_IMAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "aws:ec2:image" } } } }, "com.amazonaws.imagebuilder#SsmParameterName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 }, "smithy.api#pattern": "^[a-zA-Z0-9_.\\-\\/]+$" } }, "com.amazonaws.imagebuilder#StartImagePipelineExecution": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#StartImagePipelineExecutionRequest" }, "output": { "target": "com.amazonaws.imagebuilder#StartImagePipelineExecutionResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Manually triggers a pipeline to create an image. You can start a build\n\t\t\tthis way whether the pipeline is enabled or disabled. The response returns\n\t\t\tas soon as Image Builder creates the new image resource and queues the build. Use\n\t\t\tthe returned imageBuildVersionArn with\n\t\t\tGetImage to track build progress.

", "smithy.api#examples": [ { "title": "Start a pipeline build manually", "documentation": "The following example starts a build for the specified pipeline. The response returns the ARN of the new image build version.", "input": { "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE66666" }, "output": { "requestId": "f477f64c-9ece-4478-977d-5821f8ed051b", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE66666", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" } } ], "smithy.api#http": { "method": "PUT", "uri": "/StartImagePipelineExecution", "code": 200 } } }, "com.amazonaws.imagebuilder#StartImagePipelineExecutionRequest": { "type": "structure", "members": { "imagePipelineArn": { "target": "com.amazonaws.imagebuilder#ImagePipelineArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that you want to manually\n\t\t\tinvoke.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags for Image Builder to apply to the image resource that's created \n\t\t\twhen pipeline execution starts.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#StartImagePipelineExecutionResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that the request created.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#StartResourceStateUpdate": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#StartResourceStateUpdateRequest" }, "output": { "target": "com.amazonaws.imagebuilder#StartResourceStateUpdateResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Begins an ad-hoc state change for the specified image build version.\n\t\t\tThis is a one-time operation - if you schedule the update, it runs only\n\t\t\tonce. If the\n\t\t\trequest includes underlying resources, or schedules the update far enough in\n\t\t\tthe future, Image Builder runs the update as an asynchronous lifecycle execution and\n\t\t\treturns its identifier. Otherwise, for target states other than\n\t\t\tDELETED, the state change applies immediately. If a request\n\t\t\tthat starts a lifecycle execution arrives while the image already has one in\n\t\t\tprogress, Image Builder rejects it.

", "smithy.api#examples": [ { "title": "Schedule an image build version for deprecation", "documentation": "The following example schedules the specified image build version and its AMI to move to the DEPRECATED state at the requested future time. It returns the ID of the lifecycle execution that applies the update.", "input": { "resourceArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "state": { "status": "DEPRECATED" }, "executionRole": "arn:aws:iam::111122223333:role/my-example-state-update-role", "includeResources": { "amis": true }, "updateAt": "2026-09-11T21:20:00Z", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE24680" }, "output": { "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503", "resourceArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" } } ], "smithy.api#http": { "method": "PUT", "uri": "/StartResourceStateUpdate", "code": 200 } } }, "com.amazonaws.imagebuilder#StartResourceStateUpdateRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image build version to update. The\n\t\t\timage must be in one of these terminal states: AVAILABLE,\n\t\t\tDEPRECATED, DISABLED,\n\t\t\tFAILED, or CANCELLED. Images with\n\t\t\tFAILED or CANCELLED status can transition only\n\t\t\tto DELETED.

", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.imagebuilder#ResourceState", "traits": { "smithy.api#documentation": "

Specifies the lifecycle action to take for this request. For AMI-based\n\t\t\timages, valid values are AVAILABLE,\n\t\t\tDEPRECATED, DISABLED, and\n\t\t\tDELETED. For container-based images, only\n\t\t\tDELETED is supported.

", "smithy.api#required": {} } }, "executionRole": { "target": "com.amazonaws.imagebuilder#RoleNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role that's used to update image state. You\n\t\t\tmust provide this property together with includeResources.\n\t\t\tNeither is valid without the other.

" } }, "includeResources": { "target": "com.amazonaws.imagebuilder#ResourceStateUpdateIncludeResources", "traits": { "smithy.api#documentation": "

Specifies which underlying resources to update, in addition to the Image Builder\n\t\t\timage resource itself. Snapshots and containers are only valid for the\n\t\t\tDELETED state. To set an image to DELETED, you\n\t\t\tmust include its underlying resources. To delete only the Image Builder image\n\t\t\trecord, use the DeleteImage operation instead.

" } }, "exclusionRules": { "target": "com.amazonaws.imagebuilder#ResourceStateUpdateExclusionRules", "traits": { "smithy.api#documentation": "

Rules that Image Builder evaluates against each of the image's AMIs. Matching\n\t\t\tAMIs and their snapshots are skipped. Exclusion rules only take effect when\n\t\t\tthe request includes AMIs. If the target state is DELETED and\n\t\t\tany resource was skipped, the Image Builder image resource itself is also retained.\n\t\t\tFor the DEPRECATED and DISABLED target states,\n\t\t\tImage Builder updates the image resource's state regardless of\n\t\t\texclusions.

" } }, "updateAt": { "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", "traits": { "smithy.api#documentation": "

The timestamp that indicates when resources are updated by a lifecycle\n\t\t\taction. This property is valid only when the target status is\n\t\t\tDEPRECATED, and the value must be a future time. If you\n\t\t\tdon't specify a value, Image Builder begins the state update right away. For a\n\t\t\tscheduled deprecation, included AMIs get their EC2 deprecation time set\n\t\t\timmediately, and Image Builder schedules the image resource to transition to\n\t\t\tDEPRECATED at that time.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#StartResourceStateUpdateResponse": { "type": "structure", "members": { "lifecycleExecutionId": { "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", "traits": { "smithy.api#documentation": "

Identifies the lifecycle execution that performs the resource state update.\n\t\t\tImage Builder only returns this field when it started a lifecycle execution for the\n\t\t\tupdate. Use it with GetLifecycleExecution to track\n\t\t\tprogress.

" } }, "resourceArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The requested Amazon Resource Name (ARN) of the Image Builder resource for the asynchronous update.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#StringList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#NonEmptyString" } }, "com.amazonaws.imagebuilder#SystemsManagerAgent": { "type": "structure", "members": { "uninstallAfterBuild": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether the Systems Manager agent is removed from your final build image\n\t\t\tbefore Image Builder creates the new AMI. If true, the agent is\n\t\t\tremoved. If false, the agent is kept, so that it's\n\t\t\tincluded in the AMI. If you don't set this property, Image Builder removes the\n\t\t\tagent only if Image Builder installed the agent during the build. An agent that was\n\t\t\tpre-installed on the base image is kept.

" } } }, "traits": { "smithy.api#documentation": "

Contains settings for the Systems Manager agent on your build instance. This setting\n\t\t\tapplies to Linux and macOS build instances only. Requests that set it for a\n\t\t\trecipe with a Windows base image are rejected.

" } }, "com.amazonaws.imagebuilder#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(?!aws:)[a-zA-Z0-9\\s_.:/=+\\-@]*$" } }, "com.amazonaws.imagebuilder#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.imagebuilder#TagMap": { "type": "map", "key": { "target": "com.amazonaws.imagebuilder#TagKey" }, "value": { "target": "com.amazonaws.imagebuilder#TagValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.imagebuilder#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#TagResourceRequest" }, "output": { "target": "com.amazonaws.imagebuilder#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#InvalidParameterException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" } ], "traits": { "smithy.api#documentation": "

Adds a tag to a resource.

", "smithy.api#examples": [ { "title": "Add tags to a component build version", "documentation": "The following example adds two tags to a component build version.", "input": { "resourceArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-tagged-component/1.0.0/1", "tags": { "Environment": "Production", "CostCenter": "12345" } }, "output": {} } ], "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.imagebuilder#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to tag.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags to apply to the resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.imagebuilder#TargetContainerRepository": { "type": "structure", "members": { "service": { "target": "com.amazonaws.imagebuilder#ContainerRepositoryService", "traits": { "smithy.api#documentation": "

Specifies the service in which this image was registered.

", "smithy.api#required": {} } }, "repositoryName": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the container repository where the output container image is\n\t\t\tstored. Provide the repository name only (a namespace path such as\n\t\t\tteam-a/my-repo is allowed, but not the registry\n\t\t\thostname).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The container repository where the output container image is stored.

" } }, "com.amazonaws.imagebuilder#TargetResourceCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 10000 } } }, "com.amazonaws.imagebuilder#TenancyType": { "type": "enum", "members": { "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "default" } }, "DEDICATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "dedicated" } }, "HOST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "host" } } } }, "com.amazonaws.imagebuilder#Timezone": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 100 }, "smithy.api#pattern": "^[a-zA-Z0-9]{2,}(?:\\/[a-zA-Z0-9-_+]+)*$" } }, "com.amazonaws.imagebuilder#TooManyRequestsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.imagebuilder#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

You have attempted too many requests for the specific operation.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.imagebuilder#UefiData": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 64000 } } }, "com.amazonaws.imagebuilder#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#UntagResourceRequest" }, "output": { "target": "com.amazonaws.imagebuilder#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#InvalidParameterException" }, { "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" } ], "traits": { "smithy.api#documentation": "

Removes a tag from a resource.

", "smithy.api#examples": [ { "title": "Remove a tag from a resource", "documentation": "The following example removes the CostCenter tag key from the specified component build version.", "input": { "resourceArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-tagged-component/1.0.0/1", "tagKeys": [ "CostCenter" ] }, "output": {} } ], "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.imagebuilder#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to untag.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.imagebuilder#TagKeyList", "traits": { "smithy.api#documentation": "

The tag keys to remove from the resource.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#UpdateDistributionConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#UpdateDistributionConfigurationRequest" }, "output": { "target": "com.amazonaws.imagebuilder#UpdateDistributionConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Updates a distribution configuration. Distribution configurations define and\n\t\t\tconfigure the outputs for your images, including the target Regions,\n\t\t\taccounts, and settings for each Region.

\n \n

This operation doesn't support selective updates. The request\n\t\t\t\treplaces the entire distribution configuration, so include every setting\n\t\t\t\tthat you want to keep. Any optional property that you omit is removed\n\t\t\t\tor reset to its default.

\n
", "smithy.api#examples": [ { "title": "Update a distribution configuration", "documentation": "The following example replaces the distribution settings for the specified configuration with a single distribution that names the output AMI with the build date.", "input": { "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution", "distributions": [ { "region": "us-west-2", "amiDistributionConfiguration": { "name": "my-example-image-{{ imagebuilder:buildDate }}" } } ], "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEccccc" }, "output": { "requestId": "97d5c3e8-93d6-424c-90e0-bab18b20bf54", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution" } } ], "smithy.api#http": { "method": "PUT", "uri": "/UpdateDistributionConfiguration", "code": 200 } } }, "com.amazonaws.imagebuilder#UpdateDistributionConfigurationRequest": { "type": "structure", "members": { "distributionConfigurationArn": { "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that you want to\n\t\t\tupdate.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the distribution configuration.

" } }, "distributions": { "target": "com.amazonaws.imagebuilder#DistributionList", "traits": { "smithy.api#documentation": "

The distribution settings for the configuration. Each entry defines how\n\t\t\toutput images are distributed in one target Amazon Web Services Region. A Region can\n\t\t\tappear at most once in the list. This list replaces the configuration's existing\n\t\t\tdistributions entirely.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#UpdateDistributionConfigurationResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "distributionConfigurationArn": { "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that was updated by\n\t\t\tthis request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#UpdateImagePipeline": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#UpdateImagePipelineRequest" }, "output": { "target": "com.amazonaws.imagebuilder#UpdateImagePipelineResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Updates an image pipeline. Use image pipelines to automate the creation and\n\t\t\tdistribution of images. You must specify exactly one recipe for your image, using either\n\t\t\ta containerRecipeArn or an imageRecipeArn. The\n\t\t\trecipe must be the same type, image or container, as the pipeline's current\n\t\t\trecipe.

\n \n

This operation doesn't support selective updates. The request\n\t\t\t\treplaces the entire pipeline configuration, so include every setting\n\t\t\t\tthat you want to keep. Any optional property that you omit is removed\n\t\t\t\tor reset to its default.

\n
", "smithy.api#examples": [ { "title": "Update an image pipeline", "documentation": "The following example changes the pipeline's schedule to build every day at 6:00 AM UTC.", "input": { "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "schedule": { "scheduleExpression": "cron(0 6 * * ? *)", "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" }, "status": "ENABLED", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEddddd" }, "output": { "requestId": "7a414b2d-e462-4850-ae7a-fe25a1223e0f", "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline" } } ], "smithy.api#http": { "method": "PUT", "uri": "/UpdateImagePipeline", "code": 200 } } }, "com.amazonaws.imagebuilder#UpdateImagePipelineRequest": { "type": "structure", "members": { "imagePipelineArn": { "target": "com.amazonaws.imagebuilder#ImagePipelineArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the image pipeline.

" } }, "imageRecipeArn": { "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that configures\n\t\t\timages created by this image pipeline. You must specify either this property\n\t\t\tor containerRecipeArn, but not both.

" } }, "containerRecipeArn": { "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that is used to configure images\n\t\t\tcreated by this container pipeline. You must specify either this property or\n\t\t\timageRecipeArn, but not both.

" } }, "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to\n\t\t\tbuild images created by this image pipeline.

", "smithy.api#required": {} } }, "distributionConfigurationArn": { "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to\n\t\t\tconfigure and distribute images created by this image pipeline.

" } }, "imageTestsConfiguration": { "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", "traits": { "smithy.api#documentation": "

Specifies the test settings that Image Builder applies to images that this\n\t\t\tpipeline creates. If you don't provide test settings, Image Builder stores a default\n\t\t\tconfiguration with image tests enabled.

" } }, "enhancedImageMetadataEnabled": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether to collect additional information about the image being created, including the operating\n\t\t\tsystem (OS) version and package list. Defaults to true.

" } }, "schedule": { "target": "com.amazonaws.imagebuilder#Schedule", "traits": { "smithy.api#documentation": "

The schedule of the image pipeline. Because the update replaces the entire\n\t\t\tconfiguration, omitting this property removes any existing schedule. The\n\t\t\tpipeline then runs only when you call\n\t\t\tStartImagePipelineExecution.

" } }, "status": { "target": "com.amazonaws.imagebuilder#PipelineStatus", "traits": { "smithy.api#documentation": "

The status of the image pipeline. Defaults to ENABLED when\n\t\t\tomitted. To keep a pipeline disabled, include this property set to\n\t\t\tDISABLED in your update request.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "imageScanningConfiguration": { "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", "traits": { "smithy.api#documentation": "

The updated settings that determine whether and how Amazon Inspector scans the\n\t\t\timages that this pipeline creates.

" } }, "workflows": { "target": "com.amazonaws.imagebuilder#WorkflowConfigurationList", "traits": { "smithy.api#documentation": "

The array of workflow configuration objects for builds that this pipeline\n\t\t\tstarts. If you specify workflows, they replace the default workflows that\n\t\t\tImage Builder otherwise runs for the pipeline's builds. For example, if your\n\t\t\tlist doesn't include a test workflow, the pipeline's builds\n\t\t\tdon't run one. You must also specify executionRole when\n\t\t\tyou provide workflows.

" } }, "loggingConfiguration": { "target": "com.amazonaws.imagebuilder#PipelineLoggingConfiguration", "traits": { "smithy.api#documentation": "

Specifies the logging configuration for the image pipeline. Use this\n\t\t\tto define custom CloudWatch Logs log groups for your pipeline execution\n\t\t\tlogs and image build logs. The service manages log groups with names\n\t\t\tstarting with /aws/imagebuilder/ using the service-linked\n\t\t\trole. For custom log group names outside of this prefix, you must also\n\t\t\tprovide an executionRole.

" } }, "executionRole": { "target": "com.amazonaws.imagebuilder#RoleNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) for the IAM role you create that grants\n\t\t\tImage Builder access to perform workflow actions. If you omit this property, the\n\t\t\tpipeline reverts to the Image Builder service-linked role.

" } }, "imageTags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags that Image Builder applies to the Image Builder image resource that this\n\t\t\tpipeline's scheduled executions create. These tags don't apply to the\n\t\t\toutput AMI. To tag output AMIs, use amiTags in the\n\t\t\tpipeline's distribution configuration.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#UpdateImagePipelineResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "imagePipelineArn": { "target": "com.amazonaws.imagebuilder#ImagePipelineArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that was updated by this\n\t\t\trequest.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#UpdateInfrastructureConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#UpdateInfrastructureConfigurationRequest" }, "output": { "target": "com.amazonaws.imagebuilder#UpdateInfrastructureConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Updates an infrastructure configuration. An infrastructure configuration defines\n\t\t\tthe environment in which Image Builder builds and tests your image.

\n \n

This operation doesn't support selective updates. The request\n\t\t\t\treplaces the entire infrastructure configuration, so include every\n\t\t\t\tsetting that you want to keep. Any optional property that you omit is\n\t\t\t\tremoved or reset to its default.

\n
", "smithy.api#examples": [ { "title": "Update an infrastructure configuration", "documentation": "The following example updates an infrastructure configuration to use larger instance types and to keep the build instance running when the image build fails.", "input": { "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "description": "An infrastructure configuration for Amazon Linux builds", "instanceProfileName": "EC2InstanceProfileForImageBuilder", "instanceTypes": [ "t3.large", "t3.xlarge" ], "terminateInstanceOnFailure": false, "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb" }, "output": { "requestId": "ffe990d5-7720-4061-a8d6-da6a7c4a6a3e", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure" } } ], "smithy.api#http": { "method": "PUT", "uri": "/UpdateInfrastructureConfiguration", "code": 200 } } }, "com.amazonaws.imagebuilder#UpdateInfrastructureConfigurationRequest": { "type": "structure", "members": { "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to\n\t\t\tupdate.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the infrastructure configuration.

" } }, "instanceTypes": { "target": "com.amazonaws.imagebuilder#InstanceTypeList", "traits": { "smithy.api#documentation": "

The instance types of the infrastructure configuration. You can specify one or more\n\t\t\tinstance types to use for this build. Image Builder picks one of these instance types\n\t\t\tbased on availability. If you don't specify instance types, Image Builder selects\n\t\t\tcompatible instance types automatically. If you specify a Dedicated Host,\n\t\t\tImage Builder uses only instance types that the host supports.

" } }, "instanceProfileName": { "target": "com.amazonaws.imagebuilder#InstanceProfileNameType", "traits": { "smithy.api#documentation": "

The instance profile to associate with the instance used to customize your Amazon EC2\n\t\t\tAMI. The instance profile must exist in your account.

", "smithy.api#required": {} } }, "securityGroupIds": { "target": "com.amazonaws.imagebuilder#SecurityGroupIds", "traits": { "smithy.api#documentation": "

The security group IDs to associate with the instance used to customize your Amazon EC2\n\t\t\tAMI.

" } }, "subnetId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The subnet ID in which to place the instance used to customize your Amazon EC2\n\t\t\tAMI. If you specify subnetId, you must also specify one or\n\t\t\tmore security group IDs in securityGroupIds. Otherwise, the\n\t\t\trequest fails.

" } }, "logging": { "target": "com.amazonaws.imagebuilder#Logging", "traits": { "smithy.api#documentation": "

The logging configuration of the infrastructure configuration. When you\n\t\t\tconfigure S3 logs, Image Builder writes logs from the build and test process to the\n\t\t\tspecified bucket under the key prefix.

" } }, "keyPair": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The key pair of the infrastructure configuration. You can use this to log on to and\n\t\t\tdebug the instance used to create your image.

" } }, "terminateInstanceOnFailure": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether to terminate the instance on failure. Set to\n\t\t\tfalse if you want Image Builder to retain the instance used to configure your AMI if the build or\n\t\t\ttest phase of your workflow fails. Defaults to true.

" } }, "terminateInstanceOnCompletion": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Specifies whether Image Builder terminates build and test instances when image creation\n\t\t\tends without a failure (success, cancellation, or expiration). Defaults to\n\t\t\ttrue.

" } }, "snsTopicArn": { "target": "com.amazonaws.imagebuilder#SnsTopicArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic to which Image Builder\n\t\t\tsends image build event notifications. Specify a standard topic. Image Builder doesn't support FIFO\n\t\t\ttopics. Image Builder validates the topic when you create or update the configuration.\n\t\t\tYou must have permission to publish to the topic.

\n \n

EC2 Image Builder can't send notifications to SNS topics that are encrypted using keys\n\t\t\t\tfrom other accounts. If your SNS topic is encrypted, the key must be owned by the\n\t\t\t\tsame account that owns your Image Builder resources.

\n
" } }, "resourceTags": { "target": "com.amazonaws.imagebuilder#ResourceTagMap", "traits": { "smithy.api#documentation": "

The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during\n\t\t\tthe build process. Tags are formatted as key value pairs. Tag keys can't\n\t\t\tbegin with aws: or match one of the following reserved keys:\n\t\t\tCreatedBy, Ec2ImageBuilderArn, Name,\n\t\t\tor Tags.

" } }, "instanceMetadataOptions": { "target": "com.amazonaws.imagebuilder#InstanceMetadataOptions", "traits": { "smithy.api#documentation": "

The instance metadata service (IMDS) settings that Image Builder applies to the EC2\n\t\t\tbuild and test instances it launches during image creation. If you don't\n\t\t\tset these options, the EC2 launch defaults for the instance apply. For more\n\t\t\tinformation about instance metadata options, see one of the following\n\t\t\tlinks:

\n " } }, "placement": { "target": "com.amazonaws.imagebuilder#Placement", "traits": { "smithy.api#documentation": "

The instance placement settings that define where the build and test\n\t\t\tinstances that Image Builder launches during image creation run. These settings\n\t\t\tdon't affect instances that you launch from the output image.

" } }, "parentInstance": { "target": "com.amazonaws.imagebuilder#ParentInstanceConfiguration", "traits": { "smithy.api#documentation": "

The Amazon EC2 Auto Scaling group that Image Builder takes the build instance from, instead of\n\t\t\tlaunching a new instance. This applies only to the build phase.

\n

To use this feature, the execution role for the build must have permissions to\n\t\t\tdescribe the Auto Scaling group, tag the instance while it's still in the group, and\n\t\t\tdetach it from the group. For more information, see Build on an\n\t\t\t\tinstance from an Auto Scaling group in the EC2 Image Builder User\n\t\t\t\tGuide.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#UpdateInfrastructureConfigurationResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

The client token that uniquely identifies the request.

" } }, "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by\n\t\t\tthis request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#UpdateLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.imagebuilder#UpdateLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.imagebuilder#UpdateLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" }, { "target": "com.amazonaws.imagebuilder#ClientException" }, { "target": "com.amazonaws.imagebuilder#ForbiddenException" }, { "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" }, { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, { "target": "com.amazonaws.imagebuilder#ResourceInUseException" }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, { "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Updates the specified lifecycle policy. The resourceType must\n\t\t\tmatch the existing policy's value.

\n \n

This operation doesn't support selective updates. The request\n\t\t\t\treplaces the entire lifecycle policy configuration, so include every\n\t\t\t\tsetting that you want to keep. Any optional property that you omit is\n\t\t\t\tremoved or reset to its default.

\n
", "smithy.api#examples": [ { "title": "Update a lifecycle policy", "documentation": "The following example updates a lifecycle policy to delete AMI images and their associated snapshots after 12 months, retaining the 3 most recent images.", "input": { "lifecyclePolicyArn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-policy", "description": "Deletes AMI images and their snapshots after 12 months, retaining the 3 most recent", "status": "ENABLED", "executionRole": "arn:aws:iam::111122223333:role/my-example-lifecycle-role", "resourceType": "AMI_IMAGE", "policyDetails": [ { "action": { "type": "DELETE", "includeResources": { "amis": true, "snapshots": true } }, "filter": { "type": "AGE", "value": 12, "unit": "MONTHS", "retainAtLeast": 3 } } ], "resourceSelection": { "tagMap": { "environment": "production" } }, "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa" }, "output": { "lifecyclePolicyArn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-policy" } } ], "smithy.api#http": { "method": "PUT", "uri": "/UpdateLifecyclePolicy", "code": 200 } } }, "com.amazonaws.imagebuilder#UpdateLifecyclePolicyRequest": { "type": "structure", "members": { "lifecyclePolicyArn": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lifecycle policy resource.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Optional description for the lifecycle policy. Because the update replaces the\n\t\t\tentire configuration, omitting this property removes any existing\n\t\t\tdescription.

" } }, "status": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyStatus", "traits": { "smithy.api#documentation": "

Indicates whether the lifecycle policy resource is enabled. Defaults to\n\t\t\tENABLED when omitted, so updating a disabled policy without\n\t\t\tsetting this property re-enables it.

" } }, "executionRole": { "target": "com.amazonaws.imagebuilder#RoleNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access\n\t\t\tto run lifecycle actions.

", "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceType", "traits": { "smithy.api#documentation": "

The type of image resource that the lifecycle policy applies to. The value\n\t\t\tmust match the policy's existing resource type. You can't change the\n\t\t\tresource type of an existing lifecycle policy.

", "smithy.api#required": {} } }, "policyDetails": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetails", "traits": { "smithy.api#documentation": "

The configuration details for a lifecycle policy resource.

", "smithy.api#required": {} } }, "resourceSelection": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelection", "traits": { "smithy.api#documentation": "

Selection criteria for resources that the lifecycle policy applies to. You\n\t\t\tmust specify exactly one selection criteria: either recipes or a tag map,\n\t\t\tnot both.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure\n that the operation runs no more than one time. If you retry a request with the same client\n\t token, Image Builder returns the original response without running the operation again. For more\n\t information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.imagebuilder#UpdateLifecyclePolicyResponse": { "type": "structure", "members": { "lifecyclePolicyArn": { "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image lifecycle policy resource that was updated.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.imagebuilder#Uri": { "type": "string" }, "com.amazonaws.imagebuilder#UserDataOverride": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 21847 }, "smithy.api#pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" } }, "com.amazonaws.imagebuilder#VersionNumber": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$" } }, "com.amazonaws.imagebuilder#VersionNumberWithBuild": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 64 }, "smithy.api#pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+(?:/[0-9]+)?$" } }, "com.amazonaws.imagebuilder#VulnerabilityId": { "type": "string" }, "com.amazonaws.imagebuilder#VulnerabilityIdAggregation": { "type": "structure", "members": { "vulnerabilityId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The vulnerability Id for this set of counts.

" } }, "severityCounts": { "target": "com.amazonaws.imagebuilder#SeverityCounts", "traits": { "smithy.api#documentation": "

Counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings for the specified vulnerability.

" } } }, "traits": { "smithy.api#documentation": "

Includes counts of image and pipeline resource findings by vulnerability.

" } }, "com.amazonaws.imagebuilder#VulnerabilityIdList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#VulnerabilityId" } }, "com.amazonaws.imagebuilder#VulnerablePackage": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the vulnerable package.

" } }, "version": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The version of the vulnerable package.

" } }, "sourceLayerHash": { "target": "com.amazonaws.imagebuilder#SourceLayerHash", "traits": { "smithy.api#documentation": "

The source layer hash of the vulnerable package.

" } }, "epoch": { "target": "com.amazonaws.imagebuilder#PackageEpoch", "traits": { "smithy.api#documentation": "

The epoch of the vulnerable package.

" } }, "release": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The release of the vulnerable package.

" } }, "arch": { "target": "com.amazonaws.imagebuilder#PackageArchitecture", "traits": { "smithy.api#documentation": "

The architecture of the vulnerable package.

" } }, "packageManager": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The package manager of the vulnerable package.

" } }, "filePath": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The file path of the vulnerable package.

" } }, "fixedInVersion": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The version of the package that contains the vulnerability fix.

" } }, "remediation": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The code to run in your environment to update packages with a fix available.

" } } }, "traits": { "smithy.api#documentation": "

Information about a vulnerable package that Amazon Inspector identifies in a finding.

" } }, "com.amazonaws.imagebuilder#VulnerablePackageList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#VulnerablePackage" } }, "com.amazonaws.imagebuilder#WildcardVersionNumber": { "type": "string", "traits": { "smithy.api#pattern": "^(?:[0-9]+|x)\\.(?:[0-9]+|x)\\.(?:[0-9]+|x)$" } }, "com.amazonaws.imagebuilder#WindowsConfiguration": { "type": "structure", "members": { "imageIndex": { "target": "com.amazonaws.imagebuilder#WindowsConfigurationImageIndex", "traits": { "smithy.api#documentation": "

The 1-based index that specifies which Windows edition to install \n\t\t\tfrom a multi-edition Windows ISO file. A Windows ISO can contain a \n\t\t\t.wim file with multiple image indexes, each representing \n\t\t\ta different edition.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Windows-specific configuration settings for an ISO import, including \n\t\t\tthe edition to install from a multi-edition Windows ISO file.

" } }, "com.amazonaws.imagebuilder#WindowsConfigurationImageIndex": { "type": "long", "traits": { "smithy.api#range": { "min": 1, "max": 4294967295 } } }, "com.amazonaws.imagebuilder#Workflow": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the workflow resource.

" } }, "version": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { "smithy.api#documentation": "

The workflow resource version. Workflow resources are immutable. \n\t\t\tTo make a change, you can clone a workflow or create a new version.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the workflow.

" } }, "changeDescription": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Describes what change has been made in this version of the workflow, or \n\t\t\twhat makes this version different from other versions of the workflow.

" } }, "type": { "target": "com.amazonaws.imagebuilder#WorkflowType", "traits": { "smithy.api#documentation": "

The image creation stage that the workflow applies to.

" } }, "state": { "target": "com.amazonaws.imagebuilder#WorkflowState", "traits": { "smithy.api#documentation": "

Describes the current status of the workflow and the reason for \n\t\t\tthat status.

" } }, "owner": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The owner of the workflow resource.

" } }, "data": { "target": "com.amazonaws.imagebuilder#WorkflowData", "traits": { "smithy.api#documentation": "

Contains the YAML document content for the workflow.

" } }, "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The KMS key identifier used to encrypt the workflow resource. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when Image Builder created the workflow resource.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags that apply to the workflow resource.

" } }, "parameters": { "target": "com.amazonaws.imagebuilder#WorkflowParameterDetailList", "traits": { "smithy.api#documentation": "

An array of input parameters that the image workflow uses\n\t\t\tto control actions or configure settings.

" } } }, "traits": { "smithy.api#documentation": "

Defines a process that Image Builder runs during the build, test, or distribution\n\t\t\tstage of the image creation process.

" } }, "com.amazonaws.imagebuilder#WorkflowBuildVersionArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" } }, "com.amazonaws.imagebuilder#WorkflowConfiguration": { "type": "structure", "members": { "workflowArn": { "target": "com.amazonaws.imagebuilder#WorkflowVersionArnOrBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource.

", "smithy.api#required": {} } }, "parameters": { "target": "com.amazonaws.imagebuilder#WorkflowParameterList", "traits": { "smithy.api#documentation": "

Contains parameter values for each of the parameters that the workflow \n\t\t\tdocument defined for the workflow resource.

" } }, "parallelGroup": { "target": "com.amazonaws.imagebuilder#ParallelGroup", "traits": { "smithy.api#documentation": "

Test workflows are defined within named runtime groups called parallel groups. \n\t\t\tThe parallel group is the named group that contains this test workflow. Test \n\t\t\tworkflows within a parallel group can run at the same time. Image Builder starts up to five \n\t\t\ttest workflows in the group at the same time, and starts additional workflows as \n\t\t\tothers complete, until all workflows in the group have completed. This field only \n\t\t\tapplies for test workflows.

" } }, "onFailure": { "target": "com.amazonaws.imagebuilder#OnWorkflowFailure", "traits": { "smithy.api#documentation": "

The action to take if the workflow fails. With CONTINUE, a\n\t\t\tfailed workflow is logged and image creation proceeds to the next workflow.\n\t\t\tIf you don't set a value, the image build fails when the workflow fails.\n\t\t\tYou can only set this property for test workflows.

" } } }, "traits": { "smithy.api#documentation": "

Contains control settings and configurable inputs for a workflow \n\t\t\tresource.

" } }, "com.amazonaws.imagebuilder#WorkflowConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#WorkflowConfiguration" } }, "com.amazonaws.imagebuilder#WorkflowData": { "type": "string" }, "com.amazonaws.imagebuilder#WorkflowExecutionId": { "type": "string", "traits": { "smithy.api#pattern": "^wf-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } }, "com.amazonaws.imagebuilder#WorkflowExecutionMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 500 } } }, "com.amazonaws.imagebuilder#WorkflowExecutionMetadata": { "type": "structure", "members": { "workflowBuildVersionArn": { "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource build version that ran.

" } }, "workflowExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", "traits": { "smithy.api#documentation": "

Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a\n\t\t\tworkflow.

" } }, "type": { "target": "com.amazonaws.imagebuilder#WorkflowType", "traits": { "smithy.api#documentation": "

Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

" } }, "status": { "target": "com.amazonaws.imagebuilder#WorkflowExecutionStatus", "traits": { "smithy.api#documentation": "

The current runtime status for this workflow.

" } }, "message": { "target": "com.amazonaws.imagebuilder#WorkflowExecutionMessage", "traits": { "smithy.api#documentation": "

The runtime output message from the workflow, if applicable.

" } }, "totalStepCount": { "target": "com.amazonaws.imagebuilder#WorkflowStepCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The total number of steps that the workflow document defines for this runtime\n\t\t\tinstance of the workflow. Image Builder sets this count before any steps run. The sum of\n\t\t\tsucceeded, skipped, and failed steps only reaches this total if every step\n\t\t\tfinishes in one of those states.

" } }, "totalStepsSucceeded": { "target": "com.amazonaws.imagebuilder#WorkflowStepCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

A runtime count for the number of steps in the workflow that ran successfully.

" } }, "totalStepsFailed": { "target": "com.amazonaws.imagebuilder#WorkflowStepCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

A runtime count for the number of steps in the workflow that failed.

" } }, "totalStepsSkipped": { "target": "com.amazonaws.imagebuilder#WorkflowStepCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

A runtime count for the number of steps in the workflow that were skipped.

" } }, "startTime": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the runtime instance of this workflow started.

" } }, "endTime": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when this runtime instance of the workflow finished.

" } }, "parallelGroup": { "target": "com.amazonaws.imagebuilder#ParallelGroup", "traits": { "smithy.api#documentation": "

The name of the test group that included the test workflow resource at runtime.

" } }, "retried": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { "smithy.api#documentation": "

Indicates whether a retry of the image build superseded this runtime instance\n of the workflow. When you retry a failed image build, Image Builder sets this flag to\n true on the original workflow executions that the retry re-ran.

" } } }, "traits": { "smithy.api#documentation": "

Metadata that includes details and status from this runtime instance of the workflow.

" } }, "com.amazonaws.imagebuilder#WorkflowExecutionStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "SKIPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SKIPPED" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "ROLLBACK_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" } }, "ROLLBACK_COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLLBACK_COMPLETED" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } } } }, "com.amazonaws.imagebuilder#WorkflowExecutionsList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#WorkflowExecutionMetadata" } }, "com.amazonaws.imagebuilder#WorkflowParameter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#WorkflowParameterName", "traits": { "smithy.api#documentation": "

The name of the workflow parameter to set.

", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.imagebuilder#WorkflowParameterValueList", "traits": { "smithy.api#documentation": "

Sets the value for the named workflow parameter.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains a key/value pair that sets the named workflow parameter.

" } }, "com.amazonaws.imagebuilder#WorkflowParameterDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^[^\\x00]+$" } }, "com.amazonaws.imagebuilder#WorkflowParameterDetail": { "type": "structure", "members": { "name": { "target": "com.amazonaws.imagebuilder#WorkflowParameterName", "traits": { "smithy.api#documentation": "

The name of this input parameter.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.imagebuilder#WorkflowParameterType", "traits": { "smithy.api#documentation": "

The type of input this parameter provides. Supported values are\n\t\t\tstring, integer, boolean, and\n\t\t\tstringList.

", "smithy.api#required": {} } }, "defaultValue": { "target": "com.amazonaws.imagebuilder#WorkflowParameterValueList", "traits": { "smithy.api#documentation": "

The default value of this parameter if no input is provided.

" } }, "description": { "target": "com.amazonaws.imagebuilder#WorkflowParameterDescription", "traits": { "smithy.api#documentation": "

Describes this parameter.

" } } }, "traits": { "smithy.api#documentation": "

Defines a parameter that's used to provide configuration details for the \n\t\t\tworkflow.

" } }, "com.amazonaws.imagebuilder#WorkflowParameterDetailList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#WorkflowParameterDetail" } }, "com.amazonaws.imagebuilder#WorkflowParameterList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#WorkflowParameter" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.imagebuilder#WorkflowParameterName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[^\\x00]+$" } }, "com.amazonaws.imagebuilder#WorkflowParameterType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 }, "smithy.api#pattern": "^string|integer|boolean|stringList$" } }, "com.amazonaws.imagebuilder#WorkflowParameterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0 }, "smithy.api#pattern": "^[^\\x00]*$" } }, "com.amazonaws.imagebuilder#WorkflowParameterValueList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#WorkflowParameterValue" } }, "com.amazonaws.imagebuilder#WorkflowState": { "type": "structure", "members": { "status": { "target": "com.amazonaws.imagebuilder#WorkflowStatus", "traits": { "smithy.api#documentation": "

The current state of the workflow.

" } }, "reason": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Describes how or why the workflow changed state.

" } } }, "traits": { "smithy.api#documentation": "

A group of fields that describe the current status of the workflow.

" } }, "com.amazonaws.imagebuilder#WorkflowStatus": { "type": "enum", "members": { "DEPRECATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPRECATED" } } } }, "com.amazonaws.imagebuilder#WorkflowStepAction": { "type": "string", "traits": { "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9-_]{1,99}$" } }, "com.amazonaws.imagebuilder#WorkflowStepActionType": { "type": "enum", "members": { "RESUME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESUME" } }, "STOP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOP" } } } }, "com.amazonaws.imagebuilder#WorkflowStepAttemptCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.imagebuilder#WorkflowStepCount": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.imagebuilder#WorkflowStepDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 500 } } }, "com.amazonaws.imagebuilder#WorkflowStepExecution": { "type": "structure", "members": { "stepExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionId", "traits": { "smithy.api#documentation": "

Uniquely identifies the workflow step that ran for the associated \n\t\t\timage build version.

" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image build version that ran the workflow.

" } }, "workflowExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", "traits": { "smithy.api#documentation": "

Uniquely identifies the runtime instance of the workflow that contains \n\t\t\tthe workflow step that ran for the associated image build version.

" } }, "workflowBuildVersionArn": { "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource that ran.

" } }, "name": { "target": "com.amazonaws.imagebuilder#WorkflowStepName", "traits": { "smithy.api#documentation": "

The name of the workflow step.

" } }, "action": { "target": "com.amazonaws.imagebuilder#WorkflowStepAction", "traits": { "smithy.api#documentation": "

The name of the step action.

" } }, "startTime": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the workflow step started.

" } } }, "traits": { "smithy.api#documentation": "

Contains runtime details for a workflow step that has paused at a\n\t\t\tWaitForAction step, and is waiting for you to send an action.

" } }, "com.amazonaws.imagebuilder#WorkflowStepExecutionId": { "type": "string", "traits": { "smithy.api#pattern": "^step-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } }, "com.amazonaws.imagebuilder#WorkflowStepExecutionList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#WorkflowStepExecution" } }, "com.amazonaws.imagebuilder#WorkflowStepExecutionRollbackStatus": { "type": "enum", "members": { "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "SKIPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SKIPPED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.imagebuilder#WorkflowStepExecutionStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "SKIPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SKIPPED" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } } } }, "com.amazonaws.imagebuilder#WorkflowStepExecutionsList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#WorkflowStepMetadata" } }, "com.amazonaws.imagebuilder#WorkflowStepInputs": { "type": "string" }, "com.amazonaws.imagebuilder#WorkflowStepMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 500 } } }, "com.amazonaws.imagebuilder#WorkflowStepMetadata": { "type": "structure", "members": { "stepExecutionId": { "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionId", "traits": { "smithy.api#documentation": "

A unique identifier for the workflow step, assigned at runtime.

" } }, "name": { "target": "com.amazonaws.imagebuilder#WorkflowStepName", "traits": { "smithy.api#documentation": "

The name of the workflow step.

" } }, "description": { "target": "com.amazonaws.imagebuilder#WorkflowStepDescription", "traits": { "smithy.api#documentation": "

Description of the workflow step.

" } }, "action": { "target": "com.amazonaws.imagebuilder#WorkflowStepAction", "traits": { "smithy.api#documentation": "

The step action name.

" } }, "status": { "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionStatus", "traits": { "smithy.api#documentation": "

Runtime status for the workflow step.

" } }, "rollbackStatus": { "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionRollbackStatus", "traits": { "smithy.api#documentation": "

Reports on the rollback status of the step, if applicable.

" } }, "message": { "target": "com.amazonaws.imagebuilder#WorkflowStepMessage", "traits": { "smithy.api#documentation": "

Detailed output message that the workflow step provides at runtime.

" } }, "inputs": { "target": "com.amazonaws.imagebuilder#WorkflowStepInputs", "traits": { "smithy.api#documentation": "

Input parameters that Image Builder provides for the workflow step, as a JSON-encoded\n\t\t\tstring.

" } }, "outputs": { "target": "com.amazonaws.imagebuilder#WorkflowStepOutputs", "traits": { "smithy.api#documentation": "

The output values that the workflow step produced for this runtime instance\n\t\t\tof the workflow, as a JSON-encoded string. For example, a step that launches\n\t\t\tan instance outputs the instance ID. If the step failed, this field contains\n\t\t\tthe error message.

" } }, "startTime": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the workflow step started.

" } }, "endTime": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the workflow step finished.

" } }, "attemptNumber": { "target": "com.amazonaws.imagebuilder#WorkflowStepAttemptCount", "traits": { "smithy.api#documentation": "

The current attempt number for the workflow step. The first run is attempt one.\n\t\t\tThe number increases by one for each retry.

" } }, "maxAttempts": { "target": "com.amazonaws.imagebuilder#WorkflowStepAttemptCount", "traits": { "smithy.api#documentation": "

The maximum number of attempts allowed for the workflow step, based on the\n\t\t\tretry configuration in the workflow document. If the step doesn't configure\n\t\t\tretries, the maximum is one attempt.

" } } }, "traits": { "smithy.api#documentation": "

Runtime details and status for the workflow step.

" } }, "com.amazonaws.imagebuilder#WorkflowStepName": { "type": "string", "traits": { "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9-_]{1,99}$" } }, "com.amazonaws.imagebuilder#WorkflowStepOutputs": { "type": "string" }, "com.amazonaws.imagebuilder#WorkflowStepTimeoutSecondsInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 43200 } } }, "com.amazonaws.imagebuilder#WorkflowSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the workflow.

" } }, "version": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { "smithy.api#documentation": "

The version of the workflow.

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Describes the workflow.

" } }, "changeDescription": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The change description for the current version of the workflow resource.

" } }, "type": { "target": "com.amazonaws.imagebuilder#WorkflowType", "traits": { "smithy.api#documentation": "

The image creation stage that this workflow applies to.

" } }, "owner": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The owner of the workflow resource.

" } }, "state": { "target": "com.amazonaws.imagebuilder#WorkflowState", "traits": { "smithy.api#documentation": "

Describes the current state of the workflow resource.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The original creation date of the workflow resource.

" } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

Contains a list of tags that are defined for the workflow.

" } } }, "traits": { "smithy.api#documentation": "

Contains metadata about the workflow resource.

" } }, "com.amazonaws.imagebuilder#WorkflowSummaryList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#WorkflowSummary" } }, "com.amazonaws.imagebuilder#WorkflowType": { "type": "enum", "members": { "BUILD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BUILD" } }, "TEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEST" } }, "DISTRIBUTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISTRIBUTION" } } } }, "com.amazonaws.imagebuilder#WorkflowVersion": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.imagebuilder#WorkflowWildcardVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource.

" } }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the workflow.

" } }, "version": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { "smithy.api#documentation": "

The semantic version of the workflow resource. The format includes three nodes: ...

" } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

Describes the workflow.

" } }, "type": { "target": "com.amazonaws.imagebuilder#WorkflowType", "traits": { "smithy.api#documentation": "

The image creation stage that this workflow applies to.

" } }, "owner": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The owner of the workflow resource.

" } }, "dateCreated": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when Image Builder created the workflow version.

" } } }, "traits": { "smithy.api#documentation": "

Contains details about this version of the workflow.

" } }, "com.amazonaws.imagebuilder#WorkflowVersionArnOrBuildVersionArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$" } }, "com.amazonaws.imagebuilder#WorkflowVersionList": { "type": "list", "member": { "target": "com.amazonaws.imagebuilder#WorkflowVersion" } }, "com.amazonaws.imagebuilder#WorkflowWildcardVersionArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/(?:[0-9]+|x)\\.(?:[0-9]+|x)\\.(?:[0-9]+|x)$" } }, "com.amazonaws.imagebuilder#imagebuilder": { "type": "service", "version": "2019-12-02", "operations": [ { "target": "com.amazonaws.imagebuilder#CancelImageCreation" }, { "target": "com.amazonaws.imagebuilder#CancelLifecycleExecution" }, { "target": "com.amazonaws.imagebuilder#CreateComponent" }, { "target": "com.amazonaws.imagebuilder#CreateContainerRecipe" }, { "target": "com.amazonaws.imagebuilder#CreateDistributionConfiguration" }, { "target": "com.amazonaws.imagebuilder#CreateImage" }, { "target": "com.amazonaws.imagebuilder#CreateImagePipeline" }, { "target": "com.amazonaws.imagebuilder#CreateImageRecipe" }, { "target": "com.amazonaws.imagebuilder#CreateInfrastructureConfiguration" }, { "target": "com.amazonaws.imagebuilder#CreateLifecyclePolicy" }, { "target": "com.amazonaws.imagebuilder#CreateWorkflow" }, { "target": "com.amazonaws.imagebuilder#DeleteComponent" }, { "target": "com.amazonaws.imagebuilder#DeleteContainerRecipe" }, { "target": "com.amazonaws.imagebuilder#DeleteDistributionConfiguration" }, { "target": "com.amazonaws.imagebuilder#DeleteImage" }, { "target": "com.amazonaws.imagebuilder#DeleteImagePipeline" }, { "target": "com.amazonaws.imagebuilder#DeleteImageRecipe" }, { "target": "com.amazonaws.imagebuilder#DeleteInfrastructureConfiguration" }, { "target": "com.amazonaws.imagebuilder#DeleteLifecyclePolicy" }, { "target": "com.amazonaws.imagebuilder#DeleteWorkflow" }, { "target": "com.amazonaws.imagebuilder#DistributeImage" }, { "target": "com.amazonaws.imagebuilder#GetComponent" }, { "target": "com.amazonaws.imagebuilder#GetComponentPolicy" }, { "target": "com.amazonaws.imagebuilder#GetContainerRecipe" }, { "target": "com.amazonaws.imagebuilder#GetContainerRecipePolicy" }, { "target": "com.amazonaws.imagebuilder#GetDistributionConfiguration" }, { "target": "com.amazonaws.imagebuilder#GetImage" }, { "target": "com.amazonaws.imagebuilder#GetImagePipeline" }, { "target": "com.amazonaws.imagebuilder#GetImagePolicy" }, { "target": "com.amazonaws.imagebuilder#GetImageRecipe" }, { "target": "com.amazonaws.imagebuilder#GetImageRecipePolicy" }, { "target": "com.amazonaws.imagebuilder#GetInfrastructureConfiguration" }, { "target": "com.amazonaws.imagebuilder#GetLifecycleExecution" }, { "target": "com.amazonaws.imagebuilder#GetLifecyclePolicy" }, { "target": "com.amazonaws.imagebuilder#GetMarketplaceResource" }, { "target": "com.amazonaws.imagebuilder#GetWorkflow" }, { "target": "com.amazonaws.imagebuilder#GetWorkflowExecution" }, { "target": "com.amazonaws.imagebuilder#GetWorkflowStepExecution" }, { "target": "com.amazonaws.imagebuilder#ImportComponent" }, { "target": "com.amazonaws.imagebuilder#ImportDiskImage" }, { "target": "com.amazonaws.imagebuilder#ImportVmImage" }, { "target": "com.amazonaws.imagebuilder#ListComponentBuildVersions" }, { "target": "com.amazonaws.imagebuilder#ListComponents" }, { "target": "com.amazonaws.imagebuilder#ListContainerRecipes" }, { "target": "com.amazonaws.imagebuilder#ListDistributionConfigurations" }, { "target": "com.amazonaws.imagebuilder#ListImageBuildVersions" }, { "target": "com.amazonaws.imagebuilder#ListImagePackages" }, { "target": "com.amazonaws.imagebuilder#ListImagePipelineImages" }, { "target": "com.amazonaws.imagebuilder#ListImagePipelines" }, { "target": "com.amazonaws.imagebuilder#ListImageRecipes" }, { "target": "com.amazonaws.imagebuilder#ListImages" }, { "target": "com.amazonaws.imagebuilder#ListImageScanFindingAggregations" }, { "target": "com.amazonaws.imagebuilder#ListImageScanFindings" }, { "target": "com.amazonaws.imagebuilder#ListInfrastructureConfigurations" }, { "target": "com.amazonaws.imagebuilder#ListLifecycleExecutionResources" }, { "target": "com.amazonaws.imagebuilder#ListLifecycleExecutions" }, { "target": "com.amazonaws.imagebuilder#ListLifecyclePolicies" }, { "target": "com.amazonaws.imagebuilder#ListTagsForResource" }, { "target": "com.amazonaws.imagebuilder#ListWaitingWorkflowSteps" }, { "target": "com.amazonaws.imagebuilder#ListWorkflowBuildVersions" }, { "target": "com.amazonaws.imagebuilder#ListWorkflowExecutions" }, { "target": "com.amazonaws.imagebuilder#ListWorkflows" }, { "target": "com.amazonaws.imagebuilder#ListWorkflowStepExecutions" }, { "target": "com.amazonaws.imagebuilder#PutComponentPolicy" }, { "target": "com.amazonaws.imagebuilder#PutContainerRecipePolicy" }, { "target": "com.amazonaws.imagebuilder#PutImagePolicy" }, { "target": "com.amazonaws.imagebuilder#PutImageRecipePolicy" }, { "target": "com.amazonaws.imagebuilder#RetryImage" }, { "target": "com.amazonaws.imagebuilder#SendWorkflowStepAction" }, { "target": "com.amazonaws.imagebuilder#StartImagePipelineExecution" }, { "target": "com.amazonaws.imagebuilder#StartResourceStateUpdate" }, { "target": "com.amazonaws.imagebuilder#TagResource" }, { "target": "com.amazonaws.imagebuilder#UntagResource" }, { "target": "com.amazonaws.imagebuilder#UpdateDistributionConfiguration" }, { "target": "com.amazonaws.imagebuilder#UpdateImagePipeline" }, { "target": "com.amazonaws.imagebuilder#UpdateInfrastructureConfiguration" }, { "target": "com.amazonaws.imagebuilder#UpdateLifecyclePolicy" } ], "traits": { "aws.api#service": { "sdkId": "imagebuilder", "arnNamespace": "imagebuilder", "cloudFormationName": "Imagebuilder", "cloudTrailEventSource": "imagebuilder.amazonaws.com", "endpointPrefix": "imagebuilder" }, "aws.auth#sigv4": { "name": "imagebuilder" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "

EC2 Image Builder automates the\n\t\t\tcreation, management, and deployment of customized, secure, and up-to-date\n\t\t\tserver images. You can build Amazon Machine Images (AMIs) and container images\n\t\t\tthat are pre-installed and pre-configured with software and settings to meet\n\t\t\tspecific IT standards.

\n

For an introduction to the service concepts that these API operations work with,\n\t\t\tsee How Image Builder\n\t\t\t\tworks in the EC2 Image Builder User Guide.

", "smithy.api#title": "EC2 Image Builder", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://imagebuilder-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://imagebuilder.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://imagebuilder-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://imagebuilder.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://imagebuilder.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 14, "nodes": "/////wAAAAH/////AAAAAAAAAA0AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAgAAAAGAAAABAAAAAcF9eELAAAABQX14QkF9eEKAAAABAAAAAsAAAAJAAAABgAAAAoF9eEIAAAABwX14QYF9eEHAAAABQAAAAwF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAOAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://imagebuilder-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://imagebuilder.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://imagebuilder-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://imagebuilder.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://imagebuilder.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://imagebuilder-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://imagebuilder-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://imagebuilder.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://imagebuilder.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://imagebuilder-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://imagebuilder-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://imagebuilder.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://imagebuilder.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://imagebuilder.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://imagebuilder.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://imagebuilder.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://imagebuilder.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://imagebuilder-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://imagebuilder.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://imagebuilder-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://imagebuilder.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://imagebuilder-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://imagebuilder.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } } } }