EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.
', 'operations' => [ 'CancelImageCreation' => 'CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
', 'CreateComponent' => 'Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:
Inline, using the data property in the request body.
A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body.
Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
', 'CreateDistributionConfiguration' => 'Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
', 'CreateImage' => 'Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.
', 'CreateImagePipeline' => 'Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
', 'CreateImageRecipe' => 'Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.
', 'CreateInfrastructureConfiguration' => 'Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
', 'DeleteComponent' => 'Deletes a component build version.
', 'DeleteContainerRecipe' => 'Deletes a container recipe.
', 'DeleteDistributionConfiguration' => 'Deletes a distribution configuration.
', 'DeleteImage' => 'Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images that are created during the image build process. You must clean those up separately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands.
To deregister an EC2 Linux AMI, see Deregister your Linux AMI in the Amazon EC2 User Guide .
To deregister an EC2 Windows AMI, see Deregister your Windows AMI in the Amazon EC2 Windows Guide .
To delete a container image from Amazon ECR, see Deleting an image in the Amazon ECR User Guide.
Deletes an image pipeline.
', 'DeleteImageRecipe' => 'Deletes an image recipe.
', 'DeleteInfrastructureConfiguration' => 'Deletes an infrastructure configuration.
', 'GetComponent' => 'Gets a component object.
', 'GetComponentPolicy' => 'Gets a component policy.
', 'GetContainerRecipe' => 'Retrieves a container recipe.
', 'GetContainerRecipePolicy' => 'Retrieves the policy for a container recipe.
', 'GetDistributionConfiguration' => 'Gets a distribution configuration.
', 'GetImage' => 'Gets an image.
', 'GetImagePipeline' => 'Gets an image pipeline.
', 'GetImagePolicy' => 'Gets an image policy.
', 'GetImageRecipe' => 'Gets an image recipe.
', 'GetImageRecipePolicy' => 'Gets an image recipe policy.
', 'GetInfrastructureConfiguration' => 'Gets an infrastructure configuration.
', 'GetWorkflowExecution' => 'Get the runtime information that was logged for a specific runtime instance of the workflow.
', 'GetWorkflowStepExecution' => 'Get the runtime information that was logged for a specific runtime instance of the workflow step.
', 'ImportComponent' => 'Imports a component and transforms its data into a component document.
', 'ImportVmImage' => 'When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data. The Amazon EC2 API ImportImage action uses those files to import your VM and create an AMI. To import using the CLI command, see import-image
You can reference the task ID from the VM import to pull in the AMI that the import created as the base image for your Image Builder recipe.
', 'ListComponentBuildVersions' => 'Returns the list of component build versions for the specified semantic version.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
Returns the list of components that can be filtered by name, or by using the listed filters to streamline results. Newly created components can take up to two minutes to appear in the ListComponents API Results.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
Returns a list of container recipes.
', 'ListDistributionConfigurations' => 'Returns a list of distribution configurations.
', 'ListImageBuildVersions' => 'Returns a list of image build versions.
', 'ListImagePackages' => 'List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.
', 'ListImagePipelineImages' => 'Returns a list of images created by the specified pipeline.
', 'ListImagePipelines' => 'Returns a list of image pipelines.
', 'ListImageRecipes' => 'Returns a list of image recipes.
', 'ListImageScanFindingAggregations' => 'Returns a list of image scan aggregations for your account. You can filter by the type of key that Image Builder uses to group results. For example, if you want to get a list of findings by severity level for one of your pipelines, you might specify your pipeline with the imagePipelineArn filter. If you don\'t specify a filter, Image Builder returns an aggregation for your account.
To streamline results, you can use the following filters in your request:
accountId
imageBuildVersionArn
imagePipelineArn
vulnerabilityId
Returns a list of image scan findings for your account.
', 'ListImages' => 'Returns the list of images that you have access to. Newly created images can take up to two minutes to appear in the ListImages API Results.
', 'ListInfrastructureConfigurations' => 'Returns a list of infrastructure configurations.
', 'ListTagsForResource' => 'Returns the list of tags for the specified resource.
', 'ListWorkflowExecutions' => 'Returns a list of workflow runtime instance metadata objects for a specific image build version.
', 'ListWorkflowStepExecutions' => 'Shows runtime data for each step in a runtime instance of the workflow that you specify in the request.
', 'PutComponentPolicy' => 'Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to share resources. If you call the Image Builder API PutContainerImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) in order for the resource to be visible to all principals with whom the resource is shared.
Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
Manually triggers a pipeline to create an image.
', 'TagResource' => 'Adds a tag to a resource.
', 'UntagResource' => 'Removes a tag from a resource.
', 'UpdateDistributionConfiguration' => 'Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
', 'UpdateImagePipeline' => 'Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images.
UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed.
Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
', ], 'shapes' => [ 'AccountAggregation' => [ 'base' => 'Contains counts of vulnerability findings from image scans that run when you create new Image Builder images, or build new versions of existing images. The vulnerability counts are grouped by severity level. The counts are aggregated across resources to create the final tally for the account that owns them.
', 'refs' => [ 'ImageScanFindingAggregation$accountAggregation' => 'Returns an object that contains severity counts based on an account ID.
', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'AccountList$member' => NULL, 'FastLaunchConfiguration$accountId' => 'The owner account ID for the fast-launch enabled Windows AMI.
', 'LaunchTemplateConfiguration$accountId' => 'The account ID that this configuration applies to.
', ], ], 'AccountList' => [ 'base' => NULL, 'refs' => [ 'AmiDistributionConfiguration$targetAccountIds' => 'The ID of an account to which you want to distribute an image.
', 'LaunchPermissionConfiguration$userIds' => 'The Amazon Web Services account ID.
', ], ], 'AdditionalInstanceConfiguration' => [ 'base' => 'In addition to your infrastructure configuration, these settings provide an extra layer of control over your build instances. You can also specify commands to run on launch for all of your build instances.
Image Builder does not automatically install the Systems Manager agent on Windows instances. If your base image includes the Systems Manager agent, then the AMI that you create will also include the agent. For Linux instances, if the base image does not already include the Systems Manager agent, Image Builder installs it. For Linux instances where Image Builder installs the Systems Manager agent, you can choose whether to keep it for the AMI that you create.
', 'refs' => [ 'CreateImageRecipeRequest$additionalInstanceConfiguration' => 'Specify additional settings and launch scripts for your build instances.
', 'ImageRecipe$additionalInstanceConfiguration' => 'Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.
', ], ], 'Ami' => [ 'base' => 'Details of an Amazon EC2 AMI.
', 'refs' => [ 'AmiList$member' => NULL, ], ], 'AmiDistributionConfiguration' => [ 'base' => 'Define and configure the output AMIs of the pipeline.
', 'refs' => [ 'Distribution$amiDistributionConfiguration' => 'The specific AMI settings; for example, launch permissions or AMI tags.
', ], ], 'AmiList' => [ 'base' => NULL, 'refs' => [ 'OutputResources$amis' => 'The Amazon EC2 AMIs created by this image.
', ], ], 'AmiNameString' => [ 'base' => NULL, 'refs' => [ 'AmiDistributionConfiguration$name' => 'The name of the output AMI.
', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'Image$sourcePipelineArn' => 'The Amazon Resource Name (ARN) of the image pipeline that created this image.
', 'ImagePipeline$imageRecipeArn' => 'The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
', 'ImagePipeline$containerRecipeArn' => 'The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
', 'ImagePipeline$infrastructureConfigurationArn' => 'The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
', 'ImagePipeline$distributionConfigurationArn' => 'The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
', 'ImportVmImageResponse$imageArn' => 'The Amazon Resource Name (ARN) of the AMI that was created during the VM import process. This AMI is used as the base image for the recipe that imported the VM.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'Component$obfuscate' => 'Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
', 'ComponentSummary$obfuscate' => 'Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
', 'FastLaunchConfiguration$enabled' => 'A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.
Set the specified Amazon EC2 launch template as the default launch template for the specified account.
', 'ListComponentsRequest$byName' => 'Returns the list of components for the specified name.
', 'ListImagesRequest$byName' => 'Requests a list of images with a specific recipe name.
', ], ], 'BuildType' => [ 'base' => NULL, 'refs' => [ 'Image$buildType' => 'Indicates the type of build that created this image. The build can be initiated in the following ways:
USER_INITIATED – A manual pipeline build request.
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
IMPORT – A VM import created the image to use as the base image for the recipe.
Indicates the type of build that created this image. The build can be initiated in the following ways:
USER_INITIATED – A manual pipeline build request.
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
IMPORT – A VM import created the image to use as the base image for the recipe.
Indicates the type of build that created this image. The build can be initiated in the following ways:
USER_INITIATED – A manual pipeline build request.
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
IMPORT – A VM import created the image to use as the base image for the recipe.
You have exceeded the permitted request rate for the specific operation.
', 'refs' => [], ], 'CancelImageCreationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelImageCreationResponse' => [ 'base' => NULL, 'refs' => [], ], 'ClientException' => [ 'base' => 'These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn\'t have permissions to use the action or resource, or specifying an invalid resource identifier.
', 'refs' => [], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CancelImageCreationRequest$clientToken' => 'Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
', 'CancelImageCreationResponse$clientToken' => 'The idempotency token that was used for this request.
', 'CreateComponentRequest$clientToken' => 'The idempotency token of the component.
', 'CreateComponentResponse$clientToken' => 'The idempotency token used to make this request idempotent.
', 'CreateContainerRecipeRequest$clientToken' => 'The client token used to make this request idempotent.
', 'CreateContainerRecipeResponse$clientToken' => 'The client token used to make this request idempotent.
', 'CreateDistributionConfigurationRequest$clientToken' => 'The idempotency token of the distribution configuration.
', 'CreateDistributionConfigurationResponse$clientToken' => 'The idempotency token used to make this request idempotent.
', 'CreateImagePipelineRequest$clientToken' => 'The idempotency token used to make this request idempotent.
', 'CreateImagePipelineResponse$clientToken' => 'The idempotency token used to make this request idempotent.
', 'CreateImageRecipeRequest$clientToken' => 'The idempotency token used to make this request idempotent.
', 'CreateImageRecipeResponse$clientToken' => 'The idempotency token used to make this request idempotent.
', 'CreateImageRequest$clientToken' => 'The idempotency token used to make this request idempotent.
', 'CreateImageResponse$clientToken' => 'The idempotency token used to make this request idempotent.
', 'CreateInfrastructureConfigurationRequest$clientToken' => 'The idempotency token used to make this request idempotent.
', 'CreateInfrastructureConfigurationResponse$clientToken' => 'The idempotency token used to make this request idempotent.
', 'ImportComponentRequest$clientToken' => 'The idempotency token of the component.
', 'ImportComponentResponse$clientToken' => 'The idempotency token used to make this request idempotent.
', 'ImportVmImageRequest$clientToken' => 'Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
', 'ImportVmImageResponse$clientToken' => 'The idempotency token that was used for this request.
', 'StartImagePipelineExecutionRequest$clientToken' => 'The idempotency token used to make this request idempotent.
', 'StartImagePipelineExecutionResponse$clientToken' => 'The idempotency token used to make this request idempotent.
', 'UpdateDistributionConfigurationRequest$clientToken' => 'The idempotency token of the distribution configuration.
', 'UpdateDistributionConfigurationResponse$clientToken' => 'The idempotency token used to make this request idempotent.
', 'UpdateImagePipelineRequest$clientToken' => 'The idempotency token used to make this request idempotent.
', 'UpdateImagePipelineResponse$clientToken' => 'The idempotency token used to make this request idempotent.
', 'UpdateInfrastructureConfigurationRequest$clientToken' => 'The idempotency token used to make this request idempotent.
', 'UpdateInfrastructureConfigurationResponse$clientToken' => 'The idempotency token used to make this request idempotent.
', ], ], 'Component' => [ 'base' => 'A detailed view of a component.
', 'refs' => [ 'GetComponentResponse$component' => 'The component object associated with the specified ARN.
', ], ], 'ComponentBuildVersionArn' => [ 'base' => NULL, 'refs' => [ 'CreateComponentResponse$componentBuildVersionArn' => 'The Amazon Resource Name (ARN) of the component that this request created.
', 'DeleteComponentRequest$componentBuildVersionArn' => 'The Amazon Resource Name (ARN) of the component build version to delete.
', 'DeleteComponentResponse$componentBuildVersionArn' => 'The ARN of the component build version that this request deleted.
', 'GetComponentPolicyRequest$componentArn' => 'The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.
', 'ImportComponentResponse$componentBuildVersionArn' => 'The Amazon Resource Name (ARN) of the imported component.
', 'PutComponentPolicyRequest$componentArn' => 'The Amazon Resource Name (ARN) of the component that this policy should be applied to.
', 'PutComponentPolicyResponse$componentArn' => 'The Amazon Resource Name (ARN) of the component that this policy was applied to.
', ], ], 'ComponentConfiguration' => [ 'base' => 'Configuration details of the component.
', 'refs' => [ 'ComponentConfigurationList$member' => NULL, ], ], 'ComponentConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ContainerRecipe$components' => 'Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
', 'CreateContainerRecipeRequest$components' => 'Components for build and test that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
', 'CreateImageRecipeRequest$components' => 'The components included in the image recipe.
', 'ImageRecipe$components' => 'The components that are included in the image recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
', ], ], 'ComponentData' => [ 'base' => NULL, 'refs' => [ 'Component$data' => 'Component data contains the YAML document content for the component.
', ], ], 'ComponentFormat' => [ 'base' => NULL, 'refs' => [ 'ImportComponentRequest$format' => 'The format of the resource that you want to import as a component.
', ], ], 'ComponentParameter' => [ 'base' => 'Contains a key/value pair that sets the named component parameter.
', 'refs' => [ 'ComponentParameterList$member' => NULL, ], ], 'ComponentParameterDescription' => [ 'base' => NULL, 'refs' => [ 'ComponentParameterDetail$description' => 'Describes this parameter.
', ], ], 'ComponentParameterDetail' => [ 'base' => 'Defines a parameter that is used to provide configuration details for the component.
', 'refs' => [ 'ComponentParameterDetailList$member' => NULL, ], ], 'ComponentParameterDetailList' => [ 'base' => NULL, 'refs' => [ 'Component$parameters' => 'Contains parameter details for each of the parameters that the component document defined for the component.
', ], ], 'ComponentParameterList' => [ 'base' => NULL, 'refs' => [ 'ComponentConfiguration$parameters' => 'A group of parameter settings that Image Builder uses to configure the component for a specific recipe.
', ], ], 'ComponentParameterName' => [ 'base' => NULL, 'refs' => [ 'ComponentParameter$name' => 'The name of the component parameter to set.
', 'ComponentParameterDetail$name' => 'The name of this input parameter.
', ], ], 'ComponentParameterType' => [ 'base' => NULL, 'refs' => [ 'ComponentParameterDetail$type' => 'The type of input this parameter provides. The currently supported value is "string".
', ], ], 'ComponentParameterValue' => [ 'base' => NULL, 'refs' => [ 'ComponentParameterValueList$member' => NULL, ], ], 'ComponentParameterValueList' => [ 'base' => NULL, 'refs' => [ 'ComponentParameter$value' => 'Sets the value for the named component parameter.
', 'ComponentParameterDetail$defaultValue' => 'The default value of this parameter if no input is provided.
', ], ], 'ComponentState' => [ 'base' => 'A group of fields that describe the current status of components that are no longer active.
', 'refs' => [ 'Component$state' => 'Describes the current status of the component. This is used for components that are no longer active.
', 'ComponentSummary$state' => 'Describes the current status of the component.
', ], ], 'ComponentStatus' => [ 'base' => NULL, 'refs' => [ 'ComponentState$status' => 'The current state of the component.
', ], ], 'ComponentSummary' => [ 'base' => 'A high-level summary of a component.
', 'refs' => [ 'ComponentSummaryList$member' => NULL, ], ], 'ComponentSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListComponentBuildVersionsResponse$componentSummaryList' => 'The list of component summaries for the specified semantic version.
', ], ], 'ComponentType' => [ 'base' => NULL, 'refs' => [ 'Component$type' => 'The component type specifies whether Image Builder uses the component to build the image or only to test it.
', 'ComponentSummary$type' => 'The component type specifies whether Image Builder uses the component to build the image or only to test it.
', 'ComponentVersion$type' => 'The type of the component denotes whether the component is used to build the image or only to test it.
', 'ImportComponentRequest$type' => 'The type of the component denotes whether the component is used to build the image, or only to test it.
', ], ], 'ComponentVersion' => [ 'base' => 'The defining characteristics of a specific version of an Amazon Web Services TOE component.
', 'refs' => [ 'ComponentVersionList$member' => NULL, ], ], 'ComponentVersionArn' => [ 'base' => NULL, 'refs' => [ 'ListComponentBuildVersionsRequest$componentVersionArn' => 'The component version Amazon Resource Name (ARN) whose versions you want to list.
', ], ], 'ComponentVersionArnOrBuildVersionArn' => [ 'base' => NULL, 'refs' => [ 'ComponentConfiguration$componentArn' => 'The Amazon Resource Name (ARN) of the component.
', 'GetComponentRequest$componentBuildVersionArn' => 'The Amazon Resource Name (ARN) of the component that you want to get. Regex requires the suffix /\\d+$.
The list of component semantic versions.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
A container encapsulates the runtime environment for an application.
', 'refs' => [ 'ContainerList$member' => NULL, ], ], 'ContainerDistributionConfiguration' => [ 'base' => 'Container distribution settings for encryption, licensing, and sharing in a specific Region.
', 'refs' => [ 'Distribution$containerDistributionConfiguration' => 'Container distribution settings for encryption, licensing, and sharing in a specific Region.
', ], ], 'ContainerList' => [ 'base' => NULL, 'refs' => [ 'OutputResources$containers' => 'Container images that the pipeline has generated and stored in the output repository.
', ], ], 'ContainerRecipe' => [ 'base' => 'A container recipe.
', 'refs' => [ 'GetContainerRecipeResponse$containerRecipe' => 'The container recipe object that is returned.
', 'Image$containerRecipe' => 'For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.
', ], ], 'ContainerRecipeArn' => [ 'base' => NULL, 'refs' => [ 'CreateContainerRecipeResponse$containerRecipeArn' => 'Returns the Amazon Resource Name (ARN) of the container recipe that the request created.
', 'CreateImagePipelineRequest$containerRecipeArn' => 'The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.
', 'CreateImageRequest$containerRecipeArn' => 'The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
', 'DeleteContainerRecipeRequest$containerRecipeArn' => 'The Amazon Resource Name (ARN) of the container recipe to delete.
', 'DeleteContainerRecipeResponse$containerRecipeArn' => 'The Amazon Resource Name (ARN) of the container recipe that was deleted.
', 'GetContainerRecipePolicyRequest$containerRecipeArn' => 'The Amazon Resource Name (ARN) of the container recipe for the policy being requested.
', 'GetContainerRecipeRequest$containerRecipeArn' => 'The Amazon Resource Name (ARN) of the container recipe to retrieve.
', 'PutContainerRecipePolicyRequest$containerRecipeArn' => 'The Amazon Resource Name (ARN) of the container recipe that this policy should be applied to.
', 'PutContainerRecipePolicyResponse$containerRecipeArn' => 'The Amazon Resource Name (ARN) of the container recipe that this policy was applied to.
', 'UpdateImagePipelineRequest$containerRecipeArn' => 'The Amazon Resource Name (ARN) of the container pipeline to update.
', ], ], 'ContainerRecipeSummary' => [ 'base' => 'A summary of a container recipe
', 'refs' => [ 'ContainerRecipeSummaryList$member' => NULL, ], ], 'ContainerRecipeSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListContainerRecipesResponse$containerRecipeSummaryList' => 'The list of container recipes returned for the request.
', ], ], 'ContainerRepositoryService' => [ 'base' => NULL, 'refs' => [ 'TargetContainerRepository$service' => 'Specifies the service in which this image was registered.
', ], ], 'ContainerType' => [ 'base' => NULL, 'refs' => [ 'ContainerRecipe$containerType' => 'Specifies the type of container, such as Docker.
', 'ContainerRecipeSummary$containerType' => 'Specifies the type of container, such as "Docker".
', 'CreateContainerRecipeRequest$containerType' => 'The type of container to create.
', ], ], 'CreateComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateContainerRecipeRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContainerRecipeResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDistributionConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDistributionConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImagePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImagePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageRecipeRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageRecipeResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateInfrastructureConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInfrastructureConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CvssScore' => [ 'base' => 'Amazon Inspector generates a risk score for each finding. This score helps you to prioritize findings, to focus on the most critical findings and the most vulnerable resources. The score uses the Common Vulnerability Scoring System (CVSS) format. This format is a modification of the base CVSS score that the National Vulnerability Database (NVD) provides. For more information about severity levels, see Severity levels for Amazon Inspector findings in the Amazon Inspector User Guide.
', 'refs' => [ 'CvssScoreList$member' => NULL, ], ], 'CvssScoreAdjustment' => [ 'base' => 'Details about an adjustment that Amazon Inspector made to the CVSS score for a finding.
', 'refs' => [ 'CvssScoreAdjustmentList$member' => NULL, ], ], 'CvssScoreAdjustmentList' => [ 'base' => NULL, 'refs' => [ 'CvssScoreDetails$adjustments' => 'An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding.
', ], ], 'CvssScoreDetails' => [ 'base' => 'Details about the source of the score, and the factors that determined the adjustments to create the final score.
', 'refs' => [ 'InspectorScoreDetails$adjustedCvss' => 'An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding.
', ], ], 'CvssScoreList' => [ 'base' => NULL, 'refs' => [ 'PackageVulnerabilityDetails$cvss' => 'CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a package.
', ], ], 'DateTime' => [ 'base' => NULL, 'refs' => [ 'Component$dateCreated' => 'The date that Image Builder created the component.
', 'ComponentSummary$dateCreated' => 'The original creation date of the component.
', 'ComponentVersion$dateCreated' => 'The date that the component was created.
', 'ContainerRecipe$dateCreated' => 'The date when this container recipe was created.
', 'ContainerRecipeSummary$dateCreated' => 'The date when this container recipe was created.
', 'DistributionConfiguration$dateCreated' => 'The date on which this distribution configuration was created.
', 'DistributionConfiguration$dateUpdated' => 'The date on which this distribution configuration was last updated.
', 'DistributionConfigurationSummary$dateCreated' => 'The date on which the distribution configuration was created.
', 'DistributionConfigurationSummary$dateUpdated' => 'The date on which the distribution configuration was updated.
', 'GetWorkflowExecutionResponse$startTime' => 'The timestamp when the specified runtime instance of the workflow started.
', 'GetWorkflowExecutionResponse$endTime' => 'The timestamp when the specified runtime instance of the workflow finished.
', 'GetWorkflowStepExecutionResponse$startTime' => 'The timestamp when the specified runtime version of the workflow step started.
', 'GetWorkflowStepExecutionResponse$endTime' => 'The timestamp when the specified runtime instance of the workflow step finished.
', 'Image$dateCreated' => 'The date on which Image Builder created this image.
', 'ImagePipeline$dateCreated' => 'The date on which this image pipeline was created.
', 'ImagePipeline$dateUpdated' => 'The date on which this image pipeline was last updated.
', 'ImagePipeline$dateLastRun' => 'This is no longer supported, and does not return a value.
', 'ImagePipeline$dateNextRun' => 'The next date when the pipeline is scheduled to run.
', 'ImageRecipe$dateCreated' => 'The date on which this image recipe was created.
', 'ImageRecipeSummary$dateCreated' => 'The date on which this image recipe was created.
', 'ImageSummary$dateCreated' => 'The date on which Image Builder created this image.
', 'ImageVersion$dateCreated' => 'The date on which this specific version of the Image Builder image was created.
', 'InfrastructureConfiguration$dateCreated' => 'The date on which the infrastructure configuration was created.
', 'InfrastructureConfiguration$dateUpdated' => 'The date on which the infrastructure configuration was last updated.
', 'InfrastructureConfigurationSummary$dateCreated' => 'The date on which the infrastructure configuration was created.
', 'InfrastructureConfigurationSummary$dateUpdated' => 'The date on which the infrastructure configuration was last updated.
', 'WorkflowExecutionMetadata$startTime' => 'The timestamp when the runtime instance of this workflow started.
', 'WorkflowExecutionMetadata$endTime' => 'The timestamp when this runtime instance of the workflow finished.
', 'WorkflowStepMetadata$startTime' => 'The timestamp when the workflow step started.
', 'WorkflowStepMetadata$endTime' => 'The timestamp when the workflow step finished.
', ], ], 'DateTimeTimestamp' => [ 'base' => NULL, 'refs' => [ 'ImageScanFinding$firstObservedAt' => 'The date and time when the finding was first observed.
', 'ImageScanFinding$updatedAt' => 'The timestamp when the finding was last updated.
', 'PackageVulnerabilityDetails$vendorCreatedAt' => 'The date and time when this vulnerability was first added to the vendor\'s database.
', 'PackageVulnerabilityDetails$vendorUpdatedAt' => 'The date and time when the vendor last updated this vulnerability in their database.
', ], ], 'DeleteComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContainerRecipeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContainerRecipeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDistributionConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDistributionConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImagePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImagePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageRecipeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageRecipeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInfrastructureConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInfrastructureConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DiskImageFormat' => [ 'base' => NULL, 'refs' => [ 'S3ExportConfiguration$diskImageFormat' => 'Export the updated image to one of the following supported disk image formats:
Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.
Stream-optimized ESX Virtual Machine Disk (VMDK) – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.
Raw – Raw format.
Defines the settings for a specific Region.
', 'refs' => [ 'DistributionList$member' => NULL, ], ], 'DistributionConfiguration' => [ 'base' => 'A distribution configuration.
', 'refs' => [ 'GetDistributionConfigurationResponse$distributionConfiguration' => 'The distribution configuration object.
', 'Image$distributionConfiguration' => 'The distribution configuration that Image Builder used to create this image.
', ], ], 'DistributionConfigurationArn' => [ 'base' => NULL, 'refs' => [ 'CreateDistributionConfigurationResponse$distributionConfigurationArn' => 'The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.
', 'CreateImagePipelineRequest$distributionConfigurationArn' => 'The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.
', 'CreateImageRequest$distributionConfigurationArn' => 'The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
', 'DeleteDistributionConfigurationRequest$distributionConfigurationArn' => 'The Amazon Resource Name (ARN) of the distribution configuration to delete.
', 'DeleteDistributionConfigurationResponse$distributionConfigurationArn' => 'The Amazon Resource Name (ARN) of the distribution configuration that was deleted.
', 'GetDistributionConfigurationRequest$distributionConfigurationArn' => 'The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.
', 'UpdateDistributionConfigurationRequest$distributionConfigurationArn' => 'The Amazon Resource Name (ARN) of the distribution configuration that you want to update.
', 'UpdateDistributionConfigurationResponse$distributionConfigurationArn' => 'The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.
', 'UpdateImagePipelineRequest$distributionConfigurationArn' => 'The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.
', ], ], 'DistributionConfigurationSummary' => [ 'base' => 'A high-level overview of a distribution configuration.
', 'refs' => [ 'DistributionConfigurationSummaryList$member' => NULL, ], ], 'DistributionConfigurationSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDistributionConfigurationsResponse$distributionConfigurationSummaryList' => 'The list of distributions.
', ], ], 'DistributionList' => [ 'base' => NULL, 'refs' => [ 'CreateDistributionConfigurationRequest$distributions' => 'The distributions of the distribution configuration.
', 'DistributionConfiguration$distributions' => 'The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions.
', 'UpdateDistributionConfigurationRequest$distributions' => 'The distributions of the distribution configuration.
', ], ], 'DistributionTimeoutMinutes' => [ 'base' => NULL, 'refs' => [ 'DistributionConfiguration$timeoutMinutes' => 'The maximum duration in minutes for this distribution configuration.
', ], ], 'DockerFileTemplate' => [ 'base' => NULL, 'refs' => [ 'ContainerRecipe$dockerfileTemplateData' => 'Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
', ], ], 'EbsInstanceBlockDeviceSpecification' => [ 'base' => 'Amazon EBS-specific block device mapping specifications.
', 'refs' => [ 'InstanceBlockDeviceMapping$ebs' => 'Use to manage Amazon EBS-specific configuration for this mapping.
', ], ], 'EbsIopsInteger' => [ 'base' => NULL, 'refs' => [ 'EbsInstanceBlockDeviceSpecification$iops' => 'Use to configure device IOPS.
', ], ], 'EbsVolumeSizeInteger' => [ 'base' => NULL, 'refs' => [ 'EbsInstanceBlockDeviceSpecification$volumeSize' => 'Use to override the device\'s volume size.
', ], ], 'EbsVolumeThroughput' => [ 'base' => NULL, 'refs' => [ 'EbsInstanceBlockDeviceSpecification$throughput' => 'For GP3 volumes only – The throughput in MiB/s that the volume supports.
', ], ], 'EbsVolumeType' => [ 'base' => NULL, 'refs' => [ 'EbsInstanceBlockDeviceSpecification$volumeType' => 'Use to override the device\'s volume type.
', ], ], 'EcrConfiguration' => [ 'base' => 'Settings that Image Builder uses to configure the ECR repository and the output container images that Amazon Inspector scans.
', 'refs' => [ 'ImageScanningConfiguration$ecrConfiguration' => 'Contains Amazon ECR settings for vulnerability scans.
', ], ], 'EmptyString' => [ 'base' => NULL, 'refs' => [ 'InstanceBlockDeviceMapping$noDevice' => 'Use to remove a mapping from the base image.
', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'CallRateLimitExceededException$message' => NULL, 'ClientException$message' => NULL, 'ForbiddenException$message' => NULL, 'IdempotentParameterMismatchException$message' => NULL, 'InvalidPaginationTokenException$message' => NULL, 'InvalidParameterCombinationException$message' => NULL, 'InvalidParameterException$message' => NULL, 'InvalidParameterValueException$message' => NULL, 'InvalidRequestException$message' => NULL, 'InvalidVersionNumberException$message' => NULL, 'ResourceAlreadyExistsException$message' => NULL, 'ResourceDependencyException$message' => NULL, 'ResourceInUseException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ServiceException$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'ServiceUnavailableException$message' => NULL, ], ], 'FastLaunchConfiguration' => [ 'base' => 'Define and configure faster launching for output Windows AMIs.
', 'refs' => [ 'FastLaunchConfigurationList$member' => NULL, ], ], 'FastLaunchConfigurationList' => [ 'base' => NULL, 'refs' => [ 'Distribution$fastLaunchConfigurations' => 'The Windows faster-launching configurations to use for AMI distribution.
', ], ], 'FastLaunchLaunchTemplateSpecification' => [ 'base' => 'Identifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled.
You can specify either the launchTemplateName or the launchTemplateId, but not both.
The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
', ], ], 'FastLaunchSnapshotConfiguration' => [ 'base' => 'Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
', 'refs' => [ 'FastLaunchConfiguration$snapshotConfiguration' => 'Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.
', ], ], 'Filter' => [ 'base' => 'A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
', 'refs' => [ 'FilterList$member' => NULL, 'ListImageScanFindingAggregationsRequest$filter' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'ListComponentsRequest$filters' => 'Use the following filters to streamline results:
description
name
platform
supportedOsVersion
type
version
Use the following filters to streamline results:
containerType
name
parentImage
platform
You can filter on name to streamline results.
Use the following filters to streamline results:
name
osVersion
platform
type
version
Use the following filters to streamline results:
name
version
Use the following filters to streamline results:
description
distributionConfigurationArn
imageRecipeArn
infrastructureConfigurationArn
name
status
Use the following filters to streamline results:
name
parentImage
platform
Use the following filters to streamline results:
name
osVersion
platform
type
version
You can filter on name to streamline results.
The name of the filter. Filter names are case-sensitive.
', 'ImageScanFindingsFilter$name' => 'The name of the image scan finding filter. Filter names are case-sensitive.
', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'FilterValues$member' => NULL, 'ImageScanFindingsFilterValues$member' => NULL, ], ], 'FilterValues' => [ 'base' => NULL, 'refs' => [ 'Filter$values' => 'The filter values. Filter values are case-sensitive.
', ], ], 'ForbiddenException' => [ 'base' => 'You are not authorized to perform the requested operation.
', 'refs' => [], ], 'GetComponentPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetComponentPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerRecipePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerRecipePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerRecipeRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerRecipeResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetImagePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetImagePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetImagePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetImagePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetImageRecipePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetImageRecipePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetImageRecipeRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetImageRecipeResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetInfrastructureConfigurationRequest' => [ 'base' => 'GetInfrastructureConfiguration request object.
', 'refs' => [], ], 'GetInfrastructureConfigurationResponse' => [ 'base' => 'GetInfrastructureConfiguration response object.
', 'refs' => [], ], 'GetWorkflowExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowStepExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowStepExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'HttpPutResponseHopLimit' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataOptions$httpPutResponseHopLimit' => 'Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.
', ], ], 'HttpTokens' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataOptions$httpTokens' => 'Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:
required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.
optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.
The default setting is optional.
', ], ], 'IdempotentParameterMismatchException' => [ 'base' => 'You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
', 'refs' => [], ], 'Image' => [ 'base' => 'An Image Builder image. You must specify exactly one recipe for the image – either a container recipe (containerRecipe), which creates a container image, or an image recipe (imageRecipe), which creates an AMI.
The image object.
', ], ], 'ImageAggregation' => [ 'base' => 'Contains vulnerability counts for a specific image.
', 'refs' => [ 'ImageScanFindingAggregation$imageAggregation' => 'Returns an object that contains severity counts based on the Amazon Resource Name (ARN) for a specific image.
', ], ], 'ImageBuildMessage' => [ 'base' => NULL, 'refs' => [ 'ListWorkflowExecutionsResponse$message' => 'The output message from the list action, if applicable.
', 'ListWorkflowStepExecutionsResponse$message' => 'The output message from the list action, if applicable.
', ], ], 'ImageBuildVersionArn' => [ 'base' => NULL, 'refs' => [ 'CancelImageCreationRequest$imageBuildVersionArn' => 'The Amazon Resource Name (ARN) of the image that you want to cancel creation for.
', 'CancelImageCreationResponse$imageBuildVersionArn' => 'The ARN of the image whose creation this request canceled.
', 'CreateImageResponse$imageBuildVersionArn' => 'The Amazon Resource Name (ARN) of the image that this request created.
', 'DeleteImageRequest$imageBuildVersionArn' => 'The Amazon Resource Name (ARN) of the Image Builder image resource to delete.
', 'DeleteImageResponse$imageBuildVersionArn' => 'The ARN of the Image Builder image resource that this request deleted.
', 'GetImagePolicyRequest$imageArn' => 'The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.
', 'GetWorkflowExecutionResponse$imageBuildVersionArn' => 'The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow created.
', 'GetWorkflowStepExecutionResponse$imageBuildVersionArn' => 'The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates.
', 'ImageAggregation$imageBuildVersionArn' => 'The Amazon Resource Name (ARN) that identifies the image for this aggregation.
', 'ImageScanFinding$imageBuildVersionArn' => 'The Amazon Resource Name (ARN) of the image build version that\'s associated with the finding.
', 'ListImagePackagesRequest$imageBuildVersionArn' => 'Filter results for the ListImagePackages request by the Image Build Version ARN
', 'ListWorkflowExecutionsRequest$imageBuildVersionArn' => 'List all workflow runtime instances for the specified image build version resource ARN.
', 'ListWorkflowExecutionsResponse$imageBuildVersionArn' => 'The resource ARN of the image build version for which you requested a list of workflow runtime details.
', 'ListWorkflowStepExecutionsResponse$imageBuildVersionArn' => 'The image build version resource ARN that\'s associated with the specified runtime instance of the workflow.
', 'PutImagePolicyRequest$imageArn' => 'The Amazon Resource Name (ARN) of the image that this policy should be applied to.
', 'PutImagePolicyResponse$imageArn' => 'The Amazon Resource Name (ARN) of the image that this policy was applied to.
', 'StartImagePipelineExecutionResponse$imageBuildVersionArn' => 'The Amazon Resource Name (ARN) of the image that was created by this request.
', ], ], 'ImageBuilderArn' => [ 'base' => NULL, 'refs' => [ 'Component$arn' => 'The Amazon Resource Name (ARN) of the component.
', 'ComponentSummary$arn' => 'The Amazon Resource Name (ARN) of the component.
', 'ComponentVersion$arn' => 'The Amazon Resource Name (ARN) of the component.
Semantic versioning is included in each object\'s Amazon Resource Name (ARN), at the level that applies to that object as follows:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
The Amazon Resource Name (ARN) of the container recipe.
Semantic versioning is included in each object\'s Amazon Resource Name (ARN), at the level that applies to that object as follows:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
The Amazon Resource Name (ARN) of the container recipe.
', 'DistributionConfiguration$arn' => 'The Amazon Resource Name (ARN) of the distribution configuration.
', 'DistributionConfigurationSummary$arn' => 'The Amazon Resource Name (ARN) of the distribution configuration.
', 'Image$arn' => 'The Amazon Resource Name (ARN) of the image.
Semantic versioning is included in each object\'s Amazon Resource Name (ARN), at the level that applies to that object as follows:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
The Amazon Resource Name (ARN) of the image pipeline.
', 'ImageRecipe$arn' => 'The Amazon Resource Name (ARN) of the image recipe.
', 'ImageRecipeSummary$arn' => 'The Amazon Resource Name (ARN) of the image recipe.
', 'ImageSummary$arn' => 'The Amazon Resource Name (ARN) of the image.
', 'ImageVersion$arn' => 'The Amazon Resource Name (ARN) of a specific version of an Image Builder image.
Semantic versioning is included in each object\'s Amazon Resource Name (ARN), at the level that applies to that object as follows:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
The Amazon Resource Name (ARN) of the infrastructure configuration.
', 'InfrastructureConfigurationSummary$arn' => 'The Amazon Resource Name (ARN) of the infrastructure configuration.
', 'ListTagsForResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
', 'TagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource that you want to tag.
', 'UntagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource that you want to untag.
', ], ], 'ImagePackage' => [ 'base' => 'Represents a package installed on an Image Builder image.
', 'refs' => [ 'ImagePackageList$member' => NULL, ], ], 'ImagePackageList' => [ 'base' => NULL, 'refs' => [ 'ListImagePackagesResponse$imagePackageList' => 'The list of Image Packages returned in the response.
', ], ], 'ImagePipeline' => [ 'base' => 'Details of an image pipeline.
', 'refs' => [ 'GetImagePipelineResponse$imagePipeline' => 'The image pipeline object.
', 'ImagePipelineList$member' => NULL, ], ], 'ImagePipelineAggregation' => [ 'base' => 'Contains vulnerability counts for a specific image pipeline.
', 'refs' => [ 'ImageScanFindingAggregation$imagePipelineAggregation' => 'Returns an object that contains severity counts based on an image pipeline ARN.
', ], ], 'ImagePipelineArn' => [ 'base' => NULL, 'refs' => [ 'CreateImagePipelineResponse$imagePipelineArn' => 'The Amazon Resource Name (ARN) of the image pipeline that was created by this request.
', 'DeleteImagePipelineRequest$imagePipelineArn' => 'The Amazon Resource Name (ARN) of the image pipeline to delete.
', 'DeleteImagePipelineResponse$imagePipelineArn' => 'The Amazon Resource Name (ARN) of the image pipeline that was deleted.
', 'GetImagePipelineRequest$imagePipelineArn' => 'The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.
', 'ImagePipelineAggregation$imagePipelineArn' => 'The Amazon Resource Name (ARN) that identifies the image pipeline for this aggregation.
', 'ImageScanFinding$imagePipelineArn' => 'The Amazon Resource Name (ARN) of the image pipeline that\'s associated with the finding.
', 'ListImagePipelineImagesRequest$imagePipelineArn' => 'The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.
', 'StartImagePipelineExecutionRequest$imagePipelineArn' => 'The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.
', 'UpdateImagePipelineRequest$imagePipelineArn' => 'The Amazon Resource Name (ARN) of the image pipeline that you want to update.
', 'UpdateImagePipelineResponse$imagePipelineArn' => 'The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.
', ], ], 'ImagePipelineList' => [ 'base' => NULL, 'refs' => [ 'ListImagePipelinesResponse$imagePipelineList' => 'The list of image pipelines.
', ], ], 'ImageRecipe' => [ 'base' => 'An image recipe.
', 'refs' => [ 'GetImageRecipeResponse$imageRecipe' => 'The image recipe object.
', 'Image$imageRecipe' => 'For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.
', ], ], 'ImageRecipeArn' => [ 'base' => NULL, 'refs' => [ 'CreateImagePipelineRequest$imageRecipeArn' => 'The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.
', 'CreateImageRecipeResponse$imageRecipeArn' => 'The Amazon Resource Name (ARN) of the image recipe that was created by this request.
', 'CreateImageRequest$imageRecipeArn' => 'The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
', 'DeleteImageRecipeRequest$imageRecipeArn' => 'The Amazon Resource Name (ARN) of the image recipe to delete.
', 'DeleteImageRecipeResponse$imageRecipeArn' => 'The Amazon Resource Name (ARN) of the image recipe that was deleted.
', 'GetImageRecipePolicyRequest$imageRecipeArn' => 'The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve.
', 'GetImageRecipeRequest$imageRecipeArn' => 'The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.
', 'PutImageRecipePolicyRequest$imageRecipeArn' => 'The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.
', 'PutImageRecipePolicyResponse$imageRecipeArn' => 'The Amazon Resource Name (ARN) of the image recipe that this policy was applied to.
', 'UpdateImagePipelineRequest$imageRecipeArn' => 'The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
', ], ], 'ImageRecipeSummary' => [ 'base' => 'A summary of an image recipe.
', 'refs' => [ 'ImageRecipeSummaryList$member' => NULL, ], ], 'ImageRecipeSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListImageRecipesResponse$imageRecipeSummaryList' => 'The list of image pipelines.
', ], ], 'ImageScanFinding' => [ 'base' => 'Contains details about a vulnerability scan finding.
', 'refs' => [ 'ImageScanFindingsList$member' => NULL, ], ], 'ImageScanFindingAggregation' => [ 'base' => 'This returns exactly one type of aggregation, based on the filter that Image Builder applies in its API action.
', 'refs' => [ 'ImageScanFindingAggregationsList$member' => NULL, ], ], 'ImageScanFindingAggregationsList' => [ 'base' => NULL, 'refs' => [ 'ListImageScanFindingAggregationsResponse$responses' => 'An array of image scan finding aggregations that match the filter criteria.
', ], ], 'ImageScanFindingsFilter' => [ 'base' => 'A name value pair that Image Builder applies to streamline results from the vulnerability scan findings list action.
', 'refs' => [ 'ImageScanFindingsFilterList$member' => NULL, ], ], 'ImageScanFindingsFilterList' => [ 'base' => NULL, 'refs' => [ 'ListImageScanFindingsRequest$filters' => 'An array of name value pairs that you can use to filter your results. You can use the following filters to streamline results:
imageBuildVersionArn
imagePipelineArn
vulnerabilityId
severity
If you don\'t request a filter, then all findings in your account are listed.
', ], ], 'ImageScanFindingsFilterValues' => [ 'base' => NULL, 'refs' => [ 'ImageScanFindingsFilter$values' => 'The filter values. Filter values are case-sensitive.
', ], ], 'ImageScanFindingsList' => [ 'base' => NULL, 'refs' => [ 'ListImageScanFindingsResponse$findings' => 'The image scan findings for your account that meet your request filter criteria.
', ], ], 'ImageScanState' => [ 'base' => 'Shows the vulnerability scan status for a specific image, and the reason for that status.
', 'refs' => [ 'Image$scanState' => 'Contains information about the current state of scans for this image.
', ], ], 'ImageScanStatus' => [ 'base' => NULL, 'refs' => [ 'ImageScanState$status' => 'The current state of vulnerability scans for the image.
', ], ], 'ImageScanningConfiguration' => [ 'base' => 'Contains settings for Image Builder image resource and container image scans.
', 'refs' => [ 'CreateImagePipelineRequest$imageScanningConfiguration' => 'Contains settings for vulnerability scans.
', 'CreateImageRequest$imageScanningConfiguration' => 'Contains settings for vulnerability scans.
', 'Image$imageScanningConfiguration' => 'Contains settings for vulnerability scans.
', 'ImagePipeline$imageScanningConfiguration' => 'Contains settings for vulnerability scans.
', 'UpdateImagePipelineRequest$imageScanningConfiguration' => 'Contains settings for vulnerability scans.
', ], ], 'ImageSource' => [ 'base' => NULL, 'refs' => [ 'Image$imageSource' => 'The origin of the base image that Image Builder used to build this image.
', 'ImageSummary$imageSource' => 'The origin of the base image that Image Builder used to build this image.
', 'ImageVersion$imageSource' => 'The origin of the base image that Image Builder used to build this image.
', ], ], 'ImageState' => [ 'base' => 'Image status and the reason for that status.
', 'refs' => [ 'Ami$state' => NULL, 'Image$state' => 'The state of the image.
', 'ImageSummary$state' => 'The state of the image.
', ], ], 'ImageStatus' => [ 'base' => NULL, 'refs' => [ 'ImageState$status' => 'The status of the image.
', ], ], 'ImageSummary' => [ 'base' => 'An image summary.
', 'refs' => [ 'ImageSummaryList$member' => NULL, ], ], 'ImageSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListImageBuildVersionsResponse$imageSummaryList' => 'The list of image build versions.
', 'ListImagePipelineImagesResponse$imageSummaryList' => 'The list of images built by this pipeline.
', ], ], 'ImageTestsConfiguration' => [ 'base' => 'Configure image tests for your pipeline build. Tests run after building the image, to verify that the AMI or container image is valid before distributing it.
', 'refs' => [ 'CreateImagePipelineRequest$imageTestsConfiguration' => 'The image test configuration of the image pipeline.
', 'CreateImageRequest$imageTestsConfiguration' => 'The image tests configuration of the image.
', 'Image$imageTestsConfiguration' => 'The image tests that ran when that Image Builder created this image.
', 'ImagePipeline$imageTestsConfiguration' => 'The image tests configuration of the image pipeline.
', 'UpdateImagePipelineRequest$imageTestsConfiguration' => 'The image test configuration of the image pipeline.
', ], ], 'ImageTestsTimeoutMinutes' => [ 'base' => NULL, 'refs' => [ 'ImageTestsConfiguration$timeoutMinutes' => 'The maximum time in minutes that tests are permitted to run.
The timeoutMinutes attribute is not currently active. This value is ignored.
Specifies whether this image produces an AMI or a container image.
', 'ImageRecipe$type' => 'Specifies which type of image is created by the recipe - an AMI or a container image.
', 'ImageSummary$type' => 'Specifies whether this image produces an AMI or a container image.
', 'ImageVersion$type' => 'Specifies whether this image produces an AMI or a container image.
', ], ], 'ImageVersion' => [ 'base' => 'The defining characteristics of a specific version of an Image Builder image.
', 'refs' => [ 'ImageVersionList$member' => NULL, ], ], 'ImageVersionArn' => [ 'base' => NULL, 'refs' => [ 'ListImageBuildVersionsRequest$imageVersionArn' => 'The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve.
', ], ], 'ImageVersionArnOrBuildVersionArn' => [ 'base' => NULL, 'refs' => [ 'GetImageRequest$imageBuildVersionArn' => 'The Amazon Resource Name (ARN) of the image that you want to get.
', ], ], 'ImageVersionList' => [ 'base' => NULL, 'refs' => [ 'ListImagesResponse$imageVersionList' => 'The list of image semantic versions.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
Details of the infrastructure configuration.
', 'refs' => [ 'GetInfrastructureConfigurationResponse$infrastructureConfiguration' => 'The infrastructure configuration object.
', 'Image$infrastructureConfiguration' => 'The infrastructure that Image Builder used to create this image.
', ], ], 'InfrastructureConfigurationArn' => [ 'base' => NULL, 'refs' => [ 'CreateImagePipelineRequest$infrastructureConfigurationArn' => 'The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.
', 'CreateImageRequest$infrastructureConfigurationArn' => 'The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
', 'CreateInfrastructureConfigurationResponse$infrastructureConfigurationArn' => 'The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.
', 'DeleteInfrastructureConfigurationRequest$infrastructureConfigurationArn' => 'The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
', 'DeleteInfrastructureConfigurationResponse$infrastructureConfigurationArn' => 'The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.
', 'GetInfrastructureConfigurationRequest$infrastructureConfigurationArn' => 'The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.
', 'UpdateImagePipelineRequest$infrastructureConfigurationArn' => 'The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.
', 'UpdateInfrastructureConfigurationRequest$infrastructureConfigurationArn' => 'The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
', 'UpdateInfrastructureConfigurationResponse$infrastructureConfigurationArn' => 'The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.
', ], ], 'InfrastructureConfigurationSummary' => [ 'base' => 'The infrastructure used when building Amazon EC2 AMIs.
', 'refs' => [ 'InfrastructureConfigurationSummaryList$member' => NULL, ], ], 'InfrastructureConfigurationSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListInfrastructureConfigurationsResponse$infrastructureConfigurationSummaryList' => 'The list of infrastructure configurations.
', ], ], 'InlineComponentData' => [ 'base' => NULL, 'refs' => [ 'CreateComponentRequest$data' => 'Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
The Dockerfile template used to build your image as an inline data blob.
', ], ], 'InspectorScoreDetails' => [ 'base' => 'Information about the factors that influenced the score that Amazon Inspector assigned for a finding.
', 'refs' => [ 'ImageScanFinding$inspectorScoreDetails' => 'An object that contains details of the Amazon Inspector score.
', ], ], 'InstanceBlockDeviceMapping' => [ 'base' => 'Defines block device mappings for the instance used to configure your image.
', 'refs' => [ 'InstanceBlockDeviceMappings$member' => NULL, ], ], 'InstanceBlockDeviceMappings' => [ 'base' => NULL, 'refs' => [ 'CreateImageRecipeRequest$blockDeviceMappings' => 'The block device mappings of the image recipe.
', 'ImageRecipe$blockDeviceMappings' => 'The block device mappings to apply when creating images from this recipe.
', 'InstanceConfiguration$blockDeviceMappings' => 'Defines the block devices to attach for building an instance from this Image Builder AMI.
', ], ], 'InstanceConfiguration' => [ 'base' => 'Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.
', 'refs' => [ 'ContainerRecipe$instanceConfiguration' => 'A group of options that can be used to configure an instance for building and testing container images.
', 'CreateContainerRecipeRequest$instanceConfiguration' => 'A group of options that can be used to configure an instance for building and testing container images.
', ], ], 'InstanceMetadataOptions' => [ 'base' => 'The instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances, or Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.
', 'refs' => [ 'CreateInfrastructureConfigurationRequest$instanceMetadataOptions' => 'The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.
', 'InfrastructureConfiguration$instanceMetadataOptions' => 'The instance metadata option settings for the infrastructure configuration.
', 'UpdateInfrastructureConfigurationRequest$instanceMetadataOptions' => 'The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see one of the following links:
Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances.
Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.
The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
', 'InfrastructureConfiguration$instanceProfileName' => 'The instance profile of the infrastructure configuration.
', 'InfrastructureConfigurationSummary$instanceProfileName' => 'The instance profile of the infrastructure configuration.
', 'UpdateInfrastructureConfigurationRequest$instanceProfileName' => 'The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
', ], ], 'InstanceType' => [ 'base' => NULL, 'refs' => [ 'InstanceTypeList$member' => NULL, ], ], 'InstanceTypeList' => [ 'base' => NULL, 'refs' => [ 'CreateInfrastructureConfigurationRequest$instanceTypes' => 'The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.
', 'InfrastructureConfiguration$instanceTypes' => 'The instance types of the infrastructure configuration.
', 'InfrastructureConfigurationSummary$instanceTypes' => 'The instance types of the infrastructure configuration.
', 'UpdateInfrastructureConfigurationRequest$instanceTypes' => 'The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.
', ], ], 'InvalidPaginationTokenException' => [ 'base' => 'You have provided an invalid pagination token in your request.
', 'refs' => [], ], 'InvalidParameterCombinationException' => [ 'base' => 'You have specified two or more mutually exclusive parameters. Review the error message for details.
', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => 'The specified parameter is invalid. Review the available parameters for the API request.
', 'refs' => [], ], 'InvalidParameterValueException' => [ 'base' => 'The value that you provided for the specified parameter is invalid.
', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => 'You have requested an action that that the service doesn\'t support.
', 'refs' => [], ], 'InvalidVersionNumberException' => [ 'base' => 'Your version number is out of bounds or does not follow the required syntax.
', 'refs' => [], ], 'LaunchPermissionConfiguration' => [ 'base' => 'Describes the configuration for a launch permission. The launch permission modification request is sent to the Amazon EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to all. See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute.
Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
', ], ], 'LaunchTemplateConfiguration' => [ 'base' => 'Identifies an Amazon EC2 launch template to use for a specific account.
', 'refs' => [ 'LaunchTemplateConfigurationList$member' => NULL, ], ], 'LaunchTemplateConfigurationList' => [ 'base' => NULL, 'refs' => [ 'Distribution$launchTemplateConfigurations' => 'A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.
', ], ], 'LaunchTemplateId' => [ 'base' => NULL, 'refs' => [ 'FastLaunchLaunchTemplateSpecification$launchTemplateId' => 'The ID of the launch template to use for faster launching for a Windows AMI.
', 'LaunchTemplateConfiguration$launchTemplateId' => 'Identifies the Amazon EC2 launch template to use.
', ], ], 'LicenseConfigurationArn' => [ 'base' => NULL, 'refs' => [ 'LicenseConfigurationArnList$member' => NULL, ], ], 'LicenseConfigurationArnList' => [ 'base' => NULL, 'refs' => [ 'Distribution$licenseConfigurationArns' => 'The License Manager Configuration to associate with the AMI in the specified Region.
', ], ], 'ListComponentBuildVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListComponentBuildVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListComponentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListComponentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerRecipesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerRecipesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDistributionConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDistributionConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImageBuildVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImageBuildVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImagePackagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImagePackagesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImagePipelineImagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImagePipelineImagesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImagePipelinesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImagePipelinesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImageRecipesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImageRecipesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImageScanFindingAggregationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImageScanFindingAggregationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImageScanFindingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImageScanFindingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImagesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInfrastructureConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInfrastructureConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowStepExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowStepExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Logging' => [ 'base' => 'Logging configuration defines where Image Builder uploads your logs.
', 'refs' => [ 'CreateInfrastructureConfigurationRequest$logging' => 'The logging configuration of the infrastructure configuration.
', 'InfrastructureConfiguration$logging' => 'The logging configuration of the infrastructure configuration.
', 'UpdateInfrastructureConfigurationRequest$logging' => 'The logging configuration of the infrastructure configuration.
', ], ], 'MaxParallelLaunches' => [ 'base' => NULL, 'refs' => [ 'FastLaunchConfiguration$maxParallelLaunches' => 'The maximum number of parallel instances that are launched for creating resources.
', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'AccountAggregation$accountId' => 'Identifies the account that owns the aggregated resource findings.
', 'Ami$region' => 'The Amazon Web Services Region of the Amazon EC2 AMI.
', 'Ami$image' => 'The AMI ID of the Amazon EC2 AMI.
', 'Ami$name' => 'The name of the Amazon EC2 AMI.
', 'Ami$description' => 'The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.
', 'Ami$accountId' => 'The account ID of the owner of the AMI.
', 'AmiDistributionConfiguration$description' => 'The description of the AMI distribution configuration. Minimum and maximum length are in characters.
', 'AmiDistributionConfiguration$kmsKeyId' => 'The KMS key identifier used to encrypt the distributed image.
', 'CancelImageCreationResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'Component$description' => 'The description of the component.
', 'Component$changeDescription' => 'The change description of the component.
', 'Component$owner' => 'The owner of the component.
', 'Component$kmsKeyId' => 'The KMS key identifier used to encrypt the component.
', 'Component$publisher' => 'Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
', 'ComponentState$reason' => 'Describes how or why the component changed state.
', 'ComponentSummary$owner' => 'The owner of the component.
', 'ComponentSummary$description' => 'The description of the component.
', 'ComponentSummary$changeDescription' => 'The change description for the current version of the component.
', 'ComponentSummary$publisher' => 'Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
', 'ComponentVersion$description' => 'The description of the component.
', 'ComponentVersion$owner' => 'The owner of the component.
', 'Container$region' => 'Containers and container images are Region-specific. This is the Region context for the container.
', 'ContainerDistributionConfiguration$description' => 'The description of the container distribution configuration.
', 'ContainerRecipe$description' => 'The description of the container recipe.
', 'ContainerRecipe$owner' => 'The owner of the container recipe.
', 'ContainerRecipe$kmsKeyId' => 'Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
', 'ContainerRecipe$parentImage' => 'The base image for the container recipe.
', 'ContainerRecipe$workingDirectory' => 'The working directory for use during build and test workflows.
', 'ContainerRecipeSummary$owner' => 'The owner of the container recipe.
', 'ContainerRecipeSummary$parentImage' => 'The base image for the container recipe.
', 'CreateComponentRequest$description' => 'Describes the contents of the component.
', 'CreateComponentRequest$changeDescription' => 'The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.
', 'CreateComponentRequest$kmsKeyId' => 'The ID of the KMS key that is used to encrypt this component.
', 'CreateComponentResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'CreateContainerRecipeRequest$description' => 'The description of the container recipe.
', 'CreateContainerRecipeRequest$imageOsVersionOverride' => 'Specifies the operating system version for the base image.
', 'CreateContainerRecipeRequest$parentImage' => 'The base image for the container recipe.
', 'CreateContainerRecipeRequest$workingDirectory' => 'The working directory for use during build and test workflows.
', 'CreateContainerRecipeRequest$kmsKeyId' => 'Identifies which KMS key is used to encrypt the container image.
', 'CreateContainerRecipeResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'CreateDistributionConfigurationRequest$description' => 'The description of the distribution configuration.
', 'CreateDistributionConfigurationResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'CreateImagePipelineRequest$description' => 'The description of the image pipeline.
', 'CreateImagePipelineResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'CreateImageRecipeRequest$description' => 'The description of the image recipe.
', 'CreateImageRecipeRequest$parentImage' => 'The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.
The working directory used during build and test workflows.
', 'CreateImageRecipeResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'CreateImageResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'CreateInfrastructureConfigurationRequest$description' => 'The description of the infrastructure configuration.
', 'CreateInfrastructureConfigurationRequest$subnetId' => 'The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.
', 'CreateInfrastructureConfigurationRequest$keyPair' => 'The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.
', 'CreateInfrastructureConfigurationResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'CvssScore$scoringVector' => 'The vector string of the CVSS score.
', 'CvssScore$version' => 'The CVSS version that generated the score.
', 'CvssScore$source' => 'The source of the CVSS score.
', 'CvssScoreAdjustment$metric' => 'The metric that Amazon Inspector used to adjust the CVSS score.
', 'CvssScoreAdjustment$reason' => 'The reason for the CVSS score adjustment.
', 'CvssScoreDetails$scoreSource' => 'The source for the CVSS score.
', 'CvssScoreDetails$cvssSource' => 'The source of the finding.
', 'CvssScoreDetails$version' => 'The CVSS version that generated the score.
', 'CvssScoreDetails$scoringVector' => 'A vector that measures the severity of the vulnerability.
', 'DeleteComponentResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'DeleteContainerRecipeResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'DeleteDistributionConfigurationResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'DeleteImagePipelineResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'DeleteImageRecipeResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'DeleteImageResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'DeleteInfrastructureConfigurationResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'Distribution$region' => 'The target Region.
', 'DistributionConfiguration$description' => 'The description of the distribution configuration.
', 'DistributionConfigurationSummary$description' => 'The description of the distribution configuration.
', 'EbsInstanceBlockDeviceSpecification$kmsKeyId' => 'Use to configure the KMS key to use when encrypting the device.
', 'EbsInstanceBlockDeviceSpecification$snapshotId' => 'The snapshot that defines the device contents.
', 'EcrConfiguration$repositoryName' => 'The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.
The name of the launch template to use for faster launching for a Windows AMI.
', 'FastLaunchLaunchTemplateSpecification$launchTemplateVersion' => 'The version of the launch template to use for faster launching for a Windows AMI.
', 'GetComponentPolicyResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'GetComponentResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'GetContainerRecipePolicyResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'GetContainerRecipeResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'GetDistributionConfigurationResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'GetImagePipelineResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'GetImagePolicyResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'GetImageRecipePolicyResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'GetImageRecipeResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'GetImageResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'GetInfrastructureConfigurationResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'GetWorkflowExecutionResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'GetWorkflowStepExecutionResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'GetWorkflowStepExecutionResponse$onFailure' => 'The action to perform if the workflow step fails.
', 'ImagePackage$packageName' => 'The name of the package as reported to the operating system package manager.
', 'ImagePackage$packageVersion' => 'The version of the package as reported to the operating system package manager.
', 'ImagePipeline$description' => 'The description of the image pipeline.
', 'ImageRecipe$description' => 'The description of the image recipe.
', 'ImageRecipe$owner' => 'The owner of the image recipe.
', 'ImageRecipe$parentImage' => 'The base image of the image recipe.
', 'ImageRecipe$workingDirectory' => 'The working directory to be used during build and test workflows.
', 'ImageRecipeSummary$owner' => 'The owner of the image recipe.
', 'ImageRecipeSummary$parentImage' => 'The base image of the image recipe.
', 'ImageScanFinding$awsAccountId' => 'The Amazon Web Services account ID that\'s associated with the finding.
', 'ImageScanFinding$type' => 'The type of the finding. Image Builder looks for findings of the type PACKAGE_VULNERABILITY that apply to output images, and excludes other types.
The description of the finding.
', 'ImageScanFinding$title' => 'The title of the finding.
', 'ImageScanFinding$severity' => 'The severity of the finding.
', 'ImageScanFinding$fixAvailable' => 'Details about whether a fix is available for any of the packages that are identified in the finding through a version update.
', 'ImageScanState$reason' => 'The reason for the scan status for the image.
', 'ImageState$reason' => 'The reason for the status of the image.
', 'ImageSummary$owner' => 'The owner of the image.
', 'ImageVersion$owner' => 'The owner of the image version.
', 'ImportComponentRequest$description' => 'The description of the component. Describes the contents of the component.
', 'ImportComponentRequest$changeDescription' => 'The change description of the component. This description indicates the change that has been made in this version, or what makes this version different from other versions of this component.
', 'ImportComponentRequest$data' => 'The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.
The ID of the KMS key that should be used to encrypt this component.
', 'ImportComponentResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ImportVmImageRequest$name' => 'The name of the base image that is created by the import process.
', 'ImportVmImageRequest$description' => 'The description for the base image that is created by the import process.
', 'ImportVmImageRequest$vmImportTaskId' => 'The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.
The request ID that uniquely identifies this request.
', 'InfrastructureConfiguration$description' => 'The description of the infrastructure configuration.
', 'InfrastructureConfiguration$subnetId' => 'The subnet ID of the infrastructure configuration.
', 'InfrastructureConfiguration$keyPair' => 'The Amazon EC2 key pair of the infrastructure configuration.
', 'InfrastructureConfiguration$snsTopicArn' => 'The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.
The description of the infrastructure configuration.
', 'InstanceBlockDeviceMapping$deviceName' => 'The device to which these mappings apply.
', 'InstanceBlockDeviceMapping$virtualName' => 'Use to manage instance ephemeral devices.
', 'InstanceConfiguration$image' => 'The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.
', 'ListComponentBuildVersionsResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ListComponentsResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ListContainerRecipesRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListContainerRecipesResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ListContainerRecipesResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', 'ListDistributionConfigurationsResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ListImageBuildVersionsResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ListImagePackagesResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ListImagePipelineImagesResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ListImagePipelinesResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ListImageRecipesResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ListImageScanFindingAggregationsResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ListImageScanFindingAggregationsResponse$aggregationType' => 'The aggregation type specifies what type of key is used to group the image scan findings. Image Builder returns results based on the request filter. If you didn\'t specify a filter in the request, the type defaults to accountId.
Aggregation types
accountId
imageBuildVersionArn
imagePipelineArn
vulnerabilityId
Each aggregation includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for each key value.
', 'ListImageScanFindingsResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ListImagesResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ListInfrastructureConfigurationsResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ListWorkflowExecutionsResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'ListWorkflowStepExecutionsResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'NonEmptyStringList$member' => NULL, 'PackageVulnerabilityDetails$source' => 'The source of the vulnerability information.
', 'PackageVulnerabilityDetails$sourceUrl' => 'A link to the source of the vulnerability information.
', 'PackageVulnerabilityDetails$vendorSeverity' => 'The severity that the vendor assigned to this vulnerability type.
', 'PutComponentPolicyResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'PutContainerRecipePolicyResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'PutImagePolicyResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'PutImageRecipePolicyResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'RegionList$member' => NULL, 'RemediationRecommendation$text' => 'The recommended course of action to remediate the finding.
', 'RemediationRecommendation$url' => 'A link to more information about the recommended remediation for this vulnerability.
', 'S3ExportConfiguration$roleName' => 'The name of the role that grants VM Import/Export permission to export images to your S3 bucket.
', 'S3ExportConfiguration$s3Bucket' => 'The S3 bucket in which to store the output disk images for your VM.
', 'S3ExportConfiguration$s3Prefix' => 'The Amazon S3 path for the bucket where the output disk images for your VM are stored.
', 'S3Logs$s3BucketName' => 'The S3 bucket in which to store the logs.
', 'S3Logs$s3KeyPrefix' => 'The Amazon S3 path to the bucket where the logs are stored.
', 'Schedule$scheduleExpression' => 'The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.
', 'SecurityGroupIds$member' => NULL, 'StartImagePipelineExecutionResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'StringList$member' => NULL, 'TargetContainerRepository$repositoryName' => 'The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
', 'UpdateDistributionConfigurationRequest$description' => 'The description of the distribution configuration.
', 'UpdateDistributionConfigurationResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'UpdateImagePipelineRequest$description' => 'The description of the image pipeline.
', 'UpdateImagePipelineResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'UpdateInfrastructureConfigurationRequest$description' => 'The description of the infrastructure configuration.
', 'UpdateInfrastructureConfigurationRequest$subnetId' => 'The subnet ID to place the instance used to customize your Amazon EC2 AMI in.
', 'UpdateInfrastructureConfigurationRequest$keyPair' => 'The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.
', 'UpdateInfrastructureConfigurationResponse$requestId' => 'The request ID that uniquely identifies this request.
', 'VulnerabilityIdAggregation$vulnerabilityId' => 'The vulnerability Id for this set of counts.
', 'VulnerablePackage$name' => 'The name of the vulnerable package.
', 'VulnerablePackage$version' => 'The version of the vulnerable package.
', 'VulnerablePackage$release' => 'The release of the vulnerable package.
', 'VulnerablePackage$packageManager' => 'The package manager of the vulnerable package.
', 'VulnerablePackage$filePath' => 'The file path of the vulnerable package.
', 'VulnerablePackage$fixedInVersion' => 'The version of the package that contains the vulnerability fix.
', 'VulnerablePackage$remediation' => 'The code to run in your environment to update packages with a fix available.
', ], ], 'NonEmptyStringList' => [ 'base' => NULL, 'refs' => [ 'PackageVulnerabilityDetails$referenceUrls' => 'Links to web pages that contain details about the vulnerabilities that Amazon Inspector identified for the package.
', ], ], 'NonNegativeDouble' => [ 'base' => NULL, 'refs' => [ 'CvssScore$baseScore' => 'The CVSS base score.
', 'CvssScoreDetails$score' => 'The CVSS score.
', 'ImageScanFinding$inspectorScore' => 'The score that Amazon Inspector assigned for the finding.
', ], ], 'NullableBoolean' => [ 'base' => NULL, 'refs' => [ 'Component$encrypted' => 'The encryption status of the component.
', 'ContainerRecipe$encrypted' => 'A flag that indicates if the target container is encrypted.
', 'CreateImagePipelineRequest$enhancedImageMetadataEnabled' => 'Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
', 'CreateImageRequest$enhancedImageMetadataEnabled' => 'Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
', 'CreateInfrastructureConfigurationRequest$terminateInstanceOnFailure' => 'The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.
', 'EbsInstanceBlockDeviceSpecification$encrypted' => 'Use to configure device encryption.
', 'EbsInstanceBlockDeviceSpecification$deleteOnTermination' => 'Use to configure delete on termination of the associated device.
', 'Image$enhancedImageMetadataEnabled' => 'Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
', 'ImagePipeline$enhancedImageMetadataEnabled' => 'Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
', 'ImageScanningConfiguration$imageScanningEnabled' => 'A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
', 'ImageTestsConfiguration$imageTestsEnabled' => 'Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.
', 'InfrastructureConfiguration$terminateInstanceOnFailure' => 'The terminate instance on failure configuration of the infrastructure configuration.
', 'ListImagesRequest$includeDeprecated' => 'Includes deprecated images in the response list.
', 'SystemsManagerAgent$uninstallAfterBuild' => 'Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it\'s set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
', 'UpdateImagePipelineRequest$enhancedImageMetadataEnabled' => 'Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
', 'UpdateInfrastructureConfigurationRequest$terminateInstanceOnFailure' => 'The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.
', ], ], 'OrganizationArn' => [ 'base' => NULL, 'refs' => [ 'OrganizationArnList$member' => NULL, ], ], 'OrganizationArnList' => [ 'base' => NULL, 'refs' => [ 'LaunchPermissionConfiguration$organizationArns' => 'The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?.
', ], ], 'OrganizationalUnitArn' => [ 'base' => NULL, 'refs' => [ 'OrganizationalUnitArnList$member' => NULL, ], ], 'OrganizationalUnitArnList' => [ 'base' => NULL, 'refs' => [ 'LaunchPermissionConfiguration$organizationalUnitArns' => 'The ARN for an Organizations organizational unit (OU) that you want to share your AMI with. For more information about key concepts for Organizations, see Organizations terminology and concepts.
', ], ], 'OsVersion' => [ 'base' => NULL, 'refs' => [ 'Image$osVersion' => 'The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
', 'ImageSummary$osVersion' => 'The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
', 'ImageVersion$osVersion' => 'The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
', 'ImportVmImageRequest$osVersion' => 'The operating system version for the imported VM.
', 'OsVersionList$member' => NULL, ], ], 'OsVersionList' => [ 'base' => NULL, 'refs' => [ 'Component$supportedOsVersions' => 'The operating system (OS) version supported by the component. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.
', 'ComponentSummary$supportedOsVersions' => 'The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.
', 'ComponentVersion$supportedOsVersions' => 'he operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
', 'CreateComponentRequest$supportedOsVersions' => 'The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
', ], ], 'OutputResources' => [ 'base' => 'The resources produced by this image.
', 'refs' => [ 'Image$outputResources' => 'The output resources that Image Builder produces for this image.
', 'ImageSummary$outputResources' => 'The output resources that Image Builder produced when it created this image.
', ], ], 'Ownership' => [ 'base' => NULL, 'refs' => [ 'ListComponentsRequest$owner' => 'Filters results based on the type of owner for the component. By default, this request returns a list of components that your account owns. To see results for other types of owners, you can specify components that Amazon manages, third party components, or components that other accounts have shared with you.
', 'ListContainerRecipesRequest$owner' => 'Returns container recipes belonging to the specified owner, that have been shared with you. You can omit this field to return container recipes belonging to your account.
', 'ListImageRecipesRequest$owner' => 'The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.
', 'ListImagesRequest$owner' => 'The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.
', ], ], 'PackageArchitecture' => [ 'base' => NULL, 'refs' => [ 'VulnerablePackage$arch' => 'The architecture of the vulnerable package.
', ], ], 'PackageEpoch' => [ 'base' => NULL, 'refs' => [ 'VulnerablePackage$epoch' => 'The epoch of the vulnerable package.
', ], ], 'PackageVulnerabilityDetails' => [ 'base' => 'Information about package vulnerability findings.
', 'refs' => [ 'ImageScanFinding$packageVulnerabilityDetails' => 'An object that contains the details of a package vulnerability finding.
', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListComponentBuildVersionsRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListComponentBuildVersionsResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', 'ListComponentsRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListComponentsResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', 'ListDistributionConfigurationsRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListDistributionConfigurationsResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', 'ListImageBuildVersionsRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListImageBuildVersionsResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', 'ListImagePackagesRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListImagePackagesResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', 'ListImagePipelineImagesRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListImagePipelineImagesResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', 'ListImagePipelinesRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListImagePipelinesResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', 'ListImageRecipesRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListImageRecipesResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', 'ListImageScanFindingAggregationsRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListImageScanFindingAggregationsResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', 'ListImageScanFindingsRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListImageScanFindingsResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', 'ListImagesRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListImagesResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', 'ListInfrastructureConfigurationsRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListInfrastructureConfigurationsResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', 'ListWorkflowExecutionsRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListWorkflowExecutionsResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', 'ListWorkflowStepExecutionsRequest$nextToken' => 'A token to specify where to start paginating. This is the NextToken from a previously truncated response.
', 'ListWorkflowStepExecutionsResponse$nextToken' => 'The next token used for paginated responses. When this field isn\'t empty, there are additional elements that the service has\'ot included in this request. Use this token with the next request to retrieve additional objects.
', ], ], 'PipelineExecutionStartCondition' => [ 'base' => NULL, 'refs' => [ 'Schedule$pipelineExecutionStartCondition' => 'The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.
The status of the image pipeline.
', 'ImagePipeline$status' => 'The status of the image pipeline.
', 'UpdateImagePipelineRequest$status' => 'The status of the image pipeline.
', ], ], 'Platform' => [ 'base' => NULL, 'refs' => [ 'Component$platform' => 'The operating system platform of the component.
', 'ComponentSummary$platform' => 'The operating system platform of the component.
', 'ComponentVersion$platform' => 'The platform of the component.
', 'ContainerRecipe$platform' => 'The system platform for the container, such as Windows or Linux.
', 'ContainerRecipeSummary$platform' => 'The system platform for the container, such as Windows or Linux.
', 'CreateComponentRequest$platform' => 'The operating system platform of the component.
', 'CreateContainerRecipeRequest$platformOverride' => 'Specifies the operating system platform when you use a custom base image.
', 'Image$platform' => 'The image operating system platform, such as Linux or Windows.
', 'ImagePipeline$platform' => 'The platform of the image pipeline.
', 'ImageRecipe$platform' => 'The platform of the image recipe.
', 'ImageRecipeSummary$platform' => 'The platform of the image recipe.
', 'ImageSummary$platform' => 'The image operating system platform, such as Linux or Windows.
', 'ImageVersion$platform' => 'The operating system platform of the image version, for example "Windows" or "Linux".
', 'ImportComponentRequest$platform' => 'The platform of the component.
', 'ImportVmImageRequest$platform' => 'The operating system platform for the imported VM.
', ], ], 'PutComponentPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutComponentPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutContainerRecipePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutContainerRecipePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutImagePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutImagePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutImageRecipePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutImageRecipePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegionList' => [ 'base' => NULL, 'refs' => [ 'DistributionConfigurationSummary$regions' => 'A list of Regions where the container image is distributed to.
', ], ], 'Remediation' => [ 'base' => 'Information about how to remediate a finding.
', 'refs' => [ 'ImageScanFinding$remediation' => 'An object that contains the details about how to remediate the finding.
', ], ], 'RemediationRecommendation' => [ 'base' => 'Details about the recommended course of action to remediate the finding.
', 'refs' => [ 'Remediation$recommendation' => 'An object that contains information about the recommended course of action to remediate the finding.
', ], ], 'ResourceAlreadyExistsException' => [ 'base' => 'The resource that you are trying to create already exists.
', 'refs' => [], ], 'ResourceDependencyException' => [ 'base' => 'You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
', 'refs' => [], ], 'ResourceInUseException' => [ 'base' => 'The resource that you are trying to operate on is currently in use. Review the message details and retry later.
', 'refs' => [], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'Component$name' => 'The name of the component.
', 'ComponentSummary$name' => 'The name of the component.
', 'ComponentVersion$name' => 'The name of the component.
', 'ContainerRecipe$name' => 'The name of the container recipe.
', 'ContainerRecipeSummary$name' => 'The name of the container recipe.
', 'CreateComponentRequest$name' => 'The name of the component.
', 'CreateContainerRecipeRequest$name' => 'The name of the container recipe.
', 'CreateDistributionConfigurationRequest$name' => 'The name of the distribution configuration.
', 'CreateImagePipelineRequest$name' => 'The name of the image pipeline.
', 'CreateImageRecipeRequest$name' => 'The name of the image recipe.
', 'CreateInfrastructureConfigurationRequest$name' => 'The name of the infrastructure configuration.
', 'DistributionConfiguration$name' => 'The name of the distribution configuration.
', 'DistributionConfigurationSummary$name' => 'The name of the distribution configuration.
', 'Image$name' => 'The name of the image.
', 'Image$sourcePipelineName' => 'The name of the image pipeline that created this image.
', 'ImagePipeline$name' => 'The name of the image pipeline.
', 'ImageRecipe$name' => 'The name of the image recipe.
', 'ImageRecipeSummary$name' => 'The name of the image recipe.
', 'ImageSummary$name' => 'The name of the image.
', 'ImageVersion$name' => 'The name of this specific version of an Image Builder image.
', 'ImportComponentRequest$name' => 'The name of the component.
', 'InfrastructureConfiguration$name' => 'The name of the infrastructure configuration.
', 'InfrastructureConfigurationSummary$name' => 'The name of the infrastructure configuration.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'At least one of the resources referenced by your request does not exist.
', 'refs' => [], ], 'ResourcePolicyDocument' => [ 'base' => NULL, 'refs' => [ 'GetComponentPolicyResponse$policy' => 'The component policy.
', 'GetContainerRecipePolicyResponse$policy' => 'The container recipe policy object that is returned.
', 'GetImagePolicyResponse$policy' => 'The image policy object.
', 'GetImageRecipePolicyResponse$policy' => 'The image recipe policy object.
', 'PutComponentPolicyRequest$policy' => 'The policy to apply.
', 'PutContainerRecipePolicyRequest$policy' => 'The policy to apply to the container recipe.
', 'PutImagePolicyRequest$policy' => 'The policy to apply.
', 'PutImageRecipePolicyRequest$policy' => 'The policy to apply.
', ], ], 'ResourceTagMap' => [ 'base' => NULL, 'refs' => [ 'CreateInfrastructureConfigurationRequest$resourceTags' => 'The tags attached to the resource created by Image Builder.
', 'InfrastructureConfiguration$resourceTags' => 'The tags attached to the resource created by Image Builder.
', 'InfrastructureConfigurationSummary$resourceTags' => 'The tags attached to the image created by Image Builder.
', 'UpdateInfrastructureConfigurationRequest$resourceTags' => 'The tags attached to the resource created by Image Builder.
', ], ], 'RestrictedInteger' => [ 'base' => NULL, 'refs' => [ 'ListComponentBuildVersionsRequest$maxResults' => 'The maximum items to return in a request.
', 'ListComponentsRequest$maxResults' => 'The maximum items to return in a request.
', 'ListContainerRecipesRequest$maxResults' => 'The maximum items to return in a request.
', 'ListDistributionConfigurationsRequest$maxResults' => 'The maximum items to return in a request.
', 'ListImageBuildVersionsRequest$maxResults' => 'The maximum items to return in a request.
', 'ListImagePackagesRequest$maxResults' => 'The maximum items to return in a request.
', 'ListImagePipelineImagesRequest$maxResults' => 'The maximum items to return in a request.
', 'ListImagePipelinesRequest$maxResults' => 'The maximum items to return in a request.
', 'ListImageRecipesRequest$maxResults' => 'The maximum items to return in a request.
', 'ListImageScanFindingsRequest$maxResults' => 'The maximum items to return in a request.
', 'ListImagesRequest$maxResults' => 'The maximum items to return in a request.
', 'ListInfrastructureConfigurationsRequest$maxResults' => 'The maximum items to return in a request.
', 'ListWorkflowExecutionsRequest$maxResults' => 'The maximum items to return in a request.
', 'ListWorkflowStepExecutionsRequest$maxResults' => 'The maximum items to return in a request.
', ], ], 'S3ExportConfiguration' => [ 'base' => 'Properties that configure export from your build instance to a compatible file format for your VM.
', 'refs' => [ 'Distribution$s3ExportConfiguration' => 'Configure export settings to deliver disk images created from your image build, using a file format that is compatible with your VMs in that Region.
', ], ], 'S3Logs' => [ 'base' => 'Amazon S3 logging configuration.
', 'refs' => [ 'Logging$s3Logs' => 'The Amazon S3 logging configuration.
', ], ], 'Schedule' => [ 'base' => 'A schedule configures how often and when a pipeline will automatically create a new image.
', 'refs' => [ 'CreateImagePipelineRequest$schedule' => 'The schedule of the image pipeline.
', 'ImagePipeline$schedule' => 'The schedule of the image pipeline.
', 'UpdateImagePipelineRequest$schedule' => 'The schedule of the image pipeline.
', ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'CreateInfrastructureConfigurationRequest$securityGroupIds' => 'The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
', 'InfrastructureConfiguration$securityGroupIds' => 'The security group IDs of the infrastructure configuration.
', 'UpdateInfrastructureConfigurationRequest$securityGroupIds' => 'The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
', ], ], 'ServiceException' => [ 'base' => 'This exception is thrown when the service encounters an unrecoverable exception.
', 'refs' => [], ], 'ServiceQuotaExceededException' => [ 'base' => 'You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
', 'refs' => [], ], 'ServiceUnavailableException' => [ 'base' => 'The service is unable to process your request at this time.
', 'refs' => [], ], 'SeverityCountNumber' => [ 'base' => NULL, 'refs' => [ 'SeverityCounts$all' => 'The total number of findings across all severity levels for the specified filter.
', 'SeverityCounts$critical' => 'The number of critical severity findings for the specified filter.
', 'SeverityCounts$high' => 'The number of high severity findings for the specified filter.
', 'SeverityCounts$medium' => 'The number of medium severity findings for the specified filter.
', ], ], 'SeverityCounts' => [ 'base' => 'Includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified filter.
', 'refs' => [ 'AccountAggregation$severityCounts' => 'Counts by severity level for medium severity and higher level findings, plus a total for all of the findings.
', 'ImageAggregation$severityCounts' => 'Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image.
', 'ImagePipelineAggregation$severityCounts' => 'Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image pipeline.
', 'VulnerabilityIdAggregation$severityCounts' => 'Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified vulnerability.
', ], ], 'SnsTopicArn' => [ 'base' => NULL, 'refs' => [ 'CreateInfrastructureConfigurationRequest$snsTopicArn' => 'The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.
The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.
The source layer hash of the vulnerable package.
', ], ], 'StartImagePipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartImagePipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'Container$imageUris' => 'A list of URIs for containers created in the context Region.
', 'ContainerDistributionConfiguration$containerTags' => 'Tags that are attached to the container distribution configuration.
', 'EcrConfiguration$containerTags' => 'Tags for Image Builder to apply to the output container image that &INS; scans. Tags can help you identify and manage your scanned images.
', 'LaunchPermissionConfiguration$userGroups' => 'The name of the group.
', ], ], 'SystemsManagerAgent' => [ 'base' => 'Contains settings for the Systems Manager agent on your build instance.
', 'refs' => [ 'AdditionalInstanceConfiguration$systemsManagerAgent' => 'Contains settings for the Systems Manager agent on your build instance.
', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'ResourceTagMap$key' => NULL, 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'The tag keys to remove from the resource.
', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'AmiDistributionConfiguration$amiTags' => 'The tags to apply to AMIs distributed to this Region.
', 'Component$tags' => 'The tags that apply to the component.
', 'ComponentSummary$tags' => 'The tags that apply to the component.
', 'ContainerRecipe$tags' => 'Tags that are attached to the container recipe.
', 'ContainerRecipeSummary$tags' => 'Tags that are attached to the container recipe.
', 'CreateComponentRequest$tags' => 'The tags that apply to the component.
', 'CreateContainerRecipeRequest$tags' => 'Tags that are attached to the container recipe.
', 'CreateDistributionConfigurationRequest$tags' => 'The tags of the distribution configuration.
', 'CreateImagePipelineRequest$tags' => 'The tags of the image pipeline.
', 'CreateImageRecipeRequest$tags' => 'The tags of the image recipe.
', 'CreateImageRequest$tags' => 'The tags of the image.
', 'CreateInfrastructureConfigurationRequest$tags' => 'The tags of the infrastructure configuration.
', 'DistributionConfiguration$tags' => 'The tags of the distribution configuration.
', 'DistributionConfigurationSummary$tags' => 'The tags associated with the distribution configuration.
', 'Image$tags' => 'The tags that apply to this image.
', 'ImagePipeline$tags' => 'The tags of this image pipeline.
', 'ImageRecipe$tags' => 'The tags of the image recipe.
', 'ImageRecipeSummary$tags' => 'The tags of the image recipe.
', 'ImageSummary$tags' => 'The tags that apply to this image.
', 'ImportComponentRequest$tags' => 'The tags of the component.
', 'ImportVmImageRequest$tags' => 'Tags that are attached to the import resources.
', 'InfrastructureConfiguration$tags' => 'The tags of the infrastructure configuration.
', 'InfrastructureConfigurationSummary$tags' => 'The tags of the infrastructure configuration.
', 'ListTagsForResourceResponse$tags' => 'The tags for the specified resource.
', 'TagResourceRequest$tags' => 'The tags to apply to the resource.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'ResourceTagMap$value' => NULL, 'TagMap$value' => NULL, ], ], 'TargetContainerRepository' => [ 'base' => 'The container repository where the output container image is stored.
', 'refs' => [ 'ContainerDistributionConfiguration$targetRepository' => 'The destination repository for the container distribution configuration.
', 'ContainerRecipe$targetRepository' => 'The destination repository for the container image.
', 'CreateContainerRecipeRequest$targetRepository' => 'The destination repository for the container image.
', ], ], 'TargetResourceCount' => [ 'base' => NULL, 'refs' => [ 'FastLaunchSnapshotConfiguration$targetResourceCount' => 'The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
', ], ], 'Timezone' => [ 'base' => NULL, 'refs' => [ 'Schedule$timezone' => 'The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDistributionConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDistributionConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImagePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImagePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInfrastructureConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInfrastructureConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'Uri' => [ 'base' => NULL, 'refs' => [ 'CreateComponentRequest$uri' => 'The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.
The Amazon S3 URI for the Dockerfile that will be used to build your container image.
', 'ImportComponentRequest$uri' => 'The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.
Use this property to provide commands or a command script to run when you launch your build instance.
The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.
The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:
#!/bin/bash
mkdir -p /var/bb/
touch /var
The version of the component.
', 'ComponentSummary$version' => 'The version of the component.
', 'ComponentVersion$version' => 'The semantic version of the component.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
The semantic version of the container recipe.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
The semantic version of the component. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
The semantic version of the container recipe. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
The semantic version of the image recipe. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
The semantic version of the image.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
The version of the image recipe.
', 'ImageSummary$version' => 'The version of the image.
', 'ImageVersion$version' => 'Details for a specific version of an Image Builder image. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
The semantic version of the component. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
A unique identifier for this vulnerability.
', 'VulnerabilityIdList$member' => NULL, ], ], 'VulnerabilityIdAggregation' => [ 'base' => 'Includes counts of image and pipeline resource findings by vulnerability.
', 'refs' => [ 'ImageScanFindingAggregation$vulnerabilityIdAggregation' => 'Returns an object that contains severity counts based on vulnerability ID.
', ], ], 'VulnerabilityIdList' => [ 'base' => NULL, 'refs' => [ 'PackageVulnerabilityDetails$relatedVulnerabilities' => 'Vulnerabilities that are often related to the findings for the package.
', ], ], 'VulnerablePackage' => [ 'base' => 'Information about a vulnerable package that Amazon Inspector identifies in a finding.
', 'refs' => [ 'VulnerablePackageList$member' => NULL, ], ], 'VulnerablePackageList' => [ 'base' => NULL, 'refs' => [ 'PackageVulnerabilityDetails$vulnerablePackages' => 'The packages that this vulnerability impacts.
', ], ], 'WorkflowBuildVersionArn' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowExecutionResponse$workflowBuildVersionArn' => 'The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.
', 'GetWorkflowStepExecutionResponse$workflowBuildVersionArn' => 'The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.
', 'ListWorkflowStepExecutionsResponse$workflowBuildVersionArn' => 'The build version ARN for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow.
', 'WorkflowExecutionMetadata$workflowBuildVersionArn' => 'The Amazon Resource Name (ARN) of the workflow resource build version that ran.
', ], ], 'WorkflowExecutionId' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowExecutionRequest$workflowExecutionId' => 'Use the unique identifier for a runtime instance of the workflow to get runtime details.
', 'GetWorkflowExecutionResponse$workflowExecutionId' => 'The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
', 'GetWorkflowStepExecutionResponse$workflowExecutionId' => 'The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
', 'ListWorkflowStepExecutionsRequest$workflowExecutionId' => 'The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
', 'ListWorkflowStepExecutionsResponse$workflowExecutionId' => 'The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
', 'WorkflowExecutionMetadata$workflowExecutionId' => 'Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
', ], ], 'WorkflowExecutionMessage' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowExecutionResponse$message' => 'The output message from the specified runtime instance of the workflow, if applicable.
', 'WorkflowExecutionMetadata$message' => 'The runtime output message from the workflow, if applicable.
', ], ], 'WorkflowExecutionMetadata' => [ 'base' => 'Metadata that includes details and status from this runtime instance of the workflow.
', 'refs' => [ 'WorkflowExecutionsList$member' => NULL, ], ], 'WorkflowExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowExecutionResponse$status' => 'The current runtime status for the specified runtime instance of the workflow.
', 'WorkflowExecutionMetadata$status' => 'The current runtime status for this workflow.
', ], ], 'WorkflowExecutionsList' => [ 'base' => NULL, 'refs' => [ 'ListWorkflowExecutionsResponse$workflowExecutions' => 'Contains an array of runtime details that represents each time a workflow ran for the requested image build version.
', ], ], 'WorkflowStepAction' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowStepExecutionResponse$action' => 'The name of the action that the specified step performs.
', 'WorkflowStepMetadata$action' => 'The step action name.
', ], ], 'WorkflowStepCount' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowExecutionResponse$totalStepCount' => 'The total number of steps in the specified runtime instance of the workflow that ran. This number should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
', 'GetWorkflowExecutionResponse$totalStepsSucceeded' => 'A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow.
', 'GetWorkflowExecutionResponse$totalStepsFailed' => 'A runtime count for the number of steps that failed in the specified runtime instance of the workflow.
', 'GetWorkflowExecutionResponse$totalStepsSkipped' => 'A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.
', 'WorkflowExecutionMetadata$totalStepCount' => 'The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
', 'WorkflowExecutionMetadata$totalStepsSucceeded' => 'A runtime count for the number of steps in the workflow that ran successfully.
', 'WorkflowExecutionMetadata$totalStepsFailed' => 'A runtime count for the number of steps in the workflow that failed.
', 'WorkflowExecutionMetadata$totalStepsSkipped' => 'A runtime count for the number of steps in the workflow that were skipped.
', ], ], 'WorkflowStepDescription' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowStepExecutionResponse$description' => 'Describes the specified workflow step.
', 'WorkflowStepMetadata$description' => 'Description of the workflow step.
', ], ], 'WorkflowStepExecutionId' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowStepExecutionRequest$stepExecutionId' => 'Use the unique identifier for a specific runtime instance of the workflow step to get runtime details for that step.
', 'GetWorkflowStepExecutionResponse$stepExecutionId' => 'The unique identifier for the runtime version of the workflow step that you specified in the request.
', 'WorkflowStepMetadata$stepExecutionId' => 'A unique identifier for the workflow step, assigned at runtime.
', ], ], 'WorkflowStepExecutionRollbackStatus' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowStepExecutionResponse$rollbackStatus' => 'Reports on the rollback status of the specified runtime version of the workflow step, if applicable.
', 'WorkflowStepMetadata$rollbackStatus' => 'Reports on the rollback status of the step, if applicable.
', ], ], 'WorkflowStepExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowStepExecutionResponse$status' => 'The current status for the specified runtime version of the workflow step.
', 'WorkflowStepMetadata$status' => 'Runtime status for the workflow step.
', ], ], 'WorkflowStepExecutionsList' => [ 'base' => NULL, 'refs' => [ 'ListWorkflowStepExecutionsResponse$steps' => 'Contains an array of runtime details that represents each step in this runtime instance of the workflow.
', ], ], 'WorkflowStepInputs' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowStepExecutionResponse$inputs' => 'Input parameters that Image Builder provided for the specified runtime instance of the workflow step.
', 'WorkflowStepMetadata$inputs' => 'Input parameters that Image Builder provides for the workflow step.
', ], ], 'WorkflowStepMessage' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowStepExecutionResponse$message' => 'The output message from the specified runtime instance of the workflow step, if applicable.
', 'WorkflowStepMetadata$message' => 'Detailed output message that the workflow step provides at runtime.
', ], ], 'WorkflowStepMetadata' => [ 'base' => 'Runtime details and status for the workflow step.
', 'refs' => [ 'WorkflowStepExecutionsList$member' => NULL, ], ], 'WorkflowStepName' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowStepExecutionResponse$name' => 'The name of the specified runtime instance of the workflow step.
', 'WorkflowStepMetadata$name' => 'The name of the workflow step.
', ], ], 'WorkflowStepOutputs' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowStepExecutionResponse$outputs' => 'The file names that the specified runtime version of the workflow step created as output.
', 'WorkflowStepMetadata$outputs' => 'The file names that the workflow step created as output for this runtime instance of the workflow.
', ], ], 'WorkflowStepTimeoutSecondsInteger' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowStepExecutionResponse$timeoutSeconds' => 'The maximum duration in seconds for this step to complete its action.
', ], ], 'WorkflowType' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowExecutionResponse$type' => 'The type of workflow that Image Builder ran for the specified runtime instance of the workflow.
', 'WorkflowExecutionMetadata$type' => 'Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
', ], ], ],];