imagebuilder ************ Client ====== class imagebuilder.Client A low-level client representing EC2 Image Builder (imagebuilder) 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. import boto3 client = boto3.client('imagebuilder') These are the available methods: * can_paginate * cancel_image_creation * cancel_lifecycle_execution * close * create_component * create_container_recipe * create_distribution_configuration * create_image * create_image_pipeline * create_image_recipe * create_infrastructure_configuration * create_lifecycle_policy * create_workflow * delete_component * delete_container_recipe * delete_distribution_configuration * delete_image * delete_image_pipeline * delete_image_recipe * delete_infrastructure_configuration * delete_lifecycle_policy * delete_workflow * get_component * get_component_policy * get_container_recipe * get_container_recipe_policy * get_distribution_configuration * get_image * get_image_pipeline * get_image_policy * get_image_recipe * get_image_recipe_policy * get_infrastructure_configuration * get_lifecycle_execution * get_lifecycle_policy * get_marketplace_resource * get_paginator * get_waiter * get_workflow * get_workflow_execution * get_workflow_step_execution * import_component * import_disk_image * import_vm_image * list_component_build_versions * list_components * list_container_recipes * list_distribution_configurations * list_image_build_versions * list_image_packages * list_image_pipeline_images * list_image_pipelines * list_image_recipes * list_image_scan_finding_aggregations * list_image_scan_findings * list_images * list_infrastructure_configurations * list_lifecycle_execution_resources * list_lifecycle_executions * list_lifecycle_policies * list_tags_for_resource * list_waiting_workflow_steps * list_workflow_build_versions * list_workflow_executions * list_workflow_step_executions * list_workflows * put_component_policy * put_container_recipe_policy * put_image_policy * put_image_recipe_policy * send_workflow_step_action * start_image_pipeline_execution * start_resource_state_update * tag_resource * untag_resource * update_distribution_configuration * update_image_pipeline * update_infrastructure_configuration * update_lifecycle_policy Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListComponentBuildVersions * ListComponents * ListContainerRecipes * ListDistributionConfigurations * ListImageBuildVersions * ListImagePackages * ListImagePipelineImages * ListImagePipelines * ListImageRecipes * ListImageScanFindingAggregations * ListImageScanFindings * ListImages * ListInfrastructureConfigurations * ListLifecycleExecutionResources * ListLifecycleExecutions * ListLifecyclePolicies * ListWaitingWorkflowSteps * ListWorkflowBuildVersions * ListWorkflowExecutions * ListWorkflowStepExecutions * ListWorkflows imagebuilder / Paginator / ListImagePipelineImages ListImagePipelineImages *********************** class imagebuilder.Paginator.ListImagePipelineImages paginator = client.get_paginator('list_image_pipeline_images') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_image_pipeline_images()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( imagePipelineArn='string', filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **imagePipelineArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image pipeline whose images you want to view. * **filters** (*list*) -- Use the following filters to streamline results: * "name" * "version" * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case- sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imageSummaryList': [ { 'arn': 'string', 'name': 'string', 'type': 'AMI'|'DOCKER', 'version': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'osVersion': 'string', 'state': { 'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED', 'reason': 'string' }, 'owner': 'string', 'dateCreated': 'string', 'outputResources': { 'amis': [ { 'region': 'string', 'image': 'string', 'name': 'string', 'description': 'string', 'state': { 'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED', 'reason': 'string' }, 'accountId': 'string' }, ], 'containers': [ { 'region': 'string', 'imageUris': [ 'string', ] }, ] }, 'tags': { 'string': 'string' }, 'buildType': 'USER_INITIATED'|'SCHEDULED'|'IMPORT'|'IMPORT_ISO', 'imageSource': 'AMAZON_MANAGED'|'AWS_MARKETPLACE'|'IMPORTED'|'CUSTOM', 'deprecationTime': datetime(2015, 1, 1), 'lifecycleExecutionId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imageSummaryList** *(list) --* The list of images built by this pipeline. * *(dict) --* An image summary. * **arn** *(string) --* The Amazon Resource Name (ARN) of the image. * **name** *(string) --* The name of the image. * **type** *(string) --* Specifies whether this image produces an AMI or a container image. * **version** *(string) --* The version of the image. * **platform** *(string) --* The image operating system platform, such as Linux or Windows. * **osVersion** *(string) --* The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019. * **state** *(dict) --* The state of the image. * **status** *(string) --* The status of the image. * **reason** *(string) --* The reason for the status of the image. * **owner** *(string) --* The owner of the image. * **dateCreated** *(string) --* The date on which Image Builder created this image. * **outputResources** *(dict) --* The output resources that Image Builder produced when it created this image. * **amis** *(list) --* The Amazon EC2 AMIs created by this image. * *(dict) --* Details of an Amazon EC2 AMI. * **region** *(string) --* The Amazon Web Services Region of the Amazon EC2 AMI. * **image** *(string) --* The AMI ID of the Amazon EC2 AMI. * **name** *(string) --* The name of the Amazon EC2 AMI. * **description** *(string) --* The description of the Amazon EC2 AMI. Minimum and maximum length are in characters. * **state** *(dict) --* Image status and the reason for that status. * **status** *(string) --* The status of the image. * **reason** *(string) --* The reason for the status of the image. * **accountId** *(string) --* The account ID of the owner of the AMI. * **containers** *(list) --* Container images that the pipeline has generated and stored in the output repository. * *(dict) --* A container encapsulates the runtime environment for an application. * **region** *(string) --* Containers and container images are Region- specific. This is the Region context for the container. * **imageUris** *(list) --* A list of URIs for containers created in the context Region. * *(string) --* * **tags** *(dict) --* The tags that apply to this image. * *(string) --* * *(string) --* * **buildType** *(string) --* 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. * **IMPORT_ISO** – An ISO disk import created the image. * **imageSource** *(string) --* The origin of the base image that Image Builder used to build this image. * **deprecationTime** *(datetime) --* The time when deprecation occurs for an image resource. This can be a past or future date. * **lifecycleExecutionId** *(string) --* Identifies the last runtime instance of the lifecycle policy to take action on the image. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListInfrastructureConfigurations ListInfrastructureConfigurations ******************************** class imagebuilder.Paginator.ListInfrastructureConfigurations paginator = client.get_paginator('list_infrastructure_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_infrastructure_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **filters** (*list*) -- You can filter on "name" to streamline results. * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case- sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'infrastructureConfigurationSummaryList': [ { 'arn': 'string', 'name': 'string', 'description': 'string', 'dateCreated': 'string', 'dateUpdated': 'string', 'resourceTags': { 'string': 'string' }, 'tags': { 'string': 'string' }, 'instanceTypes': [ 'string', ], 'instanceProfileName': 'string', 'placement': { 'availabilityZone': 'string', 'tenancy': 'default'|'dedicated'|'host', 'hostId': 'string', 'hostResourceGroupArn': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **infrastructureConfigurationSummaryList** *(list) --* The list of infrastructure configurations. * *(dict) --* The infrastructure used when building Amazon EC2 AMIs. * **arn** *(string) --* The Amazon Resource Name (ARN) of the infrastructure configuration. * **name** *(string) --* The name of the infrastructure configuration. * **description** *(string) --* The description of the infrastructure configuration. * **dateCreated** *(string) --* The date on which the infrastructure configuration was created. * **dateUpdated** *(string) --* The date on which the infrastructure configuration was last updated. * **resourceTags** *(dict) --* The tags attached to the image created by Image Builder. * *(string) --* * *(string) --* * **tags** *(dict) --* The tags of the infrastructure configuration. * *(string) --* * *(string) --* * **instanceTypes** *(list) --* The instance types of the infrastructure configuration. * *(string) --* * **instanceProfileName** *(string) --* The instance profile of the infrastructure configuration. * **placement** *(dict) --* The instance placement settings that define where the instances that are launched from your image will run. * **availabilityZone** *(string) --* The Availability Zone where your build and test instances will launch. * **tenancy** *(string) --* The tenancy of the instance. An instance with a tenancy of "dedicated" runs on single-tenant hardware. An instance with a tenancy of "host" runs on a Dedicated Host. If tenancy is set to "host", then you can optionally specify one target for placement – either host ID or host resource group ARN. If automatic placement is enabled for your host, and you don't specify any placement target, Amazon EC2 will try to find an available host for your build and test instances. * **hostId** *(string) --* The ID of the Dedicated Host on which build and test instances run. This only applies if "tenancy" is "host". If you specify the host ID, you must not specify the resource group ARN. If you specify both, Image Builder returns an error. * **hostResourceGroupArn** *(string) --* The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances. This only applies if "tenancy" is "host". If you specify the resource group ARN, you must not specify the host ID. If you specify both, Image Builder returns an error. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListContainerRecipes ListContainerRecipes ******************** class imagebuilder.Paginator.ListContainerRecipes paginator = client.get_paginator('list_container_recipes') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_container_recipes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( owner='Self'|'Shared'|'Amazon'|'ThirdParty'|'AWSMarketplace', filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **owner** (*string*) -- 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. * **filters** (*list*) -- Use the following filters to streamline results: * "containerType" * "name" * "parentImage" * "platform" * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case- sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'containerRecipeSummaryList': [ { 'arn': 'string', 'containerType': 'DOCKER', 'name': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'owner': 'string', 'parentImage': 'string', 'dateCreated': 'string', 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **containerRecipeSummaryList** *(list) --* The list of container recipes returned for the request. * *(dict) --* A summary of a container recipe * **arn** *(string) --* The Amazon Resource Name (ARN) of the container recipe. * **containerType** *(string) --* Specifies the type of container, such as "Docker". * **name** *(string) --* The name of the container recipe. * **platform** *(string) --* The system platform for the container, such as Windows or Linux. * **owner** *(string) --* The owner of the container recipe. * **parentImage** *(string) --* The base image for the container recipe. * **dateCreated** *(string) --* The date when this container recipe was created. * **tags** *(dict) --* Tags that are attached to the container recipe. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListComponents ListComponents ************** class imagebuilder.Paginator.ListComponents paginator = client.get_paginator('list_components') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_components()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( owner='Self'|'Shared'|'Amazon'|'ThirdParty'|'AWSMarketplace', filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], byName=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **owner** (*string*) -- 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. * **filters** (*list*) -- Use the following filters to streamline results: * "description" * "name" * "platform" * "supportedOsVersion" * "type" * "version" * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case- sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **byName** (*boolean*) -- Returns the list of components for the specified name. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'componentVersionList': [ { 'arn': 'string', 'name': 'string', 'version': 'string', 'description': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'supportedOsVersions': [ 'string', ], 'type': 'BUILD'|'TEST', 'owner': 'string', 'dateCreated': 'string', 'status': 'DEPRECATED'|'DISABLED'|'ACTIVE', 'productCodes': [ { 'productCodeId': 'string', 'productCodeType': 'marketplace' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **componentVersionList** *(list) --* The list of component semantic versions. Note: The semantic version has four nodes: ../. You can assign values for the first three, and can filter on all of them. * *(dict) --* The defining characteristics of a specific version of an Amazon Web Services TOE component. * **arn** *(string) --* The Amazon Resource Name (ARN) of the component. Note: 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: .. * Build version ARNs have all four nodes, and point to a specific build for a specific version of an object. * **name** *(string) --* The name of the component. * **version** *(string) --* The semantic version of the component. Note: The semantic version has four nodes: ../. 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. * **description** *(string) --* The description of the component. * **platform** *(string) --* The platform of the component. * **supportedOsVersions** *(list) --* 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. * *(string) --* * **type** *(string) --* The type of the component denotes whether the component is used to build the image or only to test it. * **owner** *(string) --* The owner of the component. * **dateCreated** *(string) --* The date that the component was created. * **status** *(string) --* Describes the current status of the component version. * **productCodes** *(list) --* Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components. * *(dict) --* Information about a single product code. * **productCodeId** *(string) --* For Amazon Web Services Marketplace components, this contains the product code ID that can be stamped onto an EC2 AMI to ensure that components are billed correctly. If this property is empty, it might mean that the component is not published. * **productCodeType** *(string) --* The owner of the product code that's billed. If this property is empty, it might mean that the component is not published. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListLifecyclePolicies ListLifecyclePolicies ********************* class imagebuilder.Paginator.ListLifecyclePolicies paginator = client.get_paginator('list_lifecycle_policies') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_lifecycle_policies()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **filters** (*list*) -- Streamline results based on one of the following values: "Name", "Status". * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case- sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'lifecyclePolicySummaryList': [ { 'arn': 'string', 'name': 'string', 'description': 'string', 'status': 'DISABLED'|'ENABLED', 'executionRole': 'string', 'resourceType': 'AMI_IMAGE'|'CONTAINER_IMAGE', 'dateCreated': datetime(2015, 1, 1), 'dateUpdated': datetime(2015, 1, 1), 'dateLastRun': datetime(2015, 1, 1), 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **lifecyclePolicySummaryList** *(list) --* A list of lifecycle policies in your Amazon Web Services account that meet the criteria specified in the request. * *(dict) --* Contains a summary of lifecycle policy resources. * **arn** *(string) --* The Amazon Resource Name (ARN) of the lifecycle policy summary resource. * **name** *(string) --* The name of the lifecycle policy. * **description** *(string) --* Optional description for the lifecycle policy. * **status** *(string) --* The lifecycle policy resource status. * **executionRole** *(string) --* The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy. * **resourceType** *(string) --* The type of resources the lifecycle policy targets. * **dateCreated** *(datetime) --* The timestamp when Image Builder created the lifecycle policy resource. * **dateUpdated** *(datetime) --* The timestamp when Image Builder updated the lifecycle policy resource. * **dateLastRun** *(datetime) --* The timestamp for the last time Image Builder ran the lifecycle policy. * **tags** *(dict) --* To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListWorkflows ListWorkflows ************* class imagebuilder.Paginator.ListWorkflows paginator = client.get_paginator('list_workflows') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_workflows()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( owner='Self'|'Shared'|'Amazon'|'ThirdParty'|'AWSMarketplace', filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], byName=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **owner** (*string*) -- Used to get a list of workflow build version filtered by the identity of the creator. * **filters** (*list*) -- Used to streamline search results. * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case- sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **byName** (*boolean*) -- Specify all or part of the workflow name to streamline results. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'workflowVersionList': [ { 'arn': 'string', 'name': 'string', 'version': 'string', 'description': 'string', 'type': 'BUILD'|'TEST'|'DISTRIBUTION', 'owner': 'string', 'dateCreated': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **workflowVersionList** *(list) --* A list of workflow build versions that match the request criteria. * *(dict) --* Contains details about this version of the workflow. * **arn** *(string) --* The Amazon Resource Name (ARN) of the workflow resource. * **name** *(string) --* The name of the workflow. * **version** *(string) --* The semantic version of the workflow resource. The format includes three nodes: ... * **description** *(string) --* Describes the workflow. * **type** *(string) --* The image creation stage that this workflow applies to. Image Builder currently supports build and test stage workflows. * **owner** *(string) --* The owner of the workflow resource. * **dateCreated** *(string) --* The timestamp when Image Builder created the workflow version. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListImageBuildVersions ListImageBuildVersions ********************** class imagebuilder.Paginator.ListImageBuildVersions paginator = client.get_paginator('list_image_build_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_image_build_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( imageVersionArn='string', filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **imageVersionArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve. * **filters** (*list*) -- Use the following filters to streamline results: * "name" * "osVersion" * "platform" * "type" * "version" * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case- sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imageSummaryList': [ { 'arn': 'string', 'name': 'string', 'type': 'AMI'|'DOCKER', 'version': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'osVersion': 'string', 'state': { 'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED', 'reason': 'string' }, 'owner': 'string', 'dateCreated': 'string', 'outputResources': { 'amis': [ { 'region': 'string', 'image': 'string', 'name': 'string', 'description': 'string', 'state': { 'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED', 'reason': 'string' }, 'accountId': 'string' }, ], 'containers': [ { 'region': 'string', 'imageUris': [ 'string', ] }, ] }, 'tags': { 'string': 'string' }, 'buildType': 'USER_INITIATED'|'SCHEDULED'|'IMPORT'|'IMPORT_ISO', 'imageSource': 'AMAZON_MANAGED'|'AWS_MARKETPLACE'|'IMPORTED'|'CUSTOM', 'deprecationTime': datetime(2015, 1, 1), 'lifecycleExecutionId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imageSummaryList** *(list) --* The list of image build versions. * *(dict) --* An image summary. * **arn** *(string) --* The Amazon Resource Name (ARN) of the image. * **name** *(string) --* The name of the image. * **type** *(string) --* Specifies whether this image produces an AMI or a container image. * **version** *(string) --* The version of the image. * **platform** *(string) --* The image operating system platform, such as Linux or Windows. * **osVersion** *(string) --* The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019. * **state** *(dict) --* The state of the image. * **status** *(string) --* The status of the image. * **reason** *(string) --* The reason for the status of the image. * **owner** *(string) --* The owner of the image. * **dateCreated** *(string) --* The date on which Image Builder created this image. * **outputResources** *(dict) --* The output resources that Image Builder produced when it created this image. * **amis** *(list) --* The Amazon EC2 AMIs created by this image. * *(dict) --* Details of an Amazon EC2 AMI. * **region** *(string) --* The Amazon Web Services Region of the Amazon EC2 AMI. * **image** *(string) --* The AMI ID of the Amazon EC2 AMI. * **name** *(string) --* The name of the Amazon EC2 AMI. * **description** *(string) --* The description of the Amazon EC2 AMI. Minimum and maximum length are in characters. * **state** *(dict) --* Image status and the reason for that status. * **status** *(string) --* The status of the image. * **reason** *(string) --* The reason for the status of the image. * **accountId** *(string) --* The account ID of the owner of the AMI. * **containers** *(list) --* Container images that the pipeline has generated and stored in the output repository. * *(dict) --* A container encapsulates the runtime environment for an application. * **region** *(string) --* Containers and container images are Region- specific. This is the Region context for the container. * **imageUris** *(list) --* A list of URIs for containers created in the context Region. * *(string) --* * **tags** *(dict) --* The tags that apply to this image. * *(string) --* * *(string) --* * **buildType** *(string) --* 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. * **IMPORT_ISO** – An ISO disk import created the image. * **imageSource** *(string) --* The origin of the base image that Image Builder used to build this image. * **deprecationTime** *(datetime) --* The time when deprecation occurs for an image resource. This can be a past or future date. * **lifecycleExecutionId** *(string) --* Identifies the last runtime instance of the lifecycle policy to take action on the image. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListImageScanFindings ListImageScanFindings ********************* class imagebuilder.Paginator.ListImageScanFindings paginator = client.get_paginator('list_image_scan_findings') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_image_scan_findings()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **filters** (*list*) -- 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. * *(dict) --* A name value pair that Image Builder applies to streamline results from the vulnerability scan findings list action. * **name** *(string) --* The name of the image scan finding filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'findings': [ { 'awsAccountId': 'string', 'imageBuildVersionArn': 'string', 'imagePipelineArn': 'string', 'type': 'string', 'description': 'string', 'title': 'string', 'remediation': { 'recommendation': { 'text': 'string', 'url': 'string' } }, 'severity': 'string', 'firstObservedAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'inspectorScore': 123.0, 'inspectorScoreDetails': { 'adjustedCvss': { 'scoreSource': 'string', 'cvssSource': 'string', 'version': 'string', 'score': 123.0, 'scoringVector': 'string', 'adjustments': [ { 'metric': 'string', 'reason': 'string' }, ] } }, 'packageVulnerabilityDetails': { 'vulnerabilityId': 'string', 'vulnerablePackages': [ { 'name': 'string', 'version': 'string', 'sourceLayerHash': 'string', 'epoch': 123, 'release': 'string', 'arch': 'string', 'packageManager': 'string', 'filePath': 'string', 'fixedInVersion': 'string', 'remediation': 'string' }, ], 'source': 'string', 'cvss': [ { 'baseScore': 123.0, 'scoringVector': 'string', 'version': 'string', 'source': 'string' }, ], 'relatedVulnerabilities': [ 'string', ], 'sourceUrl': 'string', 'vendorSeverity': 'string', 'vendorCreatedAt': datetime(2015, 1, 1), 'vendorUpdatedAt': datetime(2015, 1, 1), 'referenceUrls': [ 'string', ] }, 'fixAvailable': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **findings** *(list) --* The image scan findings for your account that meet your request filter criteria. * *(dict) --* Contains details about a vulnerability scan finding. * **awsAccountId** *(string) --* The Amazon Web Services account ID that's associated with the finding. * **imageBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the image build version that's associated with the finding. * **imagePipelineArn** *(string) --* The Amazon Resource Name (ARN) of the image pipeline that's associated with the finding. * **type** *(string) --* The type of the finding. Image Builder looks for findings of the type "PACKAGE_VULNERABILITY" that apply to output images, and excludes other types. * **description** *(string) --* The description of the finding. * **title** *(string) --* The title of the finding. * **remediation** *(dict) --* An object that contains the details about how to remediate the finding. * **recommendation** *(dict) --* An object that contains information about the recommended course of action to remediate the finding. * **text** *(string) --* The recommended course of action to remediate the finding. * **url** *(string) --* A link to more information about the recommended remediation for this vulnerability. * **severity** *(string) --* The severity of the finding. * **firstObservedAt** *(datetime) --* The date and time when the finding was first observed. * **updatedAt** *(datetime) --* The timestamp when the finding was last updated. * **inspectorScore** *(float) --* The score that Amazon Inspector assigned for the finding. * **inspectorScoreDetails** *(dict) --* An object that contains details of the Amazon Inspector score. * **adjustedCvss** *(dict) --* An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding. * **scoreSource** *(string) --* The source for the CVSS score. * **cvssSource** *(string) --* The source of the finding. * **version** *(string) --* The CVSS version that generated the score. * **score** *(float) --* The CVSS score. * **scoringVector** *(string) --* A vector that measures the severity of the vulnerability. * **adjustments** *(list) --* An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding. * *(dict) --* Details about an adjustment that Amazon Inspector made to the CVSS score for a finding. * **metric** *(string) --* The metric that Amazon Inspector used to adjust the CVSS score. * **reason** *(string) --* The reason for the CVSS score adjustment. * **packageVulnerabilityDetails** *(dict) --* An object that contains the details of a package vulnerability finding. * **vulnerabilityId** *(string) --* A unique identifier for this vulnerability. * **vulnerablePackages** *(list) --* The packages that this vulnerability impacts. * *(dict) --* Information about a vulnerable package that Amazon Inspector identifies in a finding. * **name** *(string) --* The name of the vulnerable package. * **version** *(string) --* The version of the vulnerable package. * **sourceLayerHash** *(string) --* The source layer hash of the vulnerable package. * **epoch** *(integer) --* The epoch of the vulnerable package. * **release** *(string) --* The release of the vulnerable package. * **arch** *(string) --* The architecture of the vulnerable package. * **packageManager** *(string) --* The package manager of the vulnerable package. * **filePath** *(string) --* The file path of the vulnerable package. * **fixedInVersion** *(string) --* The version of the package that contains the vulnerability fix. * **remediation** *(string) --* The code to run in your environment to update packages with a fix available. * **source** *(string) --* The source of the vulnerability information. * **cvss** *(list) --* CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a package. * *(dict) --* 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*. * **baseScore** *(float) --* The CVSS base score. * **scoringVector** *(string) --* The vector string of the CVSS score. * **version** *(string) --* The CVSS version that generated the score. * **source** *(string) --* The source of the CVSS score. * **relatedVulnerabilities** *(list) --* Vulnerabilities that are often related to the findings for the package. * *(string) --* * **sourceUrl** *(string) --* A link to the source of the vulnerability information. * **vendorSeverity** *(string) --* The severity that the vendor assigned to this vulnerability type. * **vendorCreatedAt** *(datetime) --* The date and time when this vulnerability was first added to the vendor's database. * **vendorUpdatedAt** *(datetime) --* The date and time when the vendor last updated this vulnerability in their database. * **referenceUrls** *(list) --* Links to web pages that contain details about the vulnerabilities that Amazon Inspector identified for the package. * *(string) --* * **fixAvailable** *(string) --* Details about whether a fix is available for any of the packages that are identified in the finding through a version update. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListWaitingWorkflowSteps ListWaitingWorkflowSteps ************************ class imagebuilder.Paginator.ListWaitingWorkflowSteps paginator = client.get_paginator('list_waiting_workflow_steps') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_waiting_workflow_steps()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'steps': [ { 'stepExecutionId': 'string', 'imageBuildVersionArn': 'string', 'workflowExecutionId': 'string', 'workflowBuildVersionArn': 'string', 'name': 'string', 'action': 'string', 'startTime': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **steps** *(list) --* An array of the workflow steps that are waiting for action in your Amazon Web Services account. * *(dict) --* Contains runtime details for an instance of a workflow that ran for the associated image build version. * **stepExecutionId** *(string) --* Uniquely identifies the workflow step that ran for the associated image build version. * **imageBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the image build version that ran the workflow. * **workflowExecutionId** *(string) --* Uniquely identifies the runtime instance of the workflow that contains the workflow step that ran for the associated image build version. * **workflowBuildVersionArn** *(string) --* The ARN of the workflow resource that ran. * **name** *(string) --* The name of the workflow step. * **action** *(string) --* The name of the step action. * **startTime** *(string) --* The timestamp when the workflow step started. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListWorkflowStepExecutions ListWorkflowStepExecutions ************************** class imagebuilder.Paginator.ListWorkflowStepExecutions paginator = client.get_paginator('list_workflow_step_executions') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_workflow_step_executions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( workflowExecutionId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **workflowExecutionId** (*string*) -- **[REQUIRED]** The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'steps': [ { 'stepExecutionId': 'string', 'name': 'string', 'description': 'string', 'action': 'string', 'status': 'PENDING'|'SKIPPED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLED', 'rollbackStatus': 'RUNNING'|'COMPLETED'|'SKIPPED'|'FAILED', 'message': 'string', 'inputs': 'string', 'outputs': 'string', 'startTime': 'string', 'endTime': 'string' }, ], 'workflowBuildVersionArn': 'string', 'workflowExecutionId': 'string', 'imageBuildVersionArn': 'string', 'message': 'string', 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **steps** *(list) --* Contains an array of runtime details that represents each step in this runtime instance of the workflow. * *(dict) --* Runtime details and status for the workflow step. * **stepExecutionId** *(string) --* A unique identifier for the workflow step, assigned at runtime. * **name** *(string) --* The name of the workflow step. * **description** *(string) --* Description of the workflow step. * **action** *(string) --* The step action name. * **status** *(string) --* Runtime status for the workflow step. * **rollbackStatus** *(string) --* Reports on the rollback status of the step, if applicable. * **message** *(string) --* Detailed output message that the workflow step provides at runtime. * **inputs** *(string) --* Input parameters that Image Builder provides for the workflow step. * **outputs** *(string) --* The file names that the workflow step created as output for this runtime instance of the workflow. * **startTime** *(string) --* The timestamp when the workflow step started. * **endTime** *(string) --* The timestamp when the workflow step finished. * **workflowBuildVersionArn** *(string) --* The build version ARN for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow. * **workflowExecutionId** *(string) --* The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow. * **imageBuildVersionArn** *(string) --* The image build version resource ARN that's associated with the specified runtime instance of the workflow. * **message** *(string) --* The output message from the list action, if applicable. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListLifecycleExecutions ListLifecycleExecutions *********************** class imagebuilder.Paginator.ListLifecycleExecutions paginator = client.get_paginator('list_lifecycle_executions') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_lifecycle_executions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( resourceArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource for which to get a list of lifecycle runtime instances. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'lifecycleExecutions': [ { 'lifecycleExecutionId': 'string', 'lifecyclePolicyArn': 'string', 'resourcesImpactedSummary': { 'hasImpactedResources': True|False }, 'state': { 'status': 'IN_PROGRESS'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'PENDING', 'reason': 'string' }, 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **lifecycleExecutions** *(list) --* A list of lifecycle runtime instances for the specified resource. * *(dict) --* Contains metadata from a runtime instance of a lifecycle policy. * **lifecycleExecutionId** *(string) --* Identifies the lifecycle policy runtime instance. * **lifecyclePolicyArn** *(string) --* The Amazon Resource Name (ARN) of the lifecycle policy that ran. * **resourcesImpactedSummary** *(dict) --* Contains information about associated resources that are identified for action by the runtime instance of the lifecycle policy. * **hasImpactedResources** *(boolean) --* Indicates whether an image resource that was identified for a lifecycle action has associated resources that are also impacted. * **state** *(dict) --* Runtime state that reports if the policy action ran successfully, failed, or was skipped. * **status** *(string) --* The runtime status of the lifecycle execution. * **reason** *(string) --* The reason for the current status. * **startTime** *(datetime) --* The timestamp when the lifecycle runtime instance started. * **endTime** *(datetime) --* The timestamp when the lifecycle runtime instance completed. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListLifecycleExecutionResources ListLifecycleExecutionResources ******************************* class imagebuilder.Paginator.ListLifecycleExecutionResources paginator = client.get_paginator('list_lifecycle_execution_resources') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_lifecycle_execution_resources()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( lifecycleExecutionId='string', parentResourceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **lifecycleExecutionId** (*string*) -- **[REQUIRED]** Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details. * **parentResourceId** (*string*) -- You can leave this empty to get a list of Image Builder resources that were identified for lifecycle actions. To get a list of associated resources that are impacted for an individual resource (the parent), specify its Amazon Resource Name (ARN). Associated resources are produced from your image and distributed when you run a build, such as AMIs or container images stored in ECR repositories. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'lifecycleExecutionId': 'string', 'lifecycleExecutionState': { 'status': 'IN_PROGRESS'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'PENDING', 'reason': 'string' }, 'resources': [ { 'accountId': 'string', 'resourceId': 'string', 'state': { 'status': 'FAILED'|'IN_PROGRESS'|'SKIPPED'|'SUCCESS', 'reason': 'string' }, 'action': { 'name': 'AVAILABLE'|'DELETE'|'DEPRECATE'|'DISABLE', 'reason': 'string' }, 'region': 'string', 'snapshots': [ { 'snapshotId': 'string', 'state': { 'status': 'FAILED'|'IN_PROGRESS'|'SKIPPED'|'SUCCESS', 'reason': 'string' } }, ], 'imageUris': [ 'string', ], 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **lifecycleExecutionId** *(string) --* Runtime details for the specified runtime instance of the lifecycle policy. * **lifecycleExecutionState** *(dict) --* The current state of the lifecycle runtime instance. * **status** *(string) --* The runtime status of the lifecycle execution. * **reason** *(string) --* The reason for the current status. * **resources** *(list) --* A list of resources that were identified for lifecycle actions. * *(dict) --* Contains details for a resource that the runtime instance of the lifecycle policy identified for action. * **accountId** *(string) --* The account that owns the impacted resource. * **resourceId** *(string) --* Identifies the impacted resource. The resource ID depends on the type of resource, as follows. * Image Builder image resources: Amazon Resource Name (ARN) * Distributed AMIs: AMI ID * Container images distributed to an ECR repository: image URI or SHA Digest * **state** *(dict) --* The runtime state for the lifecycle execution. * **status** *(string) --* The runtime status of the lifecycle action taken for the impacted resource. * **reason** *(string) --* Messaging that clarifies the reason for the assigned status. * **action** *(dict) --* The action to take for the identified resource. * **name** *(string) --* The name of the resource that was identified for a lifecycle policy action. * **reason** *(string) --* The reason why the lifecycle policy action is taken. * **region** *(string) --* The Amazon Web Services Region where the lifecycle execution resource is stored. * **snapshots** *(list) --* A list of associated resource snapshots for the impacted resource if it’s an AMI. * *(dict) --* Contains the state of an impacted snapshot resource that the runtime instance of the lifecycle policy identified for action. * **snapshotId** *(string) --* Identifies the impacted snapshot resource. * **state** *(dict) --* The runtime status of the lifecycle action taken for the snapshot. * **status** *(string) --* The runtime status of the lifecycle action taken for the impacted resource. * **reason** *(string) --* Messaging that clarifies the reason for the assigned status. * **imageUris** *(list) --* For an impacted container image, this identifies a list of URIs for associated container images distributed to ECR repositories. * *(string) --* * **startTime** *(datetime) --* The starting timestamp from the lifecycle action that was applied to the resource. * **endTime** *(datetime) --* The ending timestamp from the lifecycle action that was applied to the resource. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListComponentBuildVersions ListComponentBuildVersions ************************** class imagebuilder.Paginator.ListComponentBuildVersions paginator = client.get_paginator('list_component_build_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_component_build_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( componentVersionArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **componentVersionArn** (*string*) -- **[REQUIRED]** The component version Amazon Resource Name (ARN) whose versions you want to list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'componentSummaryList': [ { 'arn': 'string', 'name': 'string', 'version': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'supportedOsVersions': [ 'string', ], 'state': { 'status': 'DEPRECATED'|'DISABLED'|'ACTIVE', 'reason': 'string' }, 'type': 'BUILD'|'TEST', 'owner': 'string', 'description': 'string', 'changeDescription': 'string', 'dateCreated': 'string', 'tags': { 'string': 'string' }, 'publisher': 'string', 'obfuscate': True|False }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **componentSummaryList** *(list) --* The list of component summaries for the specified semantic version. * *(dict) --* A high-level summary of a component. * **arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **name** *(string) --* The name of the component. * **version** *(string) --* The version of the component. * **platform** *(string) --* The operating system platform of the component. * **supportedOsVersions** *(list) --* 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. * *(string) --* * **state** *(dict) --* Describes the current status of the component. * **status** *(string) --* The current state of the component. * **reason** *(string) --* Describes how or why the component changed state. * **type** *(string) --* The component type specifies whether Image Builder uses the component to build the image or only to test it. * **owner** *(string) --* The owner of the component. * **description** *(string) --* The description of the component. * **changeDescription** *(string) --* The change description for the current version of the component. * **dateCreated** *(string) --* The original creation date of the component. * **tags** *(dict) --* The tags that apply to the component. * *(string) --* * *(string) --* * **publisher** *(string) --* Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty. * **obfuscate** *(boolean) --* Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListWorkflowExecutions ListWorkflowExecutions ********************** class imagebuilder.Paginator.ListWorkflowExecutions paginator = client.get_paginator('list_workflow_executions') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_workflow_executions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( imageBuildVersionArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **imageBuildVersionArn** (*string*) -- **[REQUIRED]** List all workflow runtime instances for the specified image build version resource ARN. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'workflowExecutions': [ { 'workflowBuildVersionArn': 'string', 'workflowExecutionId': 'string', 'type': 'BUILD'|'TEST'|'DISTRIBUTION', 'status': 'PENDING'|'SKIPPED'|'RUNNING'|'COMPLETED'|'FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETED'|'CANCELLED', 'message': 'string', 'totalStepCount': 123, 'totalStepsSucceeded': 123, 'totalStepsFailed': 123, 'totalStepsSkipped': 123, 'startTime': 'string', 'endTime': 'string', 'parallelGroup': 'string' }, ], 'imageBuildVersionArn': 'string', 'message': 'string', 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **workflowExecutions** *(list) --* Contains an array of runtime details that represents each time a workflow ran for the requested image build version. * *(dict) --* Metadata that includes details and status from this runtime instance of the workflow. * **workflowBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the workflow resource build version that ran. * **workflowExecutionId** *(string) --* Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow. * **type** *(string) --* Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow. * **status** *(string) --* The current runtime status for this workflow. * **message** *(string) --* The runtime output message from the workflow, if applicable. * **totalStepCount** *(integer) --* 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. * **totalStepsSucceeded** *(integer) --* A runtime count for the number of steps in the workflow that ran successfully. * **totalStepsFailed** *(integer) --* A runtime count for the number of steps in the workflow that failed. * **totalStepsSkipped** *(integer) --* A runtime count for the number of steps in the workflow that were skipped. * **startTime** *(string) --* The timestamp when the runtime instance of this workflow started. * **endTime** *(string) --* The timestamp when this runtime instance of the workflow finished. * **parallelGroup** *(string) --* The name of the test group that included the test workflow resource at runtime. * **imageBuildVersionArn** *(string) --* The resource ARN of the image build version for which you requested a list of workflow runtime details. * **message** *(string) --* The output message from the list action, if applicable. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListWorkflowBuildVersions ListWorkflowBuildVersions ************************* class imagebuilder.Paginator.ListWorkflowBuildVersions paginator = client.get_paginator('list_workflow_build_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_workflow_build_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( workflowVersionArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **workflowVersionArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the workflow resource for which to get a list of build versions. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'workflowSummaryList': [ { 'arn': 'string', 'name': 'string', 'version': 'string', 'description': 'string', 'changeDescription': 'string', 'type': 'BUILD'|'TEST'|'DISTRIBUTION', 'owner': 'string', 'state': { 'status': 'DEPRECATED', 'reason': 'string' }, 'dateCreated': 'string', 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **workflowSummaryList** *(list) --* A list that contains metadata for the workflow builds that have run for the workflow resource specified in the request. * *(dict) --* Contains metadata about the workflow resource. * **arn** *(string) --* The Amazon Resource Name (ARN) of the workflow resource. * **name** *(string) --* The name of the workflow. * **version** *(string) --* The version of the workflow. * **description** *(string) --* Describes the workflow. * **changeDescription** *(string) --* The change description for the current version of the workflow resource. * **type** *(string) --* The image creation stage that this workflow applies to. Image Builder currently supports build and test stage workflows. * **owner** *(string) --* The owner of the workflow resource. * **state** *(dict) --* Describes the current state of the workflow resource. * **status** *(string) --* The current state of the workflow. * **reason** *(string) --* Describes how or why the workflow changed state. * **dateCreated** *(string) --* The original creation date of the workflow resource. * **tags** *(dict) --* Contains a list of tags that are defined for the workflow. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListImagePipelines ListImagePipelines ****************** class imagebuilder.Paginator.ListImagePipelines paginator = client.get_paginator('list_image_pipelines') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_image_pipelines()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **filters** (*list*) -- Use the following filters to streamline results: * "description" * "distributionConfigurationArn" * "imageRecipeArn" * "infrastructureConfigurationArn" * "name" * "status" * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case- sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imagePipelineList': [ { 'arn': 'string', 'name': 'string', 'description': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'enhancedImageMetadataEnabled': True|False, 'imageRecipeArn': 'string', 'containerRecipeArn': 'string', 'infrastructureConfigurationArn': 'string', 'distributionConfigurationArn': 'string', 'imageTestsConfiguration': { 'imageTestsEnabled': True|False, 'timeoutMinutes': 123 }, 'schedule': { 'scheduleExpression': 'string', 'timezone': 'string', 'pipelineExecutionStartCondition': 'EXPRESSION_MATCH_ONLY'|'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE' }, 'status': 'DISABLED'|'ENABLED', 'dateCreated': 'string', 'dateUpdated': 'string', 'dateLastRun': 'string', 'dateNextRun': 'string', 'tags': { 'string': 'string' }, 'imageScanningConfiguration': { 'imageScanningEnabled': True|False, 'ecrConfiguration': { 'repositoryName': 'string', 'containerTags': [ 'string', ] } }, 'executionRole': 'string', 'workflows': [ { 'workflowArn': 'string', 'parameters': [ { 'name': 'string', 'value': [ 'string', ] }, ], 'parallelGroup': 'string', 'onFailure': 'CONTINUE'|'ABORT' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imagePipelineList** *(list) --* The list of image pipelines. * *(dict) --* Details of an image pipeline. * **arn** *(string) --* The Amazon Resource Name (ARN) of the image pipeline. * **name** *(string) --* The name of the image pipeline. * **description** *(string) --* The description of the image pipeline. * **platform** *(string) --* The platform of the image pipeline. * **enhancedImageMetadataEnabled** *(boolean) --* Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default. * **imageRecipeArn** *(string) --* The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline. * **containerRecipeArn** *(string) --* The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline. * **infrastructureConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline. * **distributionConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline. * **imageTestsConfiguration** *(dict) --* The image tests configuration of the image pipeline. * **imageTestsEnabled** *(boolean) --* Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution. * **timeoutMinutes** *(integer) --* The maximum time in minutes that tests are permitted to run. Note: The timeout property is not currently active. This value is ignored. * **schedule** *(dict) --* The schedule of the image pipeline. * **scheduleExpression** *(string) --* The cron expression determines how often EC2 Image Builder evaluates your "pipelineExecutionStartCondition". For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder. * **timezone** *(string) --* The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC. * **pipelineExecutionStartCondition** *(string) --* The start condition configures when the pipeline should trigger a new image build, as follows. If no value is set Image Builder defaults to "EXPRESSION _MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE". * "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILAB LE" (default) – When you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder builds a new image only when there are new versions of the base image or components in your recipe that match the filter. Note: For semantic version syntax, see CreateComponent. * "EXPRESSION_MATCH_ONLY" – This condition builds a new image every time the CRON expression matches the current time. * **status** *(string) --* The status of the image pipeline. * **dateCreated** *(string) --* The date on which this image pipeline was created. * **dateUpdated** *(string) --* The date on which this image pipeline was last updated. * **dateLastRun** *(string) --* This is no longer supported, and does not return a value. * **dateNextRun** *(string) --* The next date when the pipeline is scheduled to run. * **tags** *(dict) --* The tags of this image pipeline. * *(string) --* * *(string) --* * **imageScanningConfiguration** *(dict) --* Contains settings for vulnerability scans. * **imageScanningEnabled** *(boolean) --* A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image. * **ecrConfiguration** *(dict) --* Contains Amazon ECR settings for vulnerability scans. * **repositoryName** *(string) --* 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. * **containerTags** *(list) --* Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can help you identify and manage your scanned images. * *(string) --* * **executionRole** *(string) --* The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions. * **workflows** *(list) --* Contains the workflows that run for the image pipeline. * *(dict) --* Contains control settings and configurable inputs for a workflow resource. * **workflowArn** *(string) --* The Amazon Resource Name (ARN) of the workflow resource. * **parameters** *(list) --* Contains parameter values for each of the parameters that the workflow document defined for the workflow resource. * *(dict) --* Contains a key/value pair that sets the named workflow parameter. * **name** *(string) --* The name of the workflow parameter to set. * **value** *(list) --* Sets the value for the named workflow parameter. * *(string) --* * **parallelGroup** *(string) --* Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows. * **onFailure** *(string) --* The action to take if the workflow fails. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListImagePackages ListImagePackages ***************** class imagebuilder.Paginator.ListImagePackages paginator = client.get_paginator('list_image_packages') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_image_packages()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( imageBuildVersionArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **imageBuildVersionArn** (*string*) -- **[REQUIRED]** Filter results for the ListImagePackages request by the Image Build Version ARN * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imagePackageList': [ { 'packageName': 'string', 'packageVersion': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imagePackageList** *(list) --* The list of Image Packages returned in the response. * *(dict) --* A software package that's installed on top of the base image to create a customized image. * **packageName** *(string) --* The name of the package that's reported to the operating system package manager. * **packageVersion** *(string) --* The version of the package that's reported to the operating system package manager. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListDistributionConfigurations ListDistributionConfigurations ****************************** class imagebuilder.Paginator.ListDistributionConfigurations paginator = client.get_paginator('list_distribution_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_distribution_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **filters** (*list*) -- You can filter on "name" to streamline results. * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case- sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'distributionConfigurationSummaryList': [ { 'arn': 'string', 'name': 'string', 'description': 'string', 'dateCreated': 'string', 'dateUpdated': 'string', 'tags': { 'string': 'string' }, 'regions': [ 'string', ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **distributionConfigurationSummaryList** *(list) --* The list of distributions. * *(dict) --* A high-level overview of a distribution configuration. * **arn** *(string) --* The Amazon Resource Name (ARN) of the distribution configuration. * **name** *(string) --* The name of the distribution configuration. * **description** *(string) --* The description of the distribution configuration. * **dateCreated** *(string) --* The date on which the distribution configuration was created. * **dateUpdated** *(string) --* The date on which the distribution configuration was updated. * **tags** *(dict) --* The tags associated with the distribution configuration. * *(string) --* * *(string) --* * **regions** *(list) --* A list of Regions where the container image is distributed to. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListImages ListImages ********** class imagebuilder.Paginator.ListImages paginator = client.get_paginator('list_images') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_images()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( owner='Self'|'Shared'|'Amazon'|'ThirdParty'|'AWSMarketplace', filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], byName=True|False, includeDeprecated=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **owner** (*string*) -- 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. * **filters** (*list*) -- Use the following filters to streamline results: * "name" * "osVersion" * "platform" * "type" * "version" * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case- sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **byName** (*boolean*) -- Requests a list of images with a specific recipe name. * **includeDeprecated** (*boolean*) -- Includes deprecated images in the response list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imageVersionList': [ { 'arn': 'string', 'name': 'string', 'type': 'AMI'|'DOCKER', 'version': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'osVersion': 'string', 'owner': 'string', 'dateCreated': 'string', 'buildType': 'USER_INITIATED'|'SCHEDULED'|'IMPORT'|'IMPORT_ISO', 'imageSource': 'AMAZON_MANAGED'|'AWS_MARKETPLACE'|'IMPORTED'|'CUSTOM' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imageVersionList** *(list) --* The list of image semantic versions. Note: The semantic version has four nodes: ../. 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. * *(dict) --* The defining characteristics of a specific version of an Image Builder image. * **arn** *(string) --* The Amazon Resource Name (ARN) of a specific version of an Image Builder image. Note: 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: .. * Build version ARNs have all four nodes, and point to a specific build for a specific version of an object. * **name** *(string) --* The name of this specific version of an Image Builder image. * **type** *(string) --* Specifies whether this image produces an AMI or a container image. * **version** *(string) --* Details for a specific version of an Image Builder image. This version follows the semantic version syntax. Note: The semantic version has four nodes: ../. 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. * **platform** *(string) --* The operating system platform of the image version, for example "Windows" or "Linux". * **osVersion** *(string) --* The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019. * **owner** *(string) --* The owner of the image version. * **dateCreated** *(string) --* The date on which this specific version of the Image Builder image was created. * **buildType** *(string) --* 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. * **IMPORT_ISO** – An ISO disk import created the image. * **imageSource** *(string) --* The origin of the base image that Image Builder used to build this image. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListImageScanFindingAggregations ListImageScanFindingAggregations ******************************** class imagebuilder.Paginator.ListImageScanFindingAggregations paginator = client.get_paginator('list_image_scan_finding_aggregations') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_image_scan_finding_aggregations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filter={ 'name': 'string', 'values': [ 'string', ] }, PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: * **filter** (*dict*) -- 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. * **name** *(string) --* The name of the filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'aggregationType': 'string', 'responses': [ { 'accountAggregation': { 'accountId': 'string', 'severityCounts': { 'all': 123, 'critical': 123, 'high': 123, 'medium': 123 } }, 'imageAggregation': { 'imageBuildVersionArn': 'string', 'severityCounts': { 'all': 123, 'critical': 123, 'high': 123, 'medium': 123 } }, 'imagePipelineAggregation': { 'imagePipelineArn': 'string', 'severityCounts': { 'all': 123, 'critical': 123, 'high': 123, 'medium': 123 } }, 'vulnerabilityIdAggregation': { 'vulnerabilityId': 'string', 'severityCounts': { 'all': 123, 'critical': 123, 'high': 123, 'medium': 123 } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **aggregationType** *(string) --* 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. * **responses** *(list) --* An array of image scan finding aggregations that match the filter criteria. * *(dict) --* This returns exactly one type of aggregation, based on the filter that Image Builder applies in its API action. * **accountAggregation** *(dict) --* Returns an object that contains severity counts based on an account ID. * **accountId** *(string) --* Identifies the account that owns the aggregated resource findings. * **severityCounts** *(dict) --* Counts by severity level for medium severity and higher level findings, plus a total for all of the findings. * **all** *(integer) --* The total number of findings across all severity levels for the specified filter. * **critical** *(integer) --* The number of critical severity findings for the specified filter. * **high** *(integer) --* The number of high severity findings for the specified filter. * **medium** *(integer) --* The number of medium severity findings for the specified filter. * **imageAggregation** *(dict) --* Returns an object that contains severity counts based on the Amazon Resource Name (ARN) for a specific image. * **imageBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) that identifies the image for this aggregation. * **severityCounts** *(dict) --* Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image. * **all** *(integer) --* The total number of findings across all severity levels for the specified filter. * **critical** *(integer) --* The number of critical severity findings for the specified filter. * **high** *(integer) --* The number of high severity findings for the specified filter. * **medium** *(integer) --* The number of medium severity findings for the specified filter. * **imagePipelineAggregation** *(dict) --* Returns an object that contains severity counts based on an image pipeline ARN. * **imagePipelineArn** *(string) --* The Amazon Resource Name (ARN) that identifies the image pipeline for this aggregation. * **severityCounts** *(dict) --* Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image pipeline. * **all** *(integer) --* The total number of findings across all severity levels for the specified filter. * **critical** *(integer) --* The number of critical severity findings for the specified filter. * **high** *(integer) --* The number of high severity findings for the specified filter. * **medium** *(integer) --* The number of medium severity findings for the specified filter. * **vulnerabilityIdAggregation** *(dict) --* Returns an object that contains severity counts based on vulnerability ID. * **vulnerabilityId** *(string) --* The vulnerability Id for this set of counts. * **severityCounts** *(dict) --* Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified vulnerability. * **all** *(integer) --* The total number of findings across all severity levels for the specified filter. * **critical** *(integer) --* The number of critical severity findings for the specified filter. * **high** *(integer) --* The number of high severity findings for the specified filter. * **medium** *(integer) --* The number of medium severity findings for the specified filter. * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Paginator / ListImageRecipes ListImageRecipes **************** class imagebuilder.Paginator.ListImageRecipes paginator = client.get_paginator('list_image_recipes') paginate(**kwargs) Creates an iterator that will paginate through responses from "imagebuilder.Client.list_image_recipes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( owner='Self'|'Shared'|'Amazon'|'ThirdParty'|'AWSMarketplace', filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **owner** (*string*) -- 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. * **filters** (*list*) -- Use the following filters to streamline results: * "name" * "parentImage" * "platform" * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case- sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imageRecipeSummaryList': [ { 'arn': 'string', 'name': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'owner': 'string', 'parentImage': 'string', 'dateCreated': 'string', 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imageRecipeSummaryList** *(list) --* The list of image pipelines. * *(dict) --* A summary of an image recipe. * **arn** *(string) --* The Amazon Resource Name (ARN) of the image recipe. * **name** *(string) --* The name of the image recipe. * **platform** *(string) --* The platform of the image recipe. * **owner** *(string) --* The owner of the image recipe. * **parentImage** *(string) --* The base image of the image recipe. * **dateCreated** *(string) --* The date on which this image recipe was created. * **tags** *(dict) --* The tags of the image recipe. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. imagebuilder / Client / put_component_policy put_component_policy ******************** imagebuilder.Client.put_component_policy(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.put_component_policy( componentArn='string', policy='string' ) Parameters: * **componentArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the component that this policy should be applied to. * **policy** (*string*) -- **[REQUIRED]** The policy to apply. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'componentArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **componentArn** *(string) --* The Amazon Resource Name (ARN) of the component that this policy was applied to. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidParameterValueException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / delete_component delete_component **************** imagebuilder.Client.delete_component(**kwargs) Deletes a component build version. See also: AWS API Documentation **Request Syntax** response = client.delete_component( componentBuildVersionArn='string' ) Parameters: **componentBuildVersionArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the component build version to delete. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'componentBuildVersionArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **componentBuildVersionArn** *(string) --* The ARN of the component build version that this request deleted. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceDependencyException" imagebuilder / Client / list_image_scan_findings list_image_scan_findings ************************ imagebuilder.Client.list_image_scan_findings(**kwargs) Returns a list of image scan findings for your account. See also: AWS API Documentation **Request Syntax** response = client.list_image_scan_findings( filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], maxResults=123, nextToken='string' ) Parameters: * **filters** (*list*) -- 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. * *(dict) --* A name value pair that Image Builder applies to streamline results from the vulnerability scan findings list action. * **name** *(string) --* The name of the image scan finding filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'findings': [ { 'awsAccountId': 'string', 'imageBuildVersionArn': 'string', 'imagePipelineArn': 'string', 'type': 'string', 'description': 'string', 'title': 'string', 'remediation': { 'recommendation': { 'text': 'string', 'url': 'string' } }, 'severity': 'string', 'firstObservedAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'inspectorScore': 123.0, 'inspectorScoreDetails': { 'adjustedCvss': { 'scoreSource': 'string', 'cvssSource': 'string', 'version': 'string', 'score': 123.0, 'scoringVector': 'string', 'adjustments': [ { 'metric': 'string', 'reason': 'string' }, ] } }, 'packageVulnerabilityDetails': { 'vulnerabilityId': 'string', 'vulnerablePackages': [ { 'name': 'string', 'version': 'string', 'sourceLayerHash': 'string', 'epoch': 123, 'release': 'string', 'arch': 'string', 'packageManager': 'string', 'filePath': 'string', 'fixedInVersion': 'string', 'remediation': 'string' }, ], 'source': 'string', 'cvss': [ { 'baseScore': 123.0, 'scoringVector': 'string', 'version': 'string', 'source': 'string' }, ], 'relatedVulnerabilities': [ 'string', ], 'sourceUrl': 'string', 'vendorSeverity': 'string', 'vendorCreatedAt': datetime(2015, 1, 1), 'vendorUpdatedAt': datetime(2015, 1, 1), 'referenceUrls': [ 'string', ] }, 'fixAvailable': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **findings** *(list) --* The image scan findings for your account that meet your request filter criteria. * *(dict) --* Contains details about a vulnerability scan finding. * **awsAccountId** *(string) --* The Amazon Web Services account ID that's associated with the finding. * **imageBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the image build version that's associated with the finding. * **imagePipelineArn** *(string) --* The Amazon Resource Name (ARN) of the image pipeline that's associated with the finding. * **type** *(string) --* The type of the finding. Image Builder looks for findings of the type "PACKAGE_VULNERABILITY" that apply to output images, and excludes other types. * **description** *(string) --* The description of the finding. * **title** *(string) --* The title of the finding. * **remediation** *(dict) --* An object that contains the details about how to remediate the finding. * **recommendation** *(dict) --* An object that contains information about the recommended course of action to remediate the finding. * **text** *(string) --* The recommended course of action to remediate the finding. * **url** *(string) --* A link to more information about the recommended remediation for this vulnerability. * **severity** *(string) --* The severity of the finding. * **firstObservedAt** *(datetime) --* The date and time when the finding was first observed. * **updatedAt** *(datetime) --* The timestamp when the finding was last updated. * **inspectorScore** *(float) --* The score that Amazon Inspector assigned for the finding. * **inspectorScoreDetails** *(dict) --* An object that contains details of the Amazon Inspector score. * **adjustedCvss** *(dict) --* An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding. * **scoreSource** *(string) --* The source for the CVSS score. * **cvssSource** *(string) --* The source of the finding. * **version** *(string) --* The CVSS version that generated the score. * **score** *(float) --* The CVSS score. * **scoringVector** *(string) --* A vector that measures the severity of the vulnerability. * **adjustments** *(list) --* An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding. * *(dict) --* Details about an adjustment that Amazon Inspector made to the CVSS score for a finding. * **metric** *(string) --* The metric that Amazon Inspector used to adjust the CVSS score. * **reason** *(string) --* The reason for the CVSS score adjustment. * **packageVulnerabilityDetails** *(dict) --* An object that contains the details of a package vulnerability finding. * **vulnerabilityId** *(string) --* A unique identifier for this vulnerability. * **vulnerablePackages** *(list) --* The packages that this vulnerability impacts. * *(dict) --* Information about a vulnerable package that Amazon Inspector identifies in a finding. * **name** *(string) --* The name of the vulnerable package. * **version** *(string) --* The version of the vulnerable package. * **sourceLayerHash** *(string) --* The source layer hash of the vulnerable package. * **epoch** *(integer) --* The epoch of the vulnerable package. * **release** *(string) --* The release of the vulnerable package. * **arch** *(string) --* The architecture of the vulnerable package. * **packageManager** *(string) --* The package manager of the vulnerable package. * **filePath** *(string) --* The file path of the vulnerable package. * **fixedInVersion** *(string) --* The version of the package that contains the vulnerability fix. * **remediation** *(string) --* The code to run in your environment to update packages with a fix available. * **source** *(string) --* The source of the vulnerability information. * **cvss** *(list) --* CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a package. * *(dict) --* 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*. * **baseScore** *(float) --* The CVSS base score. * **scoringVector** *(string) --* The vector string of the CVSS score. * **version** *(string) --* The CVSS version that generated the score. * **source** *(string) --* The source of the CVSS score. * **relatedVulnerabilities** *(list) --* Vulnerabilities that are often related to the findings for the package. * *(string) --* * **sourceUrl** *(string) --* A link to the source of the vulnerability information. * **vendorSeverity** *(string) --* The severity that the vendor assigned to this vulnerability type. * **vendorCreatedAt** *(datetime) --* The date and time when this vulnerability was first added to the vendor's database. * **vendorUpdatedAt** *(datetime) --* The date and time when the vendor last updated this vulnerability in their database. * **referenceUrls** *(list) --* Links to web pages that contain details about the vulnerabilities that Amazon Inspector identified for the package. * *(string) --* * **fixAvailable** *(string) --* Details about whether a fix is available for any of the packages that are identified in the finding through a version update. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / cancel_image_creation cancel_image_creation ********************* imagebuilder.Client.cancel_image_creation(**kwargs) CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state. See also: AWS API Documentation **Request Syntax** response = client.cancel_image_creation( imageBuildVersionArn='string', clientToken='string' ) Parameters: * **imageBuildVersionArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image that you want to cancel creation for. * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'clientToken': 'string', 'imageBuildVersionArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **clientToken** *(string) --* The client token that uniquely identifies the request. * **imageBuildVersionArn** *(string) --* The ARN of the image whose creation this request canceled. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceInUseException" imagebuilder / Client / get_paginator get_paginator ************* imagebuilder.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. imagebuilder / Client / list_components list_components *************** imagebuilder.Client.list_components(**kwargs) 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. Note: The semantic version has four nodes: ../. 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. See also: AWS API Documentation **Request Syntax** response = client.list_components( owner='Self'|'Shared'|'Amazon'|'ThirdParty'|'AWSMarketplace', filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], byName=True|False, maxResults=123, nextToken='string' ) Parameters: * **owner** (*string*) -- 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. * **filters** (*list*) -- Use the following filters to streamline results: * "description" * "name" * "platform" * "supportedOsVersion" * "type" * "version" * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **byName** (*boolean*) -- Returns the list of components for the specified name. * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'componentVersionList': [ { 'arn': 'string', 'name': 'string', 'version': 'string', 'description': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'supportedOsVersions': [ 'string', ], 'type': 'BUILD'|'TEST', 'owner': 'string', 'dateCreated': 'string', 'status': 'DEPRECATED'|'DISABLED'|'ACTIVE', 'productCodes': [ { 'productCodeId': 'string', 'productCodeType': 'marketplace' }, ] }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **componentVersionList** *(list) --* The list of component semantic versions. Note: The semantic version has four nodes: ../. You can assign values for the first three, and can filter on all of them. * *(dict) --* The defining characteristics of a specific version of an Amazon Web Services TOE component. * **arn** *(string) --* The Amazon Resource Name (ARN) of the component. Note: 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: .. * Build version ARNs have all four nodes, and point to a specific build for a specific version of an object. * **name** *(string) --* The name of the component. * **version** *(string) --* The semantic version of the component. Note: The semantic version has four nodes: ../. 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. * **description** *(string) --* The description of the component. * **platform** *(string) --* The platform of the component. * **supportedOsVersions** *(list) --* 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. * *(string) --* * **type** *(string) --* The type of the component denotes whether the component is used to build the image or only to test it. * **owner** *(string) --* The owner of the component. * **dateCreated** *(string) --* The date that the component was created. * **status** *(string) --* Describes the current status of the component version. * **productCodes** *(list) --* Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components. * *(dict) --* Information about a single product code. * **productCodeId** *(string) --* For Amazon Web Services Marketplace components, this contains the product code ID that can be stamped onto an EC2 AMI to ensure that components are billed correctly. If this property is empty, it might mean that the component is not published. * **productCodeType** *(string) --* The owner of the product code that's billed. If this property is empty, it might mean that the component is not published. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / list_workflow_step_executions list_workflow_step_executions ***************************** imagebuilder.Client.list_workflow_step_executions(**kwargs) Returns runtime data for each step in a runtime instance of the workflow that you specify in the request. See also: AWS API Documentation **Request Syntax** response = client.list_workflow_step_executions( maxResults=123, nextToken='string', workflowExecutionId='string' ) Parameters: * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. * **workflowExecutionId** (*string*) -- **[REQUIRED]** The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'steps': [ { 'stepExecutionId': 'string', 'name': 'string', 'description': 'string', 'action': 'string', 'status': 'PENDING'|'SKIPPED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLED', 'rollbackStatus': 'RUNNING'|'COMPLETED'|'SKIPPED'|'FAILED', 'message': 'string', 'inputs': 'string', 'outputs': 'string', 'startTime': 'string', 'endTime': 'string' }, ], 'workflowBuildVersionArn': 'string', 'workflowExecutionId': 'string', 'imageBuildVersionArn': 'string', 'message': 'string', 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **steps** *(list) --* Contains an array of runtime details that represents each step in this runtime instance of the workflow. * *(dict) --* Runtime details and status for the workflow step. * **stepExecutionId** *(string) --* A unique identifier for the workflow step, assigned at runtime. * **name** *(string) --* The name of the workflow step. * **description** *(string) --* Description of the workflow step. * **action** *(string) --* The step action name. * **status** *(string) --* Runtime status for the workflow step. * **rollbackStatus** *(string) --* Reports on the rollback status of the step, if applicable. * **message** *(string) --* Detailed output message that the workflow step provides at runtime. * **inputs** *(string) --* Input parameters that Image Builder provides for the workflow step. * **outputs** *(string) --* The file names that the workflow step created as output for this runtime instance of the workflow. * **startTime** *(string) --* The timestamp when the workflow step started. * **endTime** *(string) --* The timestamp when the workflow step finished. * **workflowBuildVersionArn** *(string) --* The build version ARN for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow. * **workflowExecutionId** *(string) --* The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow. * **imageBuildVersionArn** *(string) --* The image build version resource ARN that's associated with the specified runtime instance of the workflow. * **message** *(string) --* The output message from the list action, if applicable. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / get_infrastructure_configuration get_infrastructure_configuration ******************************** imagebuilder.Client.get_infrastructure_configuration(**kwargs) Gets an infrastructure configuration. See also: AWS API Documentation **Request Syntax** response = client.get_infrastructure_configuration( infrastructureConfigurationArn='string' ) Parameters: **infrastructureConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'infrastructureConfiguration': { 'arn': 'string', 'name': 'string', 'description': 'string', 'instanceTypes': [ 'string', ], 'instanceProfileName': 'string', 'securityGroupIds': [ 'string', ], 'subnetId': 'string', 'logging': { 's3Logs': { 's3BucketName': 'string', 's3KeyPrefix': 'string' } }, 'keyPair': 'string', 'terminateInstanceOnFailure': True|False, 'snsTopicArn': 'string', 'dateCreated': 'string', 'dateUpdated': 'string', 'resourceTags': { 'string': 'string' }, 'instanceMetadataOptions': { 'httpTokens': 'string', 'httpPutResponseHopLimit': 123 }, 'tags': { 'string': 'string' }, 'placement': { 'availabilityZone': 'string', 'tenancy': 'default'|'dedicated'|'host', 'hostId': 'string', 'hostResourceGroupArn': 'string' } } } **Response Structure** * *(dict) --* GetInfrastructureConfiguration response object. * **requestId** *(string) --* The request ID that uniquely identifies this request. * **infrastructureConfiguration** *(dict) --* The infrastructure configuration object. * **arn** *(string) --* The Amazon Resource Name (ARN) of the infrastructure configuration. * **name** *(string) --* The name of the infrastructure configuration. * **description** *(string) --* The description of the infrastructure configuration. * **instanceTypes** *(list) --* The instance types of the infrastructure configuration. * *(string) --* * **instanceProfileName** *(string) --* The instance profile of the infrastructure configuration. * **securityGroupIds** *(list) --* The security group IDs of the infrastructure configuration. * *(string) --* * **subnetId** *(string) --* The subnet ID of the infrastructure configuration. * **logging** *(dict) --* The logging configuration of the infrastructure configuration. * **s3Logs** *(dict) --* The Amazon S3 logging configuration. * **s3BucketName** *(string) --* The S3 bucket in which to store the logs. * **s3KeyPrefix** *(string) --* The Amazon S3 path to the bucket where the logs are stored. * **keyPair** *(string) --* The Amazon EC2 key pair of the infrastructure configuration. * **terminateInstanceOnFailure** *(boolean) --* The terminate instance on failure configuration of the infrastructure configuration. * **snsTopicArn** *(string) --* The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications. Note: 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. * **dateCreated** *(string) --* The date on which the infrastructure configuration was created. * **dateUpdated** *(string) --* The date on which the infrastructure configuration was last updated. * **resourceTags** *(dict) --* The tags attached to the resource created by Image Builder. * *(string) --* * *(string) --* * **instanceMetadataOptions** *(dict) --* The instance metadata option settings for the infrastructure configuration. * **httpTokens** *(string) --* 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**. * **httpPutResponseHopLimit** *(integer) --* 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. * **tags** *(dict) --* The tags of the infrastructure configuration. * *(string) --* * *(string) --* * **placement** *(dict) --* The instance placement settings that define where the instances that are launched from your image will run. * **availabilityZone** *(string) --* The Availability Zone where your build and test instances will launch. * **tenancy** *(string) --* The tenancy of the instance. An instance with a tenancy of "dedicated" runs on single-tenant hardware. An instance with a tenancy of "host" runs on a Dedicated Host. If tenancy is set to "host", then you can optionally specify one target for placement – either host ID or host resource group ARN. If automatic placement is enabled for your host, and you don't specify any placement target, Amazon EC2 will try to find an available host for your build and test instances. * **hostId** *(string) --* The ID of the Dedicated Host on which build and test instances run. This only applies if "tenancy" is "host". If you specify the host ID, you must not specify the resource group ARN. If you specify both, Image Builder returns an error. * **hostResourceGroupArn** *(string) --* The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances. This only applies if "tenancy" is "host". If you specify the resource group ARN, you must not specify the host ID. If you specify both, Image Builder returns an error. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / get_component_policy get_component_policy ******************** imagebuilder.Client.get_component_policy(**kwargs) Gets a component policy. See also: AWS API Documentation **Request Syntax** response = client.get_component_policy( componentArn='string' ) Parameters: **componentArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the component whose policy you want to retrieve. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'policy': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **policy** *(string) --* The component policy. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / can_paginate can_paginate ************ imagebuilder.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. imagebuilder / Client / list_distribution_configurations list_distribution_configurations ******************************** imagebuilder.Client.list_distribution_configurations(**kwargs) Returns a list of distribution configurations. See also: AWS API Documentation **Request Syntax** response = client.list_distribution_configurations( filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], maxResults=123, nextToken='string' ) Parameters: * **filters** (*list*) -- You can filter on "name" to streamline results. * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'distributionConfigurationSummaryList': [ { 'arn': 'string', 'name': 'string', 'description': 'string', 'dateCreated': 'string', 'dateUpdated': 'string', 'tags': { 'string': 'string' }, 'regions': [ 'string', ] }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **distributionConfigurationSummaryList** *(list) --* The list of distributions. * *(dict) --* A high-level overview of a distribution configuration. * **arn** *(string) --* The Amazon Resource Name (ARN) of the distribution configuration. * **name** *(string) --* The name of the distribution configuration. * **description** *(string) --* The description of the distribution configuration. * **dateCreated** *(string) --* The date on which the distribution configuration was created. * **dateUpdated** *(string) --* The date on which the distribution configuration was updated. * **tags** *(dict) --* The tags associated with the distribution configuration. * *(string) --* * *(string) --* * **regions** *(list) --* A list of Regions where the container image is distributed to. * *(string) --* * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / delete_distribution_configuration delete_distribution_configuration ********************************* imagebuilder.Client.delete_distribution_configuration(**kwargs) Deletes a distribution configuration. See also: AWS API Documentation **Request Syntax** response = client.delete_distribution_configuration( distributionConfigurationArn='string' ) Parameters: **distributionConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the distribution configuration to delete. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'distributionConfigurationArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **distributionConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the distribution configuration that was deleted. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceDependencyException" imagebuilder / Client / get_image_policy get_image_policy **************** imagebuilder.Client.get_image_policy(**kwargs) Gets an image policy. See also: AWS API Documentation **Request Syntax** response = client.get_image_policy( imageArn='string' ) Parameters: **imageArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image whose policy you want to retrieve. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'policy': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **policy** *(string) --* The image policy object. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / list_workflow_build_versions list_workflow_build_versions **************************** imagebuilder.Client.list_workflow_build_versions(**kwargs) Returns a list of build versions for a specific workflow resource. See also: AWS API Documentation **Request Syntax** response = client.list_workflow_build_versions( workflowVersionArn='string', maxResults=123, nextToken='string' ) Parameters: * **workflowVersionArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the workflow resource for which to get a list of build versions. * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'workflowSummaryList': [ { 'arn': 'string', 'name': 'string', 'version': 'string', 'description': 'string', 'changeDescription': 'string', 'type': 'BUILD'|'TEST'|'DISTRIBUTION', 'owner': 'string', 'state': { 'status': 'DEPRECATED', 'reason': 'string' }, 'dateCreated': 'string', 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **workflowSummaryList** *(list) --* A list that contains metadata for the workflow builds that have run for the workflow resource specified in the request. * *(dict) --* Contains metadata about the workflow resource. * **arn** *(string) --* The Amazon Resource Name (ARN) of the workflow resource. * **name** *(string) --* The name of the workflow. * **version** *(string) --* The version of the workflow. * **description** *(string) --* Describes the workflow. * **changeDescription** *(string) --* The change description for the current version of the workflow resource. * **type** *(string) --* The image creation stage that this workflow applies to. Image Builder currently supports build and test stage workflows. * **owner** *(string) --* The owner of the workflow resource. * **state** *(dict) --* Describes the current state of the workflow resource. * **status** *(string) --* The current state of the workflow. * **reason** *(string) --* Describes how or why the workflow changed state. * **dateCreated** *(string) --* The original creation date of the workflow resource. * **tags** *(dict) --* Contains a list of tags that are defined for the workflow. * *(string) --* * *(string) --* * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / list_image_recipes list_image_recipes ****************** imagebuilder.Client.list_image_recipes(**kwargs) Returns a list of image recipes. See also: AWS API Documentation **Request Syntax** response = client.list_image_recipes( owner='Self'|'Shared'|'Amazon'|'ThirdParty'|'AWSMarketplace', filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], maxResults=123, nextToken='string' ) Parameters: * **owner** (*string*) -- 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. * **filters** (*list*) -- Use the following filters to streamline results: * "name" * "parentImage" * "platform" * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imageRecipeSummaryList': [ { 'arn': 'string', 'name': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'owner': 'string', 'parentImage': 'string', 'dateCreated': 'string', 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imageRecipeSummaryList** *(list) --* The list of image pipelines. * *(dict) --* A summary of an image recipe. * **arn** *(string) --* The Amazon Resource Name (ARN) of the image recipe. * **name** *(string) --* The name of the image recipe. * **platform** *(string) --* The platform of the image recipe. * **owner** *(string) --* The owner of the image recipe. * **parentImage** *(string) --* The base image of the image recipe. * **dateCreated** *(string) --* The date on which this image recipe was created. * **tags** *(dict) --* The tags of the image recipe. * *(string) --* * *(string) --* * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / delete_image_recipe delete_image_recipe ******************* imagebuilder.Client.delete_image_recipe(**kwargs) Deletes an image recipe. See also: AWS API Documentation **Request Syntax** response = client.delete_image_recipe( imageRecipeArn='string' ) Parameters: **imageRecipeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image recipe to delete. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imageRecipeArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imageRecipeArn** *(string) --* The Amazon Resource Name (ARN) of the image recipe that was deleted. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceDependencyException" imagebuilder / Client / list_lifecycle_policies list_lifecycle_policies *********************** imagebuilder.Client.list_lifecycle_policies(**kwargs) Get a list of lifecycle policies in your Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.list_lifecycle_policies( filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], maxResults=123, nextToken='string' ) Parameters: * **filters** (*list*) -- Streamline results based on one of the following values: "Name", "Status". * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'lifecyclePolicySummaryList': [ { 'arn': 'string', 'name': 'string', 'description': 'string', 'status': 'DISABLED'|'ENABLED', 'executionRole': 'string', 'resourceType': 'AMI_IMAGE'|'CONTAINER_IMAGE', 'dateCreated': datetime(2015, 1, 1), 'dateUpdated': datetime(2015, 1, 1), 'dateLastRun': datetime(2015, 1, 1), 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **lifecyclePolicySummaryList** *(list) --* A list of lifecycle policies in your Amazon Web Services account that meet the criteria specified in the request. * *(dict) --* Contains a summary of lifecycle policy resources. * **arn** *(string) --* The Amazon Resource Name (ARN) of the lifecycle policy summary resource. * **name** *(string) --* The name of the lifecycle policy. * **description** *(string) --* Optional description for the lifecycle policy. * **status** *(string) --* The lifecycle policy resource status. * **executionRole** *(string) --* The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy. * **resourceType** *(string) --* The type of resources the lifecycle policy targets. * **dateCreated** *(datetime) --* The timestamp when Image Builder created the lifecycle policy resource. * **dateUpdated** *(datetime) --* The timestamp when Image Builder updated the lifecycle policy resource. * **dateLastRun** *(datetime) --* The timestamp for the last time Image Builder ran the lifecycle policy. * **tags** *(dict) --* To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define. * *(string) --* * *(string) --* * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / get_image_pipeline get_image_pipeline ****************** imagebuilder.Client.get_image_pipeline(**kwargs) Gets an image pipeline. See also: AWS API Documentation **Request Syntax** response = client.get_image_pipeline( imagePipelineArn='string' ) Parameters: **imagePipelineArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imagePipeline': { 'arn': 'string', 'name': 'string', 'description': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'enhancedImageMetadataEnabled': True|False, 'imageRecipeArn': 'string', 'containerRecipeArn': 'string', 'infrastructureConfigurationArn': 'string', 'distributionConfigurationArn': 'string', 'imageTestsConfiguration': { 'imageTestsEnabled': True|False, 'timeoutMinutes': 123 }, 'schedule': { 'scheduleExpression': 'string', 'timezone': 'string', 'pipelineExecutionStartCondition': 'EXPRESSION_MATCH_ONLY'|'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE' }, 'status': 'DISABLED'|'ENABLED', 'dateCreated': 'string', 'dateUpdated': 'string', 'dateLastRun': 'string', 'dateNextRun': 'string', 'tags': { 'string': 'string' }, 'imageScanningConfiguration': { 'imageScanningEnabled': True|False, 'ecrConfiguration': { 'repositoryName': 'string', 'containerTags': [ 'string', ] } }, 'executionRole': 'string', 'workflows': [ { 'workflowArn': 'string', 'parameters': [ { 'name': 'string', 'value': [ 'string', ] }, ], 'parallelGroup': 'string', 'onFailure': 'CONTINUE'|'ABORT' }, ] } } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imagePipeline** *(dict) --* The image pipeline object. * **arn** *(string) --* The Amazon Resource Name (ARN) of the image pipeline. * **name** *(string) --* The name of the image pipeline. * **description** *(string) --* The description of the image pipeline. * **platform** *(string) --* The platform of the image pipeline. * **enhancedImageMetadataEnabled** *(boolean) --* Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default. * **imageRecipeArn** *(string) --* The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline. * **containerRecipeArn** *(string) --* The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline. * **infrastructureConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline. * **distributionConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline. * **imageTestsConfiguration** *(dict) --* The image tests configuration of the image pipeline. * **imageTestsEnabled** *(boolean) --* Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution. * **timeoutMinutes** *(integer) --* The maximum time in minutes that tests are permitted to run. Note: The timeout property is not currently active. This value is ignored. * **schedule** *(dict) --* The schedule of the image pipeline. * **scheduleExpression** *(string) --* The cron expression determines how often EC2 Image Builder evaluates your "pipelineExecutionStartCondition". For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder. * **timezone** *(string) --* The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC. * **pipelineExecutionStartCondition** *(string) --* The start condition configures when the pipeline should trigger a new image build, as follows. If no value is set Image Builder defaults to "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE". * "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" (default) – When you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder builds a new image only when there are new versions of the base image or components in your recipe that match the filter. Note: For semantic version syntax, see CreateComponent. * "EXPRESSION_MATCH_ONLY" – This condition builds a new image every time the CRON expression matches the current time. * **status** *(string) --* The status of the image pipeline. * **dateCreated** *(string) --* The date on which this image pipeline was created. * **dateUpdated** *(string) --* The date on which this image pipeline was last updated. * **dateLastRun** *(string) --* This is no longer supported, and does not return a value. * **dateNextRun** *(string) --* The next date when the pipeline is scheduled to run. * **tags** *(dict) --* The tags of this image pipeline. * *(string) --* * *(string) --* * **imageScanningConfiguration** *(dict) --* Contains settings for vulnerability scans. * **imageScanningEnabled** *(boolean) --* A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image. * **ecrConfiguration** *(dict) --* Contains Amazon ECR settings for vulnerability scans. * **repositoryName** *(string) --* 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. * **containerTags** *(list) --* Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can help you identify and manage your scanned images. * *(string) --* * **executionRole** *(string) --* The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions. * **workflows** *(list) --* Contains the workflows that run for the image pipeline. * *(dict) --* Contains control settings and configurable inputs for a workflow resource. * **workflowArn** *(string) --* The Amazon Resource Name (ARN) of the workflow resource. * **parameters** *(list) --* Contains parameter values for each of the parameters that the workflow document defined for the workflow resource. * *(dict) --* Contains a key/value pair that sets the named workflow parameter. * **name** *(string) --* The name of the workflow parameter to set. * **value** *(list) --* Sets the value for the named workflow parameter. * *(string) --* * **parallelGroup** *(string) --* Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows. * **onFailure** *(string) --* The action to take if the workflow fails. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / delete_workflow delete_workflow *************** imagebuilder.Client.delete_workflow(**kwargs) Deletes a specific workflow resource. See also: AWS API Documentation **Request Syntax** response = client.delete_workflow( workflowBuildVersionArn='string' ) Parameters: **workflowBuildVersionArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the workflow resource to delete. Return type: dict Returns: **Response Syntax** { 'workflowBuildVersionArn': 'string' } **Response Structure** * *(dict) --* * **workflowBuildVersionArn** *(string) --* The ARN of the workflow resource that this request deleted. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceDependencyException" imagebuilder / Client / get_image get_image ********* imagebuilder.Client.get_image(**kwargs) Gets an image. See also: AWS API Documentation **Request Syntax** response = client.get_image( imageBuildVersionArn='string' ) Parameters: **imageBuildVersionArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image that you want to get. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'image': { 'arn': 'string', 'type': 'AMI'|'DOCKER', 'name': 'string', 'version': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'enhancedImageMetadataEnabled': True|False, 'osVersion': 'string', 'state': { 'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED', 'reason': 'string' }, 'imageRecipe': { 'arn': 'string', 'type': 'AMI'|'DOCKER', 'name': 'string', 'description': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'owner': 'string', 'version': 'string', 'components': [ { 'componentArn': 'string', 'parameters': [ { 'name': 'string', 'value': [ 'string', ] }, ] }, ], 'parentImage': 'string', 'blockDeviceMappings': [ { 'deviceName': 'string', 'ebs': { 'encrypted': True|False, 'deleteOnTermination': True|False, 'iops': 123, 'kmsKeyId': 'string', 'snapshotId': 'string', 'volumeSize': 123, 'volumeType': 'standard'|'io1'|'io2'|'gp2'|'gp3'|'sc1'|'st1', 'throughput': 123 }, 'virtualName': 'string', 'noDevice': 'string' }, ], 'dateCreated': 'string', 'tags': { 'string': 'string' }, 'workingDirectory': 'string', 'additionalInstanceConfiguration': { 'systemsManagerAgent': { 'uninstallAfterBuild': True|False }, 'userDataOverride': 'string' } }, 'containerRecipe': { 'arn': 'string', 'containerType': 'DOCKER', 'name': 'string', 'description': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'owner': 'string', 'version': 'string', 'components': [ { 'componentArn': 'string', 'parameters': [ { 'name': 'string', 'value': [ 'string', ] }, ] }, ], 'instanceConfiguration': { 'image': 'string', 'blockDeviceMappings': [ { 'deviceName': 'string', 'ebs': { 'encrypted': True|False, 'deleteOnTermination': True|False, 'iops': 123, 'kmsKeyId': 'string', 'snapshotId': 'string', 'volumeSize': 123, 'volumeType': 'standard'|'io1'|'io2'|'gp2'|'gp3'|'sc1'|'st1', 'throughput': 123 }, 'virtualName': 'string', 'noDevice': 'string' }, ] }, 'dockerfileTemplateData': 'string', 'kmsKeyId': 'string', 'encrypted': True|False, 'parentImage': 'string', 'dateCreated': 'string', 'tags': { 'string': 'string' }, 'workingDirectory': 'string', 'targetRepository': { 'service': 'ECR', 'repositoryName': 'string' } }, 'sourcePipelineName': 'string', 'sourcePipelineArn': 'string', 'infrastructureConfiguration': { 'arn': 'string', 'name': 'string', 'description': 'string', 'instanceTypes': [ 'string', ], 'instanceProfileName': 'string', 'securityGroupIds': [ 'string', ], 'subnetId': 'string', 'logging': { 's3Logs': { 's3BucketName': 'string', 's3KeyPrefix': 'string' } }, 'keyPair': 'string', 'terminateInstanceOnFailure': True|False, 'snsTopicArn': 'string', 'dateCreated': 'string', 'dateUpdated': 'string', 'resourceTags': { 'string': 'string' }, 'instanceMetadataOptions': { 'httpTokens': 'string', 'httpPutResponseHopLimit': 123 }, 'tags': { 'string': 'string' }, 'placement': { 'availabilityZone': 'string', 'tenancy': 'default'|'dedicated'|'host', 'hostId': 'string', 'hostResourceGroupArn': 'string' } }, 'distributionConfiguration': { 'arn': 'string', 'name': 'string', 'description': 'string', 'distributions': [ { 'region': 'string', 'amiDistributionConfiguration': { 'name': 'string', 'description': 'string', 'targetAccountIds': [ 'string', ], 'amiTags': { 'string': 'string' }, 'kmsKeyId': 'string', 'launchPermission': { 'userIds': [ 'string', ], 'userGroups': [ 'string', ], 'organizationArns': [ 'string', ], 'organizationalUnitArns': [ 'string', ] } }, 'containerDistributionConfiguration': { 'description': 'string', 'containerTags': [ 'string', ], 'targetRepository': { 'service': 'ECR', 'repositoryName': 'string' } }, 'licenseConfigurationArns': [ 'string', ], 'launchTemplateConfigurations': [ { 'launchTemplateId': 'string', 'accountId': 'string', 'setDefaultVersion': True|False }, ], 's3ExportConfiguration': { 'roleName': 'string', 'diskImageFormat': 'VMDK'|'RAW'|'VHD', 's3Bucket': 'string', 's3Prefix': 'string' }, 'fastLaunchConfigurations': [ { 'enabled': True|False, 'snapshotConfiguration': { 'targetResourceCount': 123 }, 'maxParallelLaunches': 123, 'launchTemplate': { 'launchTemplateId': 'string', 'launchTemplateName': 'string', 'launchTemplateVersion': 'string' }, 'accountId': 'string' }, ], 'ssmParameterConfigurations': [ { 'amiAccountId': 'string', 'parameterName': 'string', 'dataType': 'text'|'aws:ec2:image' }, ] }, ], 'timeoutMinutes': 123, 'dateCreated': 'string', 'dateUpdated': 'string', 'tags': { 'string': 'string' } }, 'imageTestsConfiguration': { 'imageTestsEnabled': True|False, 'timeoutMinutes': 123 }, 'dateCreated': 'string', 'outputResources': { 'amis': [ { 'region': 'string', 'image': 'string', 'name': 'string', 'description': 'string', 'state': { 'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED', 'reason': 'string' }, 'accountId': 'string' }, ], 'containers': [ { 'region': 'string', 'imageUris': [ 'string', ] }, ] }, 'tags': { 'string': 'string' }, 'buildType': 'USER_INITIATED'|'SCHEDULED'|'IMPORT'|'IMPORT_ISO', 'imageSource': 'AMAZON_MANAGED'|'AWS_MARKETPLACE'|'IMPORTED'|'CUSTOM', 'scanState': { 'status': 'PENDING'|'SCANNING'|'COLLECTING'|'COMPLETED'|'ABANDONED'|'FAILED'|'TIMED_OUT', 'reason': 'string' }, 'imageScanningConfiguration': { 'imageScanningEnabled': True|False, 'ecrConfiguration': { 'repositoryName': 'string', 'containerTags': [ 'string', ] } }, 'deprecationTime': datetime(2015, 1, 1), 'lifecycleExecutionId': 'string', 'executionRole': 'string', 'workflows': [ { 'workflowArn': 'string', 'parameters': [ { 'name': 'string', 'value': [ 'string', ] }, ], 'parallelGroup': 'string', 'onFailure': 'CONTINUE'|'ABORT' }, ] } } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **image** *(dict) --* The image object. * **arn** *(string) --* The Amazon Resource Name (ARN) of the image. Note: 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: .. * Build version ARNs have all four nodes, and point to a specific build for a specific version of an object. * **type** *(string) --* Specifies whether this image produces an AMI or a container image. * **name** *(string) --* The name of the image. * **version** *(string) --* The semantic version of the image. Note: The semantic version has four nodes: ../. 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. * **platform** *(string) --* The image operating system platform, such as Linux or Windows. * **enhancedImageMetadataEnabled** *(boolean) --* Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list. * **osVersion** *(string) --* The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019. * **state** *(dict) --* The state of the image. * **status** *(string) --* The status of the image. * **reason** *(string) --* The reason for the status of the image. * **imageRecipe** *(dict) --* 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. * **arn** *(string) --* The Amazon Resource Name (ARN) of the image recipe. * **type** *(string) --* Specifies which type of image is created by the recipe - an AMI or a container image. * **name** *(string) --* The name of the image recipe. * **description** *(string) --* The description of the image recipe. * **platform** *(string) --* The platform of the image recipe. * **owner** *(string) --* The owner of the image recipe. * **version** *(string) --* The version of the image recipe. * **components** *(list) --* 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. * *(dict) --* Configuration details of the component. * **componentArn** *(string) --* The Amazon Resource Name (ARN) of the component. * **parameters** *(list) --* A group of parameter settings that Image Builder uses to configure the component for a specific recipe. * *(dict) --* Contains a key/value pair that sets the named component parameter. * **name** *(string) --* The name of the component parameter to set. * **value** *(list) --* Sets the value for the named component parameter. * *(string) --* * **parentImage** *(string) --* The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options: * AMI ID * Image Builder image Amazon Resource Name (ARN) * Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by "ssm:", followed by the parameter name or ARN. * Amazon Web Services Marketplace product ID * **blockDeviceMappings** *(list) --* The block device mappings to apply when creating images from this recipe. * *(dict) --* Defines block device mappings for the instance used to configure your image. * **deviceName** *(string) --* The device to which these mappings apply. * **ebs** *(dict) --* Use to manage Amazon EBS-specific configuration for this mapping. * **encrypted** *(boolean) --* Use to configure device encryption. * **deleteOnTermination** *(boolean) --* Use to configure delete on termination of the associated device. * **iops** *(integer) --* Use to configure device IOPS. * **kmsKeyId** *(string) --* Use to configure the KMS key to use when encrypting the device. * **snapshotId** *(string) --* The snapshot that defines the device contents. * **volumeSize** *(integer) --* Use to override the device's volume size. * **volumeType** *(string) --* Use to override the device's volume type. * **throughput** *(integer) --* **For GP3 volumes only** – The throughput in MiB/s that the volume supports. * **virtualName** *(string) --* Use to manage instance ephemeral devices. * **noDevice** *(string) --* Use to remove a mapping from the base image. * **dateCreated** *(string) --* The date on which this image recipe was created. * **tags** *(dict) --* The tags of the image recipe. * *(string) --* * *(string) --* * **workingDirectory** *(string) --* The working directory to be used during build and test workflows. * **additionalInstanceConfiguration** *(dict) --* 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. * **systemsManagerAgent** *(dict) --* Contains settings for the Systems Manager agent on your build instance. * **uninstallAfterBuild** *(boolean) --* 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. * **userDataOverride** *(string) --* 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. Note: The user data is always base 64 encoded. For example, the following commands are encoded as "IyE vYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci $":*#!/bin/bash*mkdir -p /var/bb/touch /var * **containerRecipe** *(dict) --* 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. * **arn** *(string) --* The Amazon Resource Name (ARN) of the container recipe. Note: 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: .. * Build version ARNs have all four nodes, and point to a specific build for a specific version of an object. * **containerType** *(string) --* Specifies the type of container, such as Docker. * **name** *(string) --* The name of the container recipe. * **description** *(string) --* The description of the container recipe. * **platform** *(string) --* The system platform for the container, such as Windows or Linux. * **owner** *(string) --* The owner of the container recipe. * **version** *(string) --* The semantic version of the container recipe. Note: The semantic version has four nodes: ../. You can assign values for the first three, and can filter on all of them.**Assignment:** For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.**Patterns:** You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.**Filtering:** With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards. * **components** *(list) --* 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. * *(dict) --* Configuration details of the component. * **componentArn** *(string) --* The Amazon Resource Name (ARN) of the component. * **parameters** *(list) --* A group of parameter settings that Image Builder uses to configure the component for a specific recipe. * *(dict) --* Contains a key/value pair that sets the named component parameter. * **name** *(string) --* The name of the component parameter to set. * **value** *(list) --* Sets the value for the named component parameter. * *(string) --* * **instanceConfiguration** *(dict) --* A group of options that can be used to configure an instance for building and testing container images. * **image** *(string) --* The base image for a container build and test instance. This can contain an AMI ID or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by "ssm:", followed by the parameter name or ARN. If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image. * **blockDeviceMappings** *(list) --* Defines the block devices to attach for building an instance from this Image Builder AMI. * *(dict) --* Defines block device mappings for the instance used to configure your image. * **deviceName** *(string) --* The device to which these mappings apply. * **ebs** *(dict) --* Use to manage Amazon EBS-specific configuration for this mapping. * **encrypted** *(boolean) --* Use to configure device encryption. * **deleteOnTermination** *(boolean) --* Use to configure delete on termination of the associated device. * **iops** *(integer) --* Use to configure device IOPS. * **kmsKeyId** *(string) --* Use to configure the KMS key to use when encrypting the device. * **snapshotId** *(string) --* The snapshot that defines the device contents. * **volumeSize** *(integer) --* Use to override the device's volume size. * **volumeType** *(string) --* Use to override the device's volume type. * **throughput** *(integer) --* **For GP3 volumes only** – The throughput in MiB/s that the volume supports. * **virtualName** *(string) --* Use to manage instance ephemeral devices. * **noDevice** *(string) --* Use to remove a mapping from the base image. * **dockerfileTemplateData** *(string) --* Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe. * **kmsKeyId** *(string) --* Identifies which KMS key is used to encrypt the container image for distribution to the target Region. * **encrypted** *(boolean) --* A flag that indicates if the target container is encrypted. * **parentImage** *(string) --* The base image for customizations specified in the container recipe. This can contain an Image Builder image resource ARN or a container image URI, for example "amazonlinux:latest". * **dateCreated** *(string) --* The date when this container recipe was created. * **tags** *(dict) --* Tags that are attached to the container recipe. * *(string) --* * *(string) --* * **workingDirectory** *(string) --* The working directory for use during build and test workflows. * **targetRepository** *(dict) --* The destination repository for the container image. * **service** *(string) --* Specifies the service in which this image was registered. * **repositoryName** *(string) --* The name of the container repository where the output container image is stored. This name is prefixed by the repository location. For example, "/repository_name". * **sourcePipelineName** *(string) --* The name of the image pipeline that created this image. * **sourcePipelineArn** *(string) --* The Amazon Resource Name (ARN) of the image pipeline that created this image. * **infrastructureConfiguration** *(dict) --* The infrastructure that Image Builder used to create this image. * **arn** *(string) --* The Amazon Resource Name (ARN) of the infrastructure configuration. * **name** *(string) --* The name of the infrastructure configuration. * **description** *(string) --* The description of the infrastructure configuration. * **instanceTypes** *(list) --* The instance types of the infrastructure configuration. * *(string) --* * **instanceProfileName** *(string) --* The instance profile of the infrastructure configuration. * **securityGroupIds** *(list) --* The security group IDs of the infrastructure configuration. * *(string) --* * **subnetId** *(string) --* The subnet ID of the infrastructure configuration. * **logging** *(dict) --* The logging configuration of the infrastructure configuration. * **s3Logs** *(dict) --* The Amazon S3 logging configuration. * **s3BucketName** *(string) --* The S3 bucket in which to store the logs. * **s3KeyPrefix** *(string) --* The Amazon S3 path to the bucket where the logs are stored. * **keyPair** *(string) --* The Amazon EC2 key pair of the infrastructure configuration. * **terminateInstanceOnFailure** *(boolean) --* The terminate instance on failure configuration of the infrastructure configuration. * **snsTopicArn** *(string) --* The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications. Note: 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. * **dateCreated** *(string) --* The date on which the infrastructure configuration was created. * **dateUpdated** *(string) --* The date on which the infrastructure configuration was last updated. * **resourceTags** *(dict) --* The tags attached to the resource created by Image Builder. * *(string) --* * *(string) --* * **instanceMetadataOptions** *(dict) --* The instance metadata option settings for the infrastructure configuration. * **httpTokens** *(string) --* 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**. * **httpPutResponseHopLimit** *(integer) --* 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. * **tags** *(dict) --* The tags of the infrastructure configuration. * *(string) --* * *(string) --* * **placement** *(dict) --* The instance placement settings that define where the instances that are launched from your image will run. * **availabilityZone** *(string) --* The Availability Zone where your build and test instances will launch. * **tenancy** *(string) --* The tenancy of the instance. An instance with a tenancy of "dedicated" runs on single-tenant hardware. An instance with a tenancy of "host" runs on a Dedicated Host. If tenancy is set to "host", then you can optionally specify one target for placement – either host ID or host resource group ARN. If automatic placement is enabled for your host, and you don't specify any placement target, Amazon EC2 will try to find an available host for your build and test instances. * **hostId** *(string) --* The ID of the Dedicated Host on which build and test instances run. This only applies if "tenancy" is "host". If you specify the host ID, you must not specify the resource group ARN. If you specify both, Image Builder returns an error. * **hostResourceGroupArn** *(string) --* The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances. This only applies if "tenancy" is "host". If you specify the resource group ARN, you must not specify the host ID. If you specify both, Image Builder returns an error. * **distributionConfiguration** *(dict) --* The distribution configuration that Image Builder used to create this image. * **arn** *(string) --* The Amazon Resource Name (ARN) of the distribution configuration. * **name** *(string) --* The name of the distribution configuration. * **description** *(string) --* The description of the distribution configuration. * **distributions** *(list) --* The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions. * *(dict) --* Defines the settings for a specific Region. * **region** *(string) --* The target Region. * **amiDistributionConfiguration** *(dict) --* The specific AMI settings; for example, launch permissions or AMI tags. * **name** *(string) --* The name of the output AMI. * **description** *(string) --* The description of the AMI distribution configuration. Minimum and maximum length are in characters. * **targetAccountIds** *(list) --* The ID of an account to which you want to distribute an image. * *(string) --* * **amiTags** *(dict) --* The tags to apply to AMIs distributed to this Region. * *(string) --* * *(string) --* * **kmsKeyId** *(string) --* The KMS key identifier used to encrypt the distributed image. * **launchPermission** *(dict) --* Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances. * **userIds** *(list) --* The Amazon Web Services account ID. * *(string) --* * **userGroups** *(list) --* The name of the group. * *(string) --* * **organizationArns** *(list) --* The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?. * *(string) --* * **organizationalUnitArns** *(list) --* 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. * *(string) --* * **containerDistributionConfiguration** *(dict) --* Container distribution settings for encryption, licensing, and sharing in a specific Region. * **description** *(string) --* The description of the container distribution configuration. * **containerTags** *(list) --* Tags that are attached to the container distribution configuration. * *(string) --* * **targetRepository** *(dict) --* The destination repository for the container distribution configuration. * **service** *(string) --* Specifies the service in which this image was registered. * **repositoryName** *(string) --* The name of the container repository where the output container image is stored. This name is prefixed by the repository location. For example, "/repository_name". * **licenseConfigurationArns** *(list) --* The License Manager Configuration to associate with the AMI in the specified Region. * *(string) --* * **launchTemplateConfigurations** *(list) --* A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts. * *(dict) --* Identifies an Amazon EC2 launch template to use for a specific account. * **launchTemplateId** *(string) --* Identifies the Amazon EC2 launch template to use. * **accountId** *(string) --* The account ID that this configuration applies to. * **setDefaultVersion** *(boolean) --* Set the specified Amazon EC2 launch template as the default launch template for the specified account. * **s3ExportConfiguration** *(dict) --* 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. * **roleName** *(string) --* The name of the role that grants VM Import/Export permission to export images to your S3 bucket. * **diskImageFormat** *(string) --* 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. * **s3Bucket** *(string) --* The S3 bucket in which to store the output disk images for your VM. * **s3Prefix** *(string) --* The Amazon S3 path for the bucket where the output disk images for your VM are stored. * **fastLaunchConfigurations** *(list) --* The Windows faster-launching configurations to use for AMI distribution. * *(dict) --* Define and configure faster launching for output Windows AMIs. * **enabled** *(boolean) --* A Boolean that represents the current state of faster launching for the Windows AMI. Set to "true" to start using Windows faster launching, or "false" to stop using it. * **snapshotConfiguration** *(dict) --* Configuration settings for managing the number of snapshots that are created from pre- provisioned instances for the Windows AMI when faster launching is enabled. * **targetResourceCount** *(integer) --* The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI. * **maxParallelLaunches** *(integer) --* The maximum number of parallel instances that are launched for creating resources. * **launchTemplate** *(dict) --* The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots. * **launchTemplateId** *(string) --* The ID of the launch template to use for faster launching for a Windows AMI. * **launchTemplateName** *(string) --* The name of the launch template to use for faster launching for a Windows AMI. * **launchTemplateVersion** *(string) --* The version of the launch template to use for faster launching for a Windows AMI. * **accountId** *(string) --* The owner account ID for the fast-launch enabled Windows AMI. * **ssmParameterConfigurations** *(list) --* Contains settings to update Amazon Web Services Systems Manager (SSM) Parameter Store Parameters with output AMI IDs from the build by target Region. * *(dict) --* Configuration for a single Parameter in the Amazon Web Services Systems Manager (SSM) Parameter Store in a given Region. * **amiAccountId** *(string) --* Specify the account that will own the Parameter in a given Region. During distribution, this account must be specified in distribution settings as a target account for the Region. * **parameterName** *(string) --* This is the name of the Parameter in the target Region or account. The image distribution creates the Parameter if it doesn't already exist. Otherwise, it updates the parameter. * **dataType** *(string) --* The data type specifies what type of value the Parameter contains. We recommend that you use data type "aws:ec2:image". * **timeoutMinutes** *(integer) --* The maximum duration in minutes for this distribution configuration. * **dateCreated** *(string) --* The date on which this distribution configuration was created. * **dateUpdated** *(string) --* The date on which this distribution configuration was last updated. * **tags** *(dict) --* The tags of the distribution configuration. * *(string) --* * *(string) --* * **imageTestsConfiguration** *(dict) --* The image tests that ran when that Image Builder created this image. * **imageTestsEnabled** *(boolean) --* Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution. * **timeoutMinutes** *(integer) --* The maximum time in minutes that tests are permitted to run. Note: The timeout property is not currently active. This value is ignored. * **dateCreated** *(string) --* The date on which Image Builder created this image. * **outputResources** *(dict) --* The output resources that Image Builder produces for this image. * **amis** *(list) --* The Amazon EC2 AMIs created by this image. * *(dict) --* Details of an Amazon EC2 AMI. * **region** *(string) --* The Amazon Web Services Region of the Amazon EC2 AMI. * **image** *(string) --* The AMI ID of the Amazon EC2 AMI. * **name** *(string) --* The name of the Amazon EC2 AMI. * **description** *(string) --* The description of the Amazon EC2 AMI. Minimum and maximum length are in characters. * **state** *(dict) --* Image status and the reason for that status. * **status** *(string) --* The status of the image. * **reason** *(string) --* The reason for the status of the image. * **accountId** *(string) --* The account ID of the owner of the AMI. * **containers** *(list) --* Container images that the pipeline has generated and stored in the output repository. * *(dict) --* A container encapsulates the runtime environment for an application. * **region** *(string) --* Containers and container images are Region-specific. This is the Region context for the container. * **imageUris** *(list) --* A list of URIs for containers created in the context Region. * *(string) --* * **tags** *(dict) --* The tags that apply to this image. * *(string) --* * *(string) --* * **buildType** *(string) --* 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. * **IMPORT_ISO** – An ISO disk import created the image. * **imageSource** *(string) --* The origin of the base image that Image Builder used to build this image. * **scanState** *(dict) --* Contains information about the current state of scans for this image. * **status** *(string) --* The current state of vulnerability scans for the image. * **reason** *(string) --* The reason for the scan status for the image. * **imageScanningConfiguration** *(dict) --* Contains settings for vulnerability scans. * **imageScanningEnabled** *(boolean) --* A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image. * **ecrConfiguration** *(dict) --* Contains Amazon ECR settings for vulnerability scans. * **repositoryName** *(string) --* 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. * **containerTags** *(list) --* Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can help you identify and manage your scanned images. * *(string) --* * **deprecationTime** *(datetime) --* The time when deprecation occurs for an image resource. This can be a past or future date. * **lifecycleExecutionId** *(string) --* Identifies the last runtime instance of the lifecycle policy to take action on the image. * **executionRole** *(string) --* The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions. * **workflows** *(list) --* Contains the build and test workflows that are associated with the image. * *(dict) --* Contains control settings and configurable inputs for a workflow resource. * **workflowArn** *(string) --* The Amazon Resource Name (ARN) of the workflow resource. * **parameters** *(list) --* Contains parameter values for each of the parameters that the workflow document defined for the workflow resource. * *(dict) --* Contains a key/value pair that sets the named workflow parameter. * **name** *(string) --* The name of the workflow parameter to set. * **value** *(list) --* Sets the value for the named workflow parameter. * *(string) --* * **parallelGroup** *(string) --* Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows. * **onFailure** *(string) --* The action to take if the workflow fails. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / list_workflow_executions list_workflow_executions ************************ imagebuilder.Client.list_workflow_executions(**kwargs) Returns a list of workflow runtime instance metadata objects for a specific image build version. See also: AWS API Documentation **Request Syntax** response = client.list_workflow_executions( maxResults=123, nextToken='string', imageBuildVersionArn='string' ) Parameters: * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. * **imageBuildVersionArn** (*string*) -- **[REQUIRED]** List all workflow runtime instances for the specified image build version resource ARN. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'workflowExecutions': [ { 'workflowBuildVersionArn': 'string', 'workflowExecutionId': 'string', 'type': 'BUILD'|'TEST'|'DISTRIBUTION', 'status': 'PENDING'|'SKIPPED'|'RUNNING'|'COMPLETED'|'FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETED'|'CANCELLED', 'message': 'string', 'totalStepCount': 123, 'totalStepsSucceeded': 123, 'totalStepsFailed': 123, 'totalStepsSkipped': 123, 'startTime': 'string', 'endTime': 'string', 'parallelGroup': 'string' }, ], 'imageBuildVersionArn': 'string', 'message': 'string', 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **workflowExecutions** *(list) --* Contains an array of runtime details that represents each time a workflow ran for the requested image build version. * *(dict) --* Metadata that includes details and status from this runtime instance of the workflow. * **workflowBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the workflow resource build version that ran. * **workflowExecutionId** *(string) --* Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow. * **type** *(string) --* Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow. * **status** *(string) --* The current runtime status for this workflow. * **message** *(string) --* The runtime output message from the workflow, if applicable. * **totalStepCount** *(integer) --* 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. * **totalStepsSucceeded** *(integer) --* A runtime count for the number of steps in the workflow that ran successfully. * **totalStepsFailed** *(integer) --* A runtime count for the number of steps in the workflow that failed. * **totalStepsSkipped** *(integer) --* A runtime count for the number of steps in the workflow that were skipped. * **startTime** *(string) --* The timestamp when the runtime instance of this workflow started. * **endTime** *(string) --* The timestamp when this runtime instance of the workflow finished. * **parallelGroup** *(string) --* The name of the test group that included the test workflow resource at runtime. * **imageBuildVersionArn** *(string) --* The resource ARN of the image build version for which you requested a list of workflow runtime details. * **message** *(string) --* The output message from the list action, if applicable. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / list_image_pipeline_images list_image_pipeline_images ************************** imagebuilder.Client.list_image_pipeline_images(**kwargs) Returns a list of images created by the specified pipeline. See also: AWS API Documentation **Request Syntax** response = client.list_image_pipeline_images( imagePipelineArn='string', filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], maxResults=123, nextToken='string' ) Parameters: * **imagePipelineArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image pipeline whose images you want to view. * **filters** (*list*) -- Use the following filters to streamline results: * "name" * "version" * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imageSummaryList': [ { 'arn': 'string', 'name': 'string', 'type': 'AMI'|'DOCKER', 'version': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'osVersion': 'string', 'state': { 'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED', 'reason': 'string' }, 'owner': 'string', 'dateCreated': 'string', 'outputResources': { 'amis': [ { 'region': 'string', 'image': 'string', 'name': 'string', 'description': 'string', 'state': { 'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED', 'reason': 'string' }, 'accountId': 'string' }, ], 'containers': [ { 'region': 'string', 'imageUris': [ 'string', ] }, ] }, 'tags': { 'string': 'string' }, 'buildType': 'USER_INITIATED'|'SCHEDULED'|'IMPORT'|'IMPORT_ISO', 'imageSource': 'AMAZON_MANAGED'|'AWS_MARKETPLACE'|'IMPORTED'|'CUSTOM', 'deprecationTime': datetime(2015, 1, 1), 'lifecycleExecutionId': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imageSummaryList** *(list) --* The list of images built by this pipeline. * *(dict) --* An image summary. * **arn** *(string) --* The Amazon Resource Name (ARN) of the image. * **name** *(string) --* The name of the image. * **type** *(string) --* Specifies whether this image produces an AMI or a container image. * **version** *(string) --* The version of the image. * **platform** *(string) --* The image operating system platform, such as Linux or Windows. * **osVersion** *(string) --* The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019. * **state** *(dict) --* The state of the image. * **status** *(string) --* The status of the image. * **reason** *(string) --* The reason for the status of the image. * **owner** *(string) --* The owner of the image. * **dateCreated** *(string) --* The date on which Image Builder created this image. * **outputResources** *(dict) --* The output resources that Image Builder produced when it created this image. * **amis** *(list) --* The Amazon EC2 AMIs created by this image. * *(dict) --* Details of an Amazon EC2 AMI. * **region** *(string) --* The Amazon Web Services Region of the Amazon EC2 AMI. * **image** *(string) --* The AMI ID of the Amazon EC2 AMI. * **name** *(string) --* The name of the Amazon EC2 AMI. * **description** *(string) --* The description of the Amazon EC2 AMI. Minimum and maximum length are in characters. * **state** *(dict) --* Image status and the reason for that status. * **status** *(string) --* The status of the image. * **reason** *(string) --* The reason for the status of the image. * **accountId** *(string) --* The account ID of the owner of the AMI. * **containers** *(list) --* Container images that the pipeline has generated and stored in the output repository. * *(dict) --* A container encapsulates the runtime environment for an application. * **region** *(string) --* Containers and container images are Region- specific. This is the Region context for the container. * **imageUris** *(list) --* A list of URIs for containers created in the context Region. * *(string) --* * **tags** *(dict) --* The tags that apply to this image. * *(string) --* * *(string) --* * **buildType** *(string) --* 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. * **IMPORT_ISO** – An ISO disk import created the image. * **imageSource** *(string) --* The origin of the base image that Image Builder used to build this image. * **deprecationTime** *(datetime) --* The time when deprecation occurs for an image resource. This can be a past or future date. * **lifecycleExecutionId** *(string) --* Identifies the last runtime instance of the lifecycle policy to take action on the image. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / get_workflow get_workflow ************ imagebuilder.Client.get_workflow(**kwargs) Get a workflow resource object. See also: AWS API Documentation **Request Syntax** response = client.get_workflow( workflowBuildVersionArn='string' ) Parameters: **workflowBuildVersionArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the workflow resource that you want to get. Return type: dict Returns: **Response Syntax** { 'workflow': { 'arn': 'string', 'name': 'string', 'version': 'string', 'description': 'string', 'changeDescription': 'string', 'type': 'BUILD'|'TEST'|'DISTRIBUTION', 'state': { 'status': 'DEPRECATED', 'reason': 'string' }, 'owner': 'string', 'data': 'string', 'kmsKeyId': 'string', 'dateCreated': 'string', 'tags': { 'string': 'string' }, 'parameters': [ { 'name': 'string', 'type': 'string', 'defaultValue': [ 'string', ], 'description': 'string' }, ] } } **Response Structure** * *(dict) --* * **workflow** *(dict) --* The workflow resource specified in the request. * **arn** *(string) --* The Amazon Resource Name (ARN) of the workflow resource. * **name** *(string) --* The name of the workflow resource. * **version** *(string) --* The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version. * **description** *(string) --* The description of the workflow. * **changeDescription** *(string) --* Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow. * **type** *(string) --* Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows. * **state** *(dict) --* Describes the current status of the workflow and the reason for that status. * **status** *(string) --* The current state of the workflow. * **reason** *(string) --* Describes how or why the workflow changed state. * **owner** *(string) --* The owner of the workflow resource. * **data** *(string) --* Contains the YAML document content for the workflow. * **kmsKeyId** *(string) --* The KMS key identifier used to encrypt the workflow resource. * **dateCreated** *(string) --* The timestamp when Image Builder created the workflow resource. * **tags** *(dict) --* The tags that apply to the workflow resource * *(string) --* * *(string) --* * **parameters** *(list) --* An array of input parameters that that the image workflow uses to control actions or configure settings. * *(dict) --* Defines a parameter that's used to provide configuration details for the workflow. * **name** *(string) --* The name of this input parameter. * **type** *(string) --* The type of input this parameter provides. The currently supported value is "string". * **defaultValue** *(list) --* The default value of this parameter if no input is provided. * *(string) --* * **description** *(string) --* Describes this parameter. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / update_distribution_configuration update_distribution_configuration ********************************* imagebuilder.Client.update_distribution_configuration(**kwargs) Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline. See also: AWS API Documentation **Request Syntax** response = client.update_distribution_configuration( distributionConfigurationArn='string', description='string', distributions=[ { 'region': 'string', 'amiDistributionConfiguration': { 'name': 'string', 'description': 'string', 'targetAccountIds': [ 'string', ], 'amiTags': { 'string': 'string' }, 'kmsKeyId': 'string', 'launchPermission': { 'userIds': [ 'string', ], 'userGroups': [ 'string', ], 'organizationArns': [ 'string', ], 'organizationalUnitArns': [ 'string', ] } }, 'containerDistributionConfiguration': { 'description': 'string', 'containerTags': [ 'string', ], 'targetRepository': { 'service': 'ECR', 'repositoryName': 'string' } }, 'licenseConfigurationArns': [ 'string', ], 'launchTemplateConfigurations': [ { 'launchTemplateId': 'string', 'accountId': 'string', 'setDefaultVersion': True|False }, ], 's3ExportConfiguration': { 'roleName': 'string', 'diskImageFormat': 'VMDK'|'RAW'|'VHD', 's3Bucket': 'string', 's3Prefix': 'string' }, 'fastLaunchConfigurations': [ { 'enabled': True|False, 'snapshotConfiguration': { 'targetResourceCount': 123 }, 'maxParallelLaunches': 123, 'launchTemplate': { 'launchTemplateId': 'string', 'launchTemplateName': 'string', 'launchTemplateVersion': 'string' }, 'accountId': 'string' }, ], 'ssmParameterConfigurations': [ { 'amiAccountId': 'string', 'parameterName': 'string', 'dataType': 'text'|'aws:ec2:image' }, ] }, ], clientToken='string' ) Parameters: * **distributionConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the distribution configuration that you want to update. * **description** (*string*) -- The description of the distribution configuration. * **distributions** (*list*) -- **[REQUIRED]** The distributions of the distribution configuration. * *(dict) --* Defines the settings for a specific Region. * **region** *(string) --* **[REQUIRED]** The target Region. * **amiDistributionConfiguration** *(dict) --* The specific AMI settings; for example, launch permissions or AMI tags. * **name** *(string) --* The name of the output AMI. * **description** *(string) --* The description of the AMI distribution configuration. Minimum and maximum length are in characters. * **targetAccountIds** *(list) --* The ID of an account to which you want to distribute an image. * *(string) --* * **amiTags** *(dict) --* The tags to apply to AMIs distributed to this Region. * *(string) --* * *(string) --* * **kmsKeyId** *(string) --* The KMS key identifier used to encrypt the distributed image. * **launchPermission** *(dict) --* Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances. * **userIds** *(list) --* The Amazon Web Services account ID. * *(string) --* * **userGroups** *(list) --* The name of the group. * *(string) --* * **organizationArns** *(list) --* The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?. * *(string) --* * **organizationalUnitArns** *(list) --* 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. * *(string) --* * **containerDistributionConfiguration** *(dict) --* Container distribution settings for encryption, licensing, and sharing in a specific Region. * **description** *(string) --* The description of the container distribution configuration. * **containerTags** *(list) --* Tags that are attached to the container distribution configuration. * *(string) --* * **targetRepository** *(dict) --* **[REQUIRED]** The destination repository for the container distribution configuration. * **service** *(string) --* **[REQUIRED]** Specifies the service in which this image was registered. * **repositoryName** *(string) --* **[REQUIRED]** The name of the container repository where the output container image is stored. This name is prefixed by the repository location. For example, "/repository_name". * **licenseConfigurationArns** *(list) --* The License Manager Configuration to associate with the AMI in the specified Region. * *(string) --* * **launchTemplateConfigurations** *(list) --* A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts. * *(dict) --* Identifies an Amazon EC2 launch template to use for a specific account. * **launchTemplateId** *(string) --* **[REQUIRED]** Identifies the Amazon EC2 launch template to use. * **accountId** *(string) --* The account ID that this configuration applies to. * **setDefaultVersion** *(boolean) --* Set the specified Amazon EC2 launch template as the default launch template for the specified account. * **s3ExportConfiguration** *(dict) --* 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. * **roleName** *(string) --* **[REQUIRED]** The name of the role that grants VM Import/Export permission to export images to your S3 bucket. * **diskImageFormat** *(string) --* **[REQUIRED]** 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. * **s3Bucket** *(string) --* **[REQUIRED]** The S3 bucket in which to store the output disk images for your VM. * **s3Prefix** *(string) --* The Amazon S3 path for the bucket where the output disk images for your VM are stored. * **fastLaunchConfigurations** *(list) --* The Windows faster-launching configurations to use for AMI distribution. * *(dict) --* Define and configure faster launching for output Windows AMIs. * **enabled** *(boolean) --* **[REQUIRED]** A Boolean that represents the current state of faster launching for the Windows AMI. Set to "true" to start using Windows faster launching, or "false" to stop using it. * **snapshotConfiguration** *(dict) --* Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled. * **targetResourceCount** *(integer) --* The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI. * **maxParallelLaunches** *(integer) --* The maximum number of parallel instances that are launched for creating resources. * **launchTemplate** *(dict) --* The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots. * **launchTemplateId** *(string) --* The ID of the launch template to use for faster launching for a Windows AMI. * **launchTemplateName** *(string) --* The name of the launch template to use for faster launching for a Windows AMI. * **launchTemplateVersion** *(string) --* The version of the launch template to use for faster launching for a Windows AMI. * **accountId** *(string) --* The owner account ID for the fast-launch enabled Windows AMI. * **ssmParameterConfigurations** *(list) --* Contains settings to update Amazon Web Services Systems Manager (SSM) Parameter Store Parameters with output AMI IDs from the build by target Region. * *(dict) --* Configuration for a single Parameter in the Amazon Web Services Systems Manager (SSM) Parameter Store in a given Region. * **amiAccountId** *(string) --* Specify the account that will own the Parameter in a given Region. During distribution, this account must be specified in distribution settings as a target account for the Region. * **parameterName** *(string) --* **[REQUIRED]** This is the name of the Parameter in the target Region or account. The image distribution creates the Parameter if it doesn't already exist. Otherwise, it updates the parameter. * **dataType** *(string) --* The data type specifies what type of value the Parameter contains. We recommend that you use data type "aws:ec2:image". * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'clientToken': 'string', 'distributionConfigurationArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **clientToken** *(string) --* The client token that uniquely identifies the request. * **distributionConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceInUseException" * "imagebuilder.Client.exceptions.InvalidParameterCombinationExcep tion" imagebuilder / Client / list_tags_for_resource list_tags_for_resource ********************** imagebuilder.Client.list_tags_for_resource(**kwargs) Returns the list of tags for the specified resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* The tags for the specified resource. * *(string) --* * *(string) --* **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.InvalidParameterException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" imagebuilder / Client / update_image_pipeline update_image_pipeline ********************* imagebuilder.Client.update_image_pipeline(**kwargs) Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a "containerRecipeArn" or an "imageRecipeArn". Note: 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. See also: AWS API Documentation **Request Syntax** response = client.update_image_pipeline( imagePipelineArn='string', description='string', imageRecipeArn='string', containerRecipeArn='string', infrastructureConfigurationArn='string', distributionConfigurationArn='string', imageTestsConfiguration={ 'imageTestsEnabled': True|False, 'timeoutMinutes': 123 }, enhancedImageMetadataEnabled=True|False, schedule={ 'scheduleExpression': 'string', 'timezone': 'string', 'pipelineExecutionStartCondition': 'EXPRESSION_MATCH_ONLY'|'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE' }, status='DISABLED'|'ENABLED', clientToken='string', imageScanningConfiguration={ 'imageScanningEnabled': True|False, 'ecrConfiguration': { 'repositoryName': 'string', 'containerTags': [ 'string', ] } }, workflows=[ { 'workflowArn': 'string', 'parameters': [ { 'name': 'string', 'value': [ 'string', ] }, ], 'parallelGroup': 'string', 'onFailure': 'CONTINUE'|'ABORT' }, ], executionRole='string' ) Parameters: * **imagePipelineArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image pipeline that you want to update. * **description** (*string*) -- The description of the image pipeline. * **imageRecipeArn** (*string*) -- The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline. * **containerRecipeArn** (*string*) -- The Amazon Resource Name (ARN) of the container pipeline to update. * **infrastructureConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated. * **distributionConfigurationArn** (*string*) -- The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated. * **imageTestsConfiguration** (*dict*) -- The image test configuration of the image pipeline. * **imageTestsEnabled** *(boolean) --* Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution. * **timeoutMinutes** *(integer) --* The maximum time in minutes that tests are permitted to run. Note: The timeout property is not currently active. This value is ignored. * **enhancedImageMetadataEnabled** (*boolean*) -- 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. * **schedule** (*dict*) -- The schedule of the image pipeline. * **scheduleExpression** *(string) --* The cron expression determines how often EC2 Image Builder evaluates your "pipelineExecutionStartCondition". For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder. * **timezone** *(string) --* The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC. * **pipelineExecutionStartCondition** *(string) --* The start condition configures when the pipeline should trigger a new image build, as follows. If no value is set Image Builder defaults to "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE". * "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" (default) – When you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder builds a new image only when there are new versions of the base image or components in your recipe that match the filter. Note: For semantic version syntax, see CreateComponent. * "EXPRESSION_MATCH_ONLY" – This condition builds a new image every time the CRON expression matches the current time. * **status** (*string*) -- The status of the image pipeline. * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. * **imageScanningConfiguration** (*dict*) -- Contains settings for vulnerability scans. * **imageScanningEnabled** *(boolean) --* A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image. * **ecrConfiguration** *(dict) --* Contains Amazon ECR settings for vulnerability scans. * **repositoryName** *(string) --* 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. * **containerTags** *(list) --* Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can help you identify and manage your scanned images. * *(string) --* * **workflows** (*list*) -- Contains the workflows to run for the pipeline. * *(dict) --* Contains control settings and configurable inputs for a workflow resource. * **workflowArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the workflow resource. * **parameters** *(list) --* Contains parameter values for each of the parameters that the workflow document defined for the workflow resource. * *(dict) --* Contains a key/value pair that sets the named workflow parameter. * **name** *(string) --* **[REQUIRED]** The name of the workflow parameter to set. * **value** *(list) --* **[REQUIRED]** Sets the value for the named workflow parameter. * *(string) --* * **parallelGroup** *(string) --* Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows. * **onFailure** *(string) --* The action to take if the workflow fails. * **executionRole** (*string*) -- The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'clientToken': 'string', 'imagePipelineArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **clientToken** *(string) --* The client token that uniquely identifies the request. * **imagePipelineArn** *(string) --* The Amazon Resource Name (ARN) of the image pipeline that was updated by this request. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceInUseException" imagebuilder / Client / get_workflow_execution get_workflow_execution ********************** imagebuilder.Client.get_workflow_execution(**kwargs) Get the runtime information that was logged for a specific runtime instance of the workflow. See also: AWS API Documentation **Request Syntax** response = client.get_workflow_execution( workflowExecutionId='string' ) Parameters: **workflowExecutionId** (*string*) -- **[REQUIRED]** Use the unique identifier for a runtime instance of the workflow to get runtime details. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'workflowBuildVersionArn': 'string', 'workflowExecutionId': 'string', 'imageBuildVersionArn': 'string', 'type': 'BUILD'|'TEST'|'DISTRIBUTION', 'status': 'PENDING'|'SKIPPED'|'RUNNING'|'COMPLETED'|'FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETED'|'CANCELLED', 'message': 'string', 'totalStepCount': 123, 'totalStepsSucceeded': 123, 'totalStepsFailed': 123, 'totalStepsSkipped': 123, 'startTime': 'string', 'endTime': 'string', 'parallelGroup': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **workflowBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow. * **workflowExecutionId** *(string) --* The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow. * **imageBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow created. * **type** *(string) --* The type of workflow that Image Builder ran for the specified runtime instance of the workflow. * **status** *(string) --* The current runtime status for the specified runtime instance of the workflow. * **message** *(string) --* The output message from the specified runtime instance of the workflow, if applicable. * **totalStepCount** *(integer) --* 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. * **totalStepsSucceeded** *(integer) --* A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow. * **totalStepsFailed** *(integer) --* A runtime count for the number of steps that failed in the specified runtime instance of the workflow. * **totalStepsSkipped** *(integer) --* A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow. * **startTime** *(string) --* The timestamp when the specified runtime instance of the workflow started. * **endTime** *(string) --* The timestamp when the specified runtime instance of the workflow finished. * **parallelGroup** *(string) --* Test workflows are defined within named runtime groups. The parallel group is a named group that contains one or more test workflows. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / list_container_recipes list_container_recipes ********************** imagebuilder.Client.list_container_recipes(**kwargs) Returns a list of container recipes. See also: AWS API Documentation **Request Syntax** response = client.list_container_recipes( owner='Self'|'Shared'|'Amazon'|'ThirdParty'|'AWSMarketplace', filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], maxResults=123, nextToken='string' ) Parameters: * **owner** (*string*) -- 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. * **filters** (*list*) -- Use the following filters to streamline results: * "containerType" * "name" * "parentImage" * "platform" * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'containerRecipeSummaryList': [ { 'arn': 'string', 'containerType': 'DOCKER', 'name': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'owner': 'string', 'parentImage': 'string', 'dateCreated': 'string', 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **containerRecipeSummaryList** *(list) --* The list of container recipes returned for the request. * *(dict) --* A summary of a container recipe * **arn** *(string) --* The Amazon Resource Name (ARN) of the container recipe. * **containerType** *(string) --* Specifies the type of container, such as "Docker". * **name** *(string) --* The name of the container recipe. * **platform** *(string) --* The system platform for the container, such as Windows or Linux. * **owner** *(string) --* The owner of the container recipe. * **parentImage** *(string) --* The base image for the container recipe. * **dateCreated** *(string) --* The date when this container recipe was created. * **tags** *(dict) --* Tags that are attached to the container recipe. * *(string) --* * *(string) --* * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / untag_resource untag_resource ************** imagebuilder.Client.untag_resource(**kwargs) Removes a tag from a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want to untag. * **tagKeys** (*list*) -- **[REQUIRED]** The tag keys to remove from the resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.InvalidParameterException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" imagebuilder / Client / send_workflow_step_action send_workflow_step_action ************************* imagebuilder.Client.send_workflow_step_action(**kwargs) Pauses or resumes image creation when the associated workflow runs a "WaitForAction" step. See also: AWS API Documentation **Request Syntax** response = client.send_workflow_step_action( stepExecutionId='string', imageBuildVersionArn='string', action='RESUME'|'STOP', reason='string', clientToken='string' ) Parameters: * **stepExecutionId** (*string*) -- **[REQUIRED]** Uniquely identifies the workflow step that sent the step action. * **imageBuildVersionArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image build version to send action for. * **action** (*string*) -- **[REQUIRED]** The action for the image creation process to take while a workflow "WaitForAction" step waits for an asynchronous action to complete. * **reason** (*string*) -- The reason why this action is sent. * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'stepExecutionId': 'string', 'imageBuildVersionArn': 'string', 'clientToken': 'string' } **Response Structure** * *(dict) --* * **stepExecutionId** *(string) --* The workflow step that sent the step action. * **imageBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the image build version that received the action request. * **clientToken** *(string) --* The client token that uniquely identifies the request. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidParameterValueException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceInUseException" imagebuilder / Client / list_image_packages list_image_packages ******************* imagebuilder.Client.list_image_packages(**kwargs) List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time. See also: AWS API Documentation **Request Syntax** response = client.list_image_packages( imageBuildVersionArn='string', maxResults=123, nextToken='string' ) Parameters: * **imageBuildVersionArn** (*string*) -- **[REQUIRED]** Filter results for the ListImagePackages request by the Image Build Version ARN * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imagePackageList': [ { 'packageName': 'string', 'packageVersion': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imagePackageList** *(list) --* The list of Image Packages returned in the response. * *(dict) --* A software package that's installed on top of the base image to create a customized image. * **packageName** *(string) --* The name of the package that's reported to the operating system package manager. * **packageVersion** *(string) --* The version of the package that's reported to the operating system package manager. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / create_distribution_configuration create_distribution_configuration ********************************* imagebuilder.Client.create_distribution_configuration(**kwargs) Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline. See also: AWS API Documentation **Request Syntax** response = client.create_distribution_configuration( name='string', description='string', distributions=[ { 'region': 'string', 'amiDistributionConfiguration': { 'name': 'string', 'description': 'string', 'targetAccountIds': [ 'string', ], 'amiTags': { 'string': 'string' }, 'kmsKeyId': 'string', 'launchPermission': { 'userIds': [ 'string', ], 'userGroups': [ 'string', ], 'organizationArns': [ 'string', ], 'organizationalUnitArns': [ 'string', ] } }, 'containerDistributionConfiguration': { 'description': 'string', 'containerTags': [ 'string', ], 'targetRepository': { 'service': 'ECR', 'repositoryName': 'string' } }, 'licenseConfigurationArns': [ 'string', ], 'launchTemplateConfigurations': [ { 'launchTemplateId': 'string', 'accountId': 'string', 'setDefaultVersion': True|False }, ], 's3ExportConfiguration': { 'roleName': 'string', 'diskImageFormat': 'VMDK'|'RAW'|'VHD', 's3Bucket': 'string', 's3Prefix': 'string' }, 'fastLaunchConfigurations': [ { 'enabled': True|False, 'snapshotConfiguration': { 'targetResourceCount': 123 }, 'maxParallelLaunches': 123, 'launchTemplate': { 'launchTemplateId': 'string', 'launchTemplateName': 'string', 'launchTemplateVersion': 'string' }, 'accountId': 'string' }, ], 'ssmParameterConfigurations': [ { 'amiAccountId': 'string', 'parameterName': 'string', 'dataType': 'text'|'aws:ec2:image' }, ] }, ], tags={ 'string': 'string' }, clientToken='string' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the distribution configuration. * **description** (*string*) -- The description of the distribution configuration. * **distributions** (*list*) -- **[REQUIRED]** The distributions of the distribution configuration. * *(dict) --* Defines the settings for a specific Region. * **region** *(string) --* **[REQUIRED]** The target Region. * **amiDistributionConfiguration** *(dict) --* The specific AMI settings; for example, launch permissions or AMI tags. * **name** *(string) --* The name of the output AMI. * **description** *(string) --* The description of the AMI distribution configuration. Minimum and maximum length are in characters. * **targetAccountIds** *(list) --* The ID of an account to which you want to distribute an image. * *(string) --* * **amiTags** *(dict) --* The tags to apply to AMIs distributed to this Region. * *(string) --* * *(string) --* * **kmsKeyId** *(string) --* The KMS key identifier used to encrypt the distributed image. * **launchPermission** *(dict) --* Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances. * **userIds** *(list) --* The Amazon Web Services account ID. * *(string) --* * **userGroups** *(list) --* The name of the group. * *(string) --* * **organizationArns** *(list) --* The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?. * *(string) --* * **organizationalUnitArns** *(list) --* 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. * *(string) --* * **containerDistributionConfiguration** *(dict) --* Container distribution settings for encryption, licensing, and sharing in a specific Region. * **description** *(string) --* The description of the container distribution configuration. * **containerTags** *(list) --* Tags that are attached to the container distribution configuration. * *(string) --* * **targetRepository** *(dict) --* **[REQUIRED]** The destination repository for the container distribution configuration. * **service** *(string) --* **[REQUIRED]** Specifies the service in which this image was registered. * **repositoryName** *(string) --* **[REQUIRED]** The name of the container repository where the output container image is stored. This name is prefixed by the repository location. For example, "/repository_name". * **licenseConfigurationArns** *(list) --* The License Manager Configuration to associate with the AMI in the specified Region. * *(string) --* * **launchTemplateConfigurations** *(list) --* A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts. * *(dict) --* Identifies an Amazon EC2 launch template to use for a specific account. * **launchTemplateId** *(string) --* **[REQUIRED]** Identifies the Amazon EC2 launch template to use. * **accountId** *(string) --* The account ID that this configuration applies to. * **setDefaultVersion** *(boolean) --* Set the specified Amazon EC2 launch template as the default launch template for the specified account. * **s3ExportConfiguration** *(dict) --* 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. * **roleName** *(string) --* **[REQUIRED]** The name of the role that grants VM Import/Export permission to export images to your S3 bucket. * **diskImageFormat** *(string) --* **[REQUIRED]** 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. * **s3Bucket** *(string) --* **[REQUIRED]** The S3 bucket in which to store the output disk images for your VM. * **s3Prefix** *(string) --* The Amazon S3 path for the bucket where the output disk images for your VM are stored. * **fastLaunchConfigurations** *(list) --* The Windows faster-launching configurations to use for AMI distribution. * *(dict) --* Define and configure faster launching for output Windows AMIs. * **enabled** *(boolean) --* **[REQUIRED]** A Boolean that represents the current state of faster launching for the Windows AMI. Set to "true" to start using Windows faster launching, or "false" to stop using it. * **snapshotConfiguration** *(dict) --* Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled. * **targetResourceCount** *(integer) --* The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI. * **maxParallelLaunches** *(integer) --* The maximum number of parallel instances that are launched for creating resources. * **launchTemplate** *(dict) --* The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots. * **launchTemplateId** *(string) --* The ID of the launch template to use for faster launching for a Windows AMI. * **launchTemplateName** *(string) --* The name of the launch template to use for faster launching for a Windows AMI. * **launchTemplateVersion** *(string) --* The version of the launch template to use for faster launching for a Windows AMI. * **accountId** *(string) --* The owner account ID for the fast-launch enabled Windows AMI. * **ssmParameterConfigurations** *(list) --* Contains settings to update Amazon Web Services Systems Manager (SSM) Parameter Store Parameters with output AMI IDs from the build by target Region. * *(dict) --* Configuration for a single Parameter in the Amazon Web Services Systems Manager (SSM) Parameter Store in a given Region. * **amiAccountId** *(string) --* Specify the account that will own the Parameter in a given Region. During distribution, this account must be specified in distribution settings as a target account for the Region. * **parameterName** *(string) --* **[REQUIRED]** This is the name of the Parameter in the target Region or account. The image distribution creates the Parameter if it doesn't already exist. Otherwise, it updates the parameter. * **dataType** *(string) --* The data type specifies what type of value the Parameter contains. We recommend that you use data type "aws:ec2:image". * **tags** (*dict*) -- The tags of the distribution configuration. * *(string) --* * *(string) --* * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'clientToken': 'string', 'distributionConfigurationArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **clientToken** *(string) --* The client token that uniquely identifies the request. * **distributionConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the distribution configuration that was created by this request. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceInUseException" * "imagebuilder.Client.exceptions.ResourceAlreadyExistsException" * "imagebuilder.Client.exceptions.InvalidParameterCombinationExcep tion" * "imagebuilder.Client.exceptions.ServiceQuotaExceededException" imagebuilder / Client / get_waiter get_waiter ********** imagebuilder.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" imagebuilder / Client / put_image_recipe_policy put_image_recipe_policy *********************** imagebuilder.Client.put_image_recipe_policy(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.put_image_recipe_policy( imageRecipeArn='string', policy='string' ) Parameters: * **imageRecipeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to. * **policy** (*string*) -- **[REQUIRED]** The policy to apply. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imageRecipeArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imageRecipeArn** *(string) --* The Amazon Resource Name (ARN) of the image recipe that this policy was applied to. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidParameterValueException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / create_infrastructure_configuration create_infrastructure_configuration *********************************** imagebuilder.Client.create_infrastructure_configuration(**kwargs) Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested. See also: AWS API Documentation **Request Syntax** response = client.create_infrastructure_configuration( name='string', description='string', instanceTypes=[ 'string', ], instanceProfileName='string', securityGroupIds=[ 'string', ], subnetId='string', logging={ 's3Logs': { 's3BucketName': 'string', 's3KeyPrefix': 'string' } }, keyPair='string', terminateInstanceOnFailure=True|False, snsTopicArn='string', resourceTags={ 'string': 'string' }, instanceMetadataOptions={ 'httpTokens': 'string', 'httpPutResponseHopLimit': 123 }, tags={ 'string': 'string' }, placement={ 'availabilityZone': 'string', 'tenancy': 'default'|'dedicated'|'host', 'hostId': 'string', 'hostResourceGroupArn': 'string' }, clientToken='string' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the infrastructure configuration. * **description** (*string*) -- The description of the infrastructure configuration. * **instanceTypes** (*list*) -- 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. * *(string) --* * **instanceProfileName** (*string*) -- **[REQUIRED]** The instance profile to associate with the instance used to customize your Amazon EC2 AMI. * **securityGroupIds** (*list*) -- The security group IDs to associate with the instance used to customize your Amazon EC2 AMI. * *(string) --* * **subnetId** (*string*) -- The subnet ID in which to place the instance used to customize your Amazon EC2 AMI. * **logging** (*dict*) -- The logging configuration of the infrastructure configuration. * **s3Logs** *(dict) --* The Amazon S3 logging configuration. * **s3BucketName** *(string) --* The S3 bucket in which to store the logs. * **s3KeyPrefix** *(string) --* The Amazon S3 path to the bucket where the logs are stored. * **keyPair** (*string*) -- The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image. * **terminateInstanceOnFailure** (*boolean*) -- 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. * **snsTopicArn** (*string*) -- The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications. Note: 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. * **resourceTags** (*dict*) -- The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process. Tags are formatted as key value pairs. * *(string) --* * *(string) --* * **instanceMetadataOptions** (*dict*) -- The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances. * **httpTokens** *(string) --* 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**. * **httpPutResponseHopLimit** *(integer) --* 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. * **tags** (*dict*) -- The metadata tags to assign to the infrastructure configuration resource that Image Builder creates as output. Tags are formatted as key value pairs. * *(string) --* * *(string) --* * **placement** (*dict*) -- The instance placement settings that define where the instances that are launched from your image will run. * **availabilityZone** *(string) --* The Availability Zone where your build and test instances will launch. * **tenancy** *(string) --* The tenancy of the instance. An instance with a tenancy of "dedicated" runs on single-tenant hardware. An instance with a tenancy of "host" runs on a Dedicated Host. If tenancy is set to "host", then you can optionally specify one target for placement – either host ID or host resource group ARN. If automatic placement is enabled for your host, and you don't specify any placement target, Amazon EC2 will try to find an available host for your build and test instances. * **hostId** *(string) --* The ID of the Dedicated Host on which build and test instances run. This only applies if "tenancy" is "host". If you specify the host ID, you must not specify the resource group ARN. If you specify both, Image Builder returns an error. * **hostResourceGroupArn** *(string) --* The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances. This only applies if "tenancy" is "host". If you specify the resource group ARN, you must not specify the host ID. If you specify both, Image Builder returns an error. * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'clientToken': 'string', 'infrastructureConfigurationArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **clientToken** *(string) --* The client token that uniquely identifies the request. * **infrastructureConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceInUseException" * "imagebuilder.Client.exceptions.ResourceAlreadyExistsException" * "imagebuilder.Client.exceptions.ServiceQuotaExceededException" imagebuilder / Client / list_component_build_versions list_component_build_versions ***************************** imagebuilder.Client.list_component_build_versions(**kwargs) Returns the list of component build versions for the specified component version Amazon Resource Name (ARN). See also: AWS API Documentation **Request Syntax** response = client.list_component_build_versions( componentVersionArn='string', maxResults=123, nextToken='string' ) Parameters: * **componentVersionArn** (*string*) -- **[REQUIRED]** The component version Amazon Resource Name (ARN) whose versions you want to list. * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'componentSummaryList': [ { 'arn': 'string', 'name': 'string', 'version': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'supportedOsVersions': [ 'string', ], 'state': { 'status': 'DEPRECATED'|'DISABLED'|'ACTIVE', 'reason': 'string' }, 'type': 'BUILD'|'TEST', 'owner': 'string', 'description': 'string', 'changeDescription': 'string', 'dateCreated': 'string', 'tags': { 'string': 'string' }, 'publisher': 'string', 'obfuscate': True|False }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **componentSummaryList** *(list) --* The list of component summaries for the specified semantic version. * *(dict) --* A high-level summary of a component. * **arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **name** *(string) --* The name of the component. * **version** *(string) --* The version of the component. * **platform** *(string) --* The operating system platform of the component. * **supportedOsVersions** *(list) --* 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. * *(string) --* * **state** *(dict) --* Describes the current status of the component. * **status** *(string) --* The current state of the component. * **reason** *(string) --* Describes how or why the component changed state. * **type** *(string) --* The component type specifies whether Image Builder uses the component to build the image or only to test it. * **owner** *(string) --* The owner of the component. * **description** *(string) --* The description of the component. * **changeDescription** *(string) --* The change description for the current version of the component. * **dateCreated** *(string) --* The original creation date of the component. * **tags** *(dict) --* The tags that apply to the component. * *(string) --* * *(string) --* * **publisher** *(string) --* Contains the name of the publisher if this is a third- party component. Otherwise, this property is empty. * **obfuscate** *(boolean) --* Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / create_component create_component **************** imagebuilder.Client.create_component(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_component( name='string', semanticVersion='string', description='string', changeDescription='string', platform='Windows'|'Linux'|'macOS', supportedOsVersions=[ 'string', ], data='string', uri='string', kmsKeyId='string', tags={ 'string': 'string' }, clientToken='string' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the component. * **semanticVersion** (*string*) -- **[REQUIRED]** The semantic version of the component. This version follows the semantic version syntax. Note: The semantic version has four nodes: ../. 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. * **description** (*string*) -- Describes the contents of the component. * **changeDescription** (*string*) -- 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 the component. * **platform** (*string*) -- **[REQUIRED]** The operating system platform of the component. * **supportedOsVersions** (*list*) -- 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. * *(string) --* * **data** (*string*) -- 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. * **uri** (*string*) -- 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. * **kmsKeyId** (*string*) -- The ID of the KMS key that is used to encrypt this component. * **tags** (*dict*) -- The tags that apply to the component. * *(string) --* * *(string) --* * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'clientToken': 'string', 'componentBuildVersionArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **clientToken** *(string) --* The client token that uniquely identifies the request. * **componentBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the component that the request created. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.InvalidVersionNumberException" * "imagebuilder.Client.exceptions.ResourceInUseException" * "imagebuilder.Client.exceptions.InvalidParameterCombinationExcep tion" * "imagebuilder.Client.exceptions.ServiceQuotaExceededException" imagebuilder / Client / create_image create_image ************ imagebuilder.Client.create_image(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_image( imageRecipeArn='string', containerRecipeArn='string', distributionConfigurationArn='string', infrastructureConfigurationArn='string', imageTestsConfiguration={ 'imageTestsEnabled': True|False, 'timeoutMinutes': 123 }, enhancedImageMetadataEnabled=True|False, tags={ 'string': 'string' }, clientToken='string', imageScanningConfiguration={ 'imageScanningEnabled': True|False, 'ecrConfiguration': { 'repositoryName': 'string', 'containerTags': [ 'string', ] } }, workflows=[ { 'workflowArn': 'string', 'parameters': [ { 'name': 'string', 'value': [ 'string', ] }, ], 'parallelGroup': 'string', 'onFailure': 'CONTINUE'|'ABORT' }, ], executionRole='string' ) Parameters: * **imageRecipeArn** (*string*) -- The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed. * **containerRecipeArn** (*string*) -- The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested. * **distributionConfigurationArn** (*string*) -- The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline. * **infrastructureConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested. * **imageTestsConfiguration** (*dict*) -- The image tests configuration of the image. * **imageTestsEnabled** *(boolean) --* Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution. * **timeoutMinutes** *(integer) --* The maximum time in minutes that tests are permitted to run. Note: The timeout property is not currently active. This value is ignored. * **enhancedImageMetadataEnabled** (*boolean*) -- 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. * **tags** (*dict*) -- The tags of the image. * *(string) --* * *(string) --* * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. * **imageScanningConfiguration** (*dict*) -- Contains settings for vulnerability scans. * **imageScanningEnabled** *(boolean) --* A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image. * **ecrConfiguration** *(dict) --* Contains Amazon ECR settings for vulnerability scans. * **repositoryName** *(string) --* 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. * **containerTags** *(list) --* Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can help you identify and manage your scanned images. * *(string) --* * **workflows** (*list*) -- Contains an array of workflow configuration objects. * *(dict) --* Contains control settings and configurable inputs for a workflow resource. * **workflowArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the workflow resource. * **parameters** *(list) --* Contains parameter values for each of the parameters that the workflow document defined for the workflow resource. * *(dict) --* Contains a key/value pair that sets the named workflow parameter. * **name** *(string) --* **[REQUIRED]** The name of the workflow parameter to set. * **value** *(list) --* **[REQUIRED]** Sets the value for the named workflow parameter. * *(string) --* * **parallelGroup** *(string) --* Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows. * **onFailure** *(string) --* The action to take if the workflow fails. * **executionRole** (*string*) -- The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'clientToken': 'string', 'imageBuildVersionArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **clientToken** *(string) --* The client token that uniquely identifies the request. * **imageBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the image that the request created. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceInUseException" * "imagebuilder.Client.exceptions.ServiceQuotaExceededException" imagebuilder / Client / put_image_policy put_image_policy **************** imagebuilder.Client.put_image_policy(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.put_image_policy( imageArn='string', policy='string' ) Parameters: * **imageArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image that this policy should be applied to. * **policy** (*string*) -- **[REQUIRED]** The policy to apply. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imageArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imageArn** *(string) --* The Amazon Resource Name (ARN) of the image that this policy was applied to. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidParameterValueException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / import_disk_image import_disk_image ***************** imagebuilder.Client.import_disk_image(**kwargs) Import a Windows operating system image from a verified Microsoft ISO disk file. The following disk images are supported: * Windows 11 Enterprise See also: AWS API Documentation **Request Syntax** response = client.import_disk_image( name='string', semanticVersion='string', description='string', platform='string', osVersion='string', executionRole='string', infrastructureConfigurationArn='string', uri='string', tags={ 'string': 'string' }, clientToken='string' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the image resource that's created from the import. * **semanticVersion** (*string*) -- **[REQUIRED]** The semantic version to attach to the image that's created during the import process. This version follows the semantic version syntax. * **description** (*string*) -- The description for your disk image import. * **platform** (*string*) -- **[REQUIRED]** The operating system platform for the imported image. Allowed values include the following: "Windows". * **osVersion** (*string*) -- **[REQUIRED]** The operating system version for the imported image. Allowed values include the following: "Microsoft Windows 11". * **executionRole** (*string*) -- The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions to import an image from a Microsoft ISO file. * **infrastructureConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the infrastructure configuration resource that's used for launching the EC2 instance on which the ISO image is built. * **uri** (*string*) -- **[REQUIRED]** The "uri" of the ISO disk file that's stored in Amazon S3. * **tags** (*dict*) -- Tags that are attached to image resources created from the import. * *(string) --* * *(string) --* * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'clientToken': 'string', 'imageBuildVersionArn': 'string' } **Response Structure** * *(dict) --* * **clientToken** *(string) --* The client token that uniquely identifies the request. * **imageBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the output AMI that was created from the ISO disk file. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" imagebuilder / Client / get_distribution_configuration get_distribution_configuration ****************************** imagebuilder.Client.get_distribution_configuration(**kwargs) Gets a distribution configuration. See also: AWS API Documentation **Request Syntax** response = client.get_distribution_configuration( distributionConfigurationArn='string' ) Parameters: **distributionConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'distributionConfiguration': { 'arn': 'string', 'name': 'string', 'description': 'string', 'distributions': [ { 'region': 'string', 'amiDistributionConfiguration': { 'name': 'string', 'description': 'string', 'targetAccountIds': [ 'string', ], 'amiTags': { 'string': 'string' }, 'kmsKeyId': 'string', 'launchPermission': { 'userIds': [ 'string', ], 'userGroups': [ 'string', ], 'organizationArns': [ 'string', ], 'organizationalUnitArns': [ 'string', ] } }, 'containerDistributionConfiguration': { 'description': 'string', 'containerTags': [ 'string', ], 'targetRepository': { 'service': 'ECR', 'repositoryName': 'string' } }, 'licenseConfigurationArns': [ 'string', ], 'launchTemplateConfigurations': [ { 'launchTemplateId': 'string', 'accountId': 'string', 'setDefaultVersion': True|False }, ], 's3ExportConfiguration': { 'roleName': 'string', 'diskImageFormat': 'VMDK'|'RAW'|'VHD', 's3Bucket': 'string', 's3Prefix': 'string' }, 'fastLaunchConfigurations': [ { 'enabled': True|False, 'snapshotConfiguration': { 'targetResourceCount': 123 }, 'maxParallelLaunches': 123, 'launchTemplate': { 'launchTemplateId': 'string', 'launchTemplateName': 'string', 'launchTemplateVersion': 'string' }, 'accountId': 'string' }, ], 'ssmParameterConfigurations': [ { 'amiAccountId': 'string', 'parameterName': 'string', 'dataType': 'text'|'aws:ec2:image' }, ] }, ], 'timeoutMinutes': 123, 'dateCreated': 'string', 'dateUpdated': 'string', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **distributionConfiguration** *(dict) --* The distribution configuration object. * **arn** *(string) --* The Amazon Resource Name (ARN) of the distribution configuration. * **name** *(string) --* The name of the distribution configuration. * **description** *(string) --* The description of the distribution configuration. * **distributions** *(list) --* The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions. * *(dict) --* Defines the settings for a specific Region. * **region** *(string) --* The target Region. * **amiDistributionConfiguration** *(dict) --* The specific AMI settings; for example, launch permissions or AMI tags. * **name** *(string) --* The name of the output AMI. * **description** *(string) --* The description of the AMI distribution configuration. Minimum and maximum length are in characters. * **targetAccountIds** *(list) --* The ID of an account to which you want to distribute an image. * *(string) --* * **amiTags** *(dict) --* The tags to apply to AMIs distributed to this Region. * *(string) --* * *(string) --* * **kmsKeyId** *(string) --* The KMS key identifier used to encrypt the distributed image. * **launchPermission** *(dict) --* Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances. * **userIds** *(list) --* The Amazon Web Services account ID. * *(string) --* * **userGroups** *(list) --* The name of the group. * *(string) --* * **organizationArns** *(list) --* The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?. * *(string) --* * **organizationalUnitArns** *(list) --* 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. * *(string) --* * **containerDistributionConfiguration** *(dict) --* Container distribution settings for encryption, licensing, and sharing in a specific Region. * **description** *(string) --* The description of the container distribution configuration. * **containerTags** *(list) --* Tags that are attached to the container distribution configuration. * *(string) --* * **targetRepository** *(dict) --* The destination repository for the container distribution configuration. * **service** *(string) --* Specifies the service in which this image was registered. * **repositoryName** *(string) --* The name of the container repository where the output container image is stored. This name is prefixed by the repository location. For example, "/repository_name". * **licenseConfigurationArns** *(list) --* The License Manager Configuration to associate with the AMI in the specified Region. * *(string) --* * **launchTemplateConfigurations** *(list) --* A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts. * *(dict) --* Identifies an Amazon EC2 launch template to use for a specific account. * **launchTemplateId** *(string) --* Identifies the Amazon EC2 launch template to use. * **accountId** *(string) --* The account ID that this configuration applies to. * **setDefaultVersion** *(boolean) --* Set the specified Amazon EC2 launch template as the default launch template for the specified account. * **s3ExportConfiguration** *(dict) --* 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. * **roleName** *(string) --* The name of the role that grants VM Import/Export permission to export images to your S3 bucket. * **diskImageFormat** *(string) --* 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. * **s3Bucket** *(string) --* The S3 bucket in which to store the output disk images for your VM. * **s3Prefix** *(string) --* The Amazon S3 path for the bucket where the output disk images for your VM are stored. * **fastLaunchConfigurations** *(list) --* The Windows faster-launching configurations to use for AMI distribution. * *(dict) --* Define and configure faster launching for output Windows AMIs. * **enabled** *(boolean) --* A Boolean that represents the current state of faster launching for the Windows AMI. Set to "true" to start using Windows faster launching, or "false" to stop using it. * **snapshotConfiguration** *(dict) --* Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled. * **targetResourceCount** *(integer) --* The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI. * **maxParallelLaunches** *(integer) --* The maximum number of parallel instances that are launched for creating resources. * **launchTemplate** *(dict) --* The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots. * **launchTemplateId** *(string) --* The ID of the launch template to use for faster launching for a Windows AMI. * **launchTemplateName** *(string) --* The name of the launch template to use for faster launching for a Windows AMI. * **launchTemplateVersion** *(string) --* The version of the launch template to use for faster launching for a Windows AMI. * **accountId** *(string) --* The owner account ID for the fast-launch enabled Windows AMI. * **ssmParameterConfigurations** *(list) --* Contains settings to update Amazon Web Services Systems Manager (SSM) Parameter Store Parameters with output AMI IDs from the build by target Region. * *(dict) --* Configuration for a single Parameter in the Amazon Web Services Systems Manager (SSM) Parameter Store in a given Region. * **amiAccountId** *(string) --* Specify the account that will own the Parameter in a given Region. During distribution, this account must be specified in distribution settings as a target account for the Region. * **parameterName** *(string) --* This is the name of the Parameter in the target Region or account. The image distribution creates the Parameter if it doesn't already exist. Otherwise, it updates the parameter. * **dataType** *(string) --* The data type specifies what type of value the Parameter contains. We recommend that you use data type "aws:ec2:image". * **timeoutMinutes** *(integer) --* The maximum duration in minutes for this distribution configuration. * **dateCreated** *(string) --* The date on which this distribution configuration was created. * **dateUpdated** *(string) --* The date on which this distribution configuration was last updated. * **tags** *(dict) --* The tags of the distribution configuration. * *(string) --* * *(string) --* **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / get_lifecycle_policy get_lifecycle_policy ******************** imagebuilder.Client.get_lifecycle_policy(**kwargs) Get details for the specified image lifecycle policy. See also: AWS API Documentation **Request Syntax** response = client.get_lifecycle_policy( lifecyclePolicyArn='string' ) Parameters: **lifecyclePolicyArn** (*string*) -- **[REQUIRED]** Specifies the Amazon Resource Name (ARN) of the image lifecycle policy resource to get. Return type: dict Returns: **Response Syntax** { 'lifecyclePolicy': { 'arn': 'string', 'name': 'string', 'description': 'string', 'status': 'DISABLED'|'ENABLED', 'executionRole': 'string', 'resourceType': 'AMI_IMAGE'|'CONTAINER_IMAGE', 'policyDetails': [ { 'action': { 'type': 'DELETE'|'DEPRECATE'|'DISABLE', 'includeResources': { 'amis': True|False, 'snapshots': True|False, 'containers': True|False } }, 'filter': { 'type': 'AGE'|'COUNT', 'value': 123, 'unit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS', 'retainAtLeast': 123 }, 'exclusionRules': { 'tagMap': { 'string': 'string' }, 'amis': { 'isPublic': True|False, 'regions': [ 'string', ], 'sharedAccounts': [ 'string', ], 'lastLaunched': { 'value': 123, 'unit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS' }, 'tagMap': { 'string': 'string' } } } }, ], 'resourceSelection': { 'recipes': [ { 'name': 'string', 'semanticVersion': 'string' }, ], 'tagMap': { 'string': 'string' } }, 'dateCreated': datetime(2015, 1, 1), 'dateUpdated': datetime(2015, 1, 1), 'dateLastRun': datetime(2015, 1, 1), 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **lifecyclePolicy** *(dict) --* The ARN of the image lifecycle policy resource that was returned. * **arn** *(string) --* The Amazon Resource Name (ARN) of the lifecycle policy resource. * **name** *(string) --* The name of the lifecycle policy. * **description** *(string) --* Optional description for the lifecycle policy. * **status** *(string) --* Indicates whether the lifecycle policy resource is enabled. * **executionRole** *(string) --* The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy. This is a custom role that you create. * **resourceType** *(string) --* The type of resources the lifecycle policy targets. * **policyDetails** *(list) --* The configuration details for a lifecycle policy resource. * *(dict) --* The configuration details for a lifecycle policy resource. * **action** *(dict) --* Configuration details for the policy action. * **type** *(string) --* Specifies the lifecycle action to take. * **includeResources** *(dict) --* Specifies the resources that the lifecycle policy applies to. * **amis** *(boolean) --* Specifies whether the lifecycle action should apply to distributed AMIs. * **snapshots** *(boolean) --* Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs. * **containers** *(boolean) --* Specifies whether the lifecycle action should apply to distributed containers. * **filter** *(dict) --* Specifies the resources that the lifecycle policy applies to. * **type** *(string) --* Filter resources based on either "age" or "count". * **value** *(integer) --* The number of units for the time period or for the count. For example, a value of "6" might refer to six months or six AMIs. Note: For count-based filters, this value represents the minimum number of resources to keep on hand. If you have fewer resources than this number, the resource is excluded from lifecycle actions. * **unit** *(string) --* Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules. * **retainAtLeast** *(integer) --* For age-based filters, this is the number of resources to keep on hand after the lifecycle "DELETE" action is applied. Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted. * **exclusionRules** *(dict) --* Additional rules to specify resources that should be exempt from policy actions. * **tagMap** *(dict) --* Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them. * *(string) --* * *(string) --* * **amis** *(dict) --* Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action. * **isPublic** *(boolean) --* Configures whether public AMIs are excluded from the lifecycle action. * **regions** *(list) --* Configures Amazon Web Services Regions that are excluded from the lifecycle action. * *(string) --* * **sharedAccounts** *(list) --* Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action. * *(string) --* * **lastLaunched** *(dict) --* Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions. * **value** *(integer) --* The integer number of units for the time period. For example "6" (months). * **unit** *(string) --* Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last instance launched from the AMI. For example: days, weeks, months, or years. * **tagMap** *(dict) --* Lists tags that should be excluded from lifecycle actions for the AMIs that have them. * *(string) --* * *(string) --* * **resourceSelection** *(dict) --* Resource selection criteria used to run the lifecycle policy. * **recipes** *(list) --* A list of recipes that are used as selection criteria for the output images that the lifecycle policy applies to. * *(dict) --* Specifies an Image Builder recipe that the lifecycle policy uses for resource selection. * **name** *(string) --* The name of an Image Builder recipe that the lifecycle policy uses for resource selection. * **semanticVersion** *(string) --* The version of the Image Builder recipe specified by the "name" field. * **tagMap** *(dict) --* A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to. * *(string) --* * *(string) --* * **dateCreated** *(datetime) --* The timestamp when Image Builder created the lifecycle policy resource. * **dateUpdated** *(datetime) --* The timestamp when Image Builder updated the lifecycle policy resource. * **dateLastRun** *(datetime) --* The timestamp for the last time Image Builder ran the lifecycle policy. * **tags** *(dict) --* To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define. * *(string) --* * *(string) --* **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / list_lifecycle_execution_resources list_lifecycle_execution_resources ********************************** imagebuilder.Client.list_lifecycle_execution_resources(**kwargs) List resources that the runtime instance of the image lifecycle identified for lifecycle actions. See also: AWS API Documentation **Request Syntax** response = client.list_lifecycle_execution_resources( lifecycleExecutionId='string', parentResourceId='string', maxResults=123, nextToken='string' ) Parameters: * **lifecycleExecutionId** (*string*) -- **[REQUIRED]** Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details. * **parentResourceId** (*string*) -- You can leave this empty to get a list of Image Builder resources that were identified for lifecycle actions. To get a list of associated resources that are impacted for an individual resource (the parent), specify its Amazon Resource Name (ARN). Associated resources are produced from your image and distributed when you run a build, such as AMIs or container images stored in ECR repositories. * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'lifecycleExecutionId': 'string', 'lifecycleExecutionState': { 'status': 'IN_PROGRESS'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'PENDING', 'reason': 'string' }, 'resources': [ { 'accountId': 'string', 'resourceId': 'string', 'state': { 'status': 'FAILED'|'IN_PROGRESS'|'SKIPPED'|'SUCCESS', 'reason': 'string' }, 'action': { 'name': 'AVAILABLE'|'DELETE'|'DEPRECATE'|'DISABLE', 'reason': 'string' }, 'region': 'string', 'snapshots': [ { 'snapshotId': 'string', 'state': { 'status': 'FAILED'|'IN_PROGRESS'|'SKIPPED'|'SUCCESS', 'reason': 'string' } }, ], 'imageUris': [ 'string', ], 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **lifecycleExecutionId** *(string) --* Runtime details for the specified runtime instance of the lifecycle policy. * **lifecycleExecutionState** *(dict) --* The current state of the lifecycle runtime instance. * **status** *(string) --* The runtime status of the lifecycle execution. * **reason** *(string) --* The reason for the current status. * **resources** *(list) --* A list of resources that were identified for lifecycle actions. * *(dict) --* Contains details for a resource that the runtime instance of the lifecycle policy identified for action. * **accountId** *(string) --* The account that owns the impacted resource. * **resourceId** *(string) --* Identifies the impacted resource. The resource ID depends on the type of resource, as follows. * Image Builder image resources: Amazon Resource Name (ARN) * Distributed AMIs: AMI ID * Container images distributed to an ECR repository: image URI or SHA Digest * **state** *(dict) --* The runtime state for the lifecycle execution. * **status** *(string) --* The runtime status of the lifecycle action taken for the impacted resource. * **reason** *(string) --* Messaging that clarifies the reason for the assigned status. * **action** *(dict) --* The action to take for the identified resource. * **name** *(string) --* The name of the resource that was identified for a lifecycle policy action. * **reason** *(string) --* The reason why the lifecycle policy action is taken. * **region** *(string) --* The Amazon Web Services Region where the lifecycle execution resource is stored. * **snapshots** *(list) --* A list of associated resource snapshots for the impacted resource if it’s an AMI. * *(dict) --* Contains the state of an impacted snapshot resource that the runtime instance of the lifecycle policy identified for action. * **snapshotId** *(string) --* Identifies the impacted snapshot resource. * **state** *(dict) --* The runtime status of the lifecycle action taken for the snapshot. * **status** *(string) --* The runtime status of the lifecycle action taken for the impacted resource. * **reason** *(string) --* Messaging that clarifies the reason for the assigned status. * **imageUris** *(list) --* For an impacted container image, this identifies a list of URIs for associated container images distributed to ECR repositories. * *(string) --* * **startTime** *(datetime) --* The starting timestamp from the lifecycle action that was applied to the resource. * **endTime** *(datetime) --* The ending timestamp from the lifecycle action that was applied to the resource. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / update_infrastructure_configuration update_infrastructure_configuration *********************************** imagebuilder.Client.update_infrastructure_configuration(**kwargs) Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested. See also: AWS API Documentation **Request Syntax** response = client.update_infrastructure_configuration( infrastructureConfigurationArn='string', description='string', instanceTypes=[ 'string', ], instanceProfileName='string', securityGroupIds=[ 'string', ], subnetId='string', logging={ 's3Logs': { 's3BucketName': 'string', 's3KeyPrefix': 'string' } }, keyPair='string', terminateInstanceOnFailure=True|False, snsTopicArn='string', resourceTags={ 'string': 'string' }, instanceMetadataOptions={ 'httpTokens': 'string', 'httpPutResponseHopLimit': 123 }, placement={ 'availabilityZone': 'string', 'tenancy': 'default'|'dedicated'|'host', 'hostId': 'string', 'hostResourceGroupArn': 'string' }, clientToken='string' ) Parameters: * **infrastructureConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update. * **description** (*string*) -- The description of the infrastructure configuration. * **instanceTypes** (*list*) -- 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. * *(string) --* * **instanceProfileName** (*string*) -- **[REQUIRED]** The instance profile to associate with the instance used to customize your Amazon EC2 AMI. * **securityGroupIds** (*list*) -- The security group IDs to associate with the instance used to customize your Amazon EC2 AMI. * *(string) --* * **subnetId** (*string*) -- The subnet ID to place the instance used to customize your Amazon EC2 AMI in. * **logging** (*dict*) -- The logging configuration of the infrastructure configuration. * **s3Logs** *(dict) --* The Amazon S3 logging configuration. * **s3BucketName** *(string) --* The S3 bucket in which to store the logs. * **s3KeyPrefix** *(string) --* The Amazon S3 path to the bucket where the logs are stored. * **keyPair** (*string*) -- The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image. * **terminateInstanceOnFailure** (*boolean*) -- 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. * **snsTopicArn** (*string*) -- The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications. Note: 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. * **resourceTags** (*dict*) -- The tags attached to the resource created by Image Builder. * *(string) --* * *(string) --* * **instanceMetadataOptions** (*dict*) -- 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. * **httpTokens** *(string) --* 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**. * **httpPutResponseHopLimit** *(integer) --* 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. * **placement** (*dict*) -- The instance placement settings that define where the instances that are launched from your image will run. * **availabilityZone** *(string) --* The Availability Zone where your build and test instances will launch. * **tenancy** *(string) --* The tenancy of the instance. An instance with a tenancy of "dedicated" runs on single-tenant hardware. An instance with a tenancy of "host" runs on a Dedicated Host. If tenancy is set to "host", then you can optionally specify one target for placement – either host ID or host resource group ARN. If automatic placement is enabled for your host, and you don't specify any placement target, Amazon EC2 will try to find an available host for your build and test instances. * **hostId** *(string) --* The ID of the Dedicated Host on which build and test instances run. This only applies if "tenancy" is "host". If you specify the host ID, you must not specify the resource group ARN. If you specify both, Image Builder returns an error. * **hostResourceGroupArn** *(string) --* The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances. This only applies if "tenancy" is "host". If you specify the resource group ARN, you must not specify the host ID. If you specify both, Image Builder returns an error. * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'clientToken': 'string', 'infrastructureConfigurationArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **clientToken** *(string) --* The client token that uniquely identifies the request. * **infrastructureConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceInUseException" imagebuilder / Client / delete_image delete_image ************ imagebuilder.Client.delete_image(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.delete_image( imageBuildVersionArn='string' ) Parameters: **imageBuildVersionArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Image Builder image resource to delete. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imageBuildVersionArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imageBuildVersionArn** *(string) --* The ARN of the Image Builder image resource that this request deleted. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceDependencyException" imagebuilder / Client / list_images list_images *********** imagebuilder.Client.list_images(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_images( owner='Self'|'Shared'|'Amazon'|'ThirdParty'|'AWSMarketplace', filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], byName=True|False, maxResults=123, nextToken='string', includeDeprecated=True|False ) Parameters: * **owner** (*string*) -- 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. * **filters** (*list*) -- Use the following filters to streamline results: * "name" * "osVersion" * "platform" * "type" * "version" * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **byName** (*boolean*) -- Requests a list of images with a specific recipe name. * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. * **includeDeprecated** (*boolean*) -- Includes deprecated images in the response list. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imageVersionList': [ { 'arn': 'string', 'name': 'string', 'type': 'AMI'|'DOCKER', 'version': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'osVersion': 'string', 'owner': 'string', 'dateCreated': 'string', 'buildType': 'USER_INITIATED'|'SCHEDULED'|'IMPORT'|'IMPORT_ISO', 'imageSource': 'AMAZON_MANAGED'|'AWS_MARKETPLACE'|'IMPORTED'|'CUSTOM' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imageVersionList** *(list) --* The list of image semantic versions. Note: The semantic version has four nodes: ../. 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. * *(dict) --* The defining characteristics of a specific version of an Image Builder image. * **arn** *(string) --* The Amazon Resource Name (ARN) of a specific version of an Image Builder image. Note: 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: .. * Build version ARNs have all four nodes, and point to a specific build for a specific version of an object. * **name** *(string) --* The name of this specific version of an Image Builder image. * **type** *(string) --* Specifies whether this image produces an AMI or a container image. * **version** *(string) --* Details for a specific version of an Image Builder image. This version follows the semantic version syntax. Note: The semantic version has four nodes: ../. 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. * **platform** *(string) --* The operating system platform of the image version, for example "Windows" or "Linux". * **osVersion** *(string) --* The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019. * **owner** *(string) --* The owner of the image version. * **dateCreated** *(string) --* The date on which this specific version of the Image Builder image was created. * **buildType** *(string) --* 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. * **IMPORT_ISO** – An ISO disk import created the image. * **imageSource** *(string) --* The origin of the base image that Image Builder used to build this image. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / start_image_pipeline_execution start_image_pipeline_execution ****************************** imagebuilder.Client.start_image_pipeline_execution(**kwargs) Manually triggers a pipeline to create an image. See also: AWS API Documentation **Request Syntax** response = client.start_image_pipeline_execution( imagePipelineArn='string', clientToken='string' ) Parameters: * **imagePipelineArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke. * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'clientToken': 'string', 'imageBuildVersionArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **clientToken** *(string) --* The client token that uniquely identifies the request. * **imageBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the image that the request created. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceInUseException" imagebuilder / Client / delete_lifecycle_policy delete_lifecycle_policy *********************** imagebuilder.Client.delete_lifecycle_policy(**kwargs) Delete the specified lifecycle policy resource. See also: AWS API Documentation **Request Syntax** response = client.delete_lifecycle_policy( lifecyclePolicyArn='string' ) Parameters: **lifecyclePolicyArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the lifecycle policy resource to delete. Return type: dict Returns: **Response Syntax** { 'lifecyclePolicyArn': 'string' } **Response Structure** * *(dict) --* * **lifecyclePolicyArn** *(string) --* The ARN of the lifecycle policy that was deleted. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceDependencyException" imagebuilder / Client / delete_infrastructure_configuration delete_infrastructure_configuration *********************************** imagebuilder.Client.delete_infrastructure_configuration(**kwargs) Deletes an infrastructure configuration. See also: AWS API Documentation **Request Syntax** response = client.delete_infrastructure_configuration( infrastructureConfigurationArn='string' ) Parameters: **infrastructureConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the infrastructure configuration to delete. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'infrastructureConfigurationArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **infrastructureConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceDependencyException" imagebuilder / Client / create_workflow create_workflow *************** imagebuilder.Client.create_workflow(**kwargs) Create a new workflow or a new version of an existing workflow. See also: AWS API Documentation **Request Syntax** response = client.create_workflow( name='string', semanticVersion='string', description='string', changeDescription='string', data='string', uri='string', kmsKeyId='string', tags={ 'string': 'string' }, clientToken='string', type='BUILD'|'TEST'|'DISTRIBUTION' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the workflow to create. * **semanticVersion** (*string*) -- **[REQUIRED]** The semantic version of this workflow resource. The semantic version syntax adheres to the following rules. Note: The semantic version has four nodes: ../. 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. * **description** (*string*) -- Describes the workflow. * **changeDescription** (*string*) -- Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow. * **data** (*string*) -- Contains the UTF-8 encoded YAML document content for the workflow. Alternatively, you can specify the "uri" of a YAML document file stored in Amazon S3. However, you cannot specify both properties. * **uri** (*string*) -- 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. * **kmsKeyId** (*string*) -- The ID of the KMS key that is used to encrypt this workflow resource. * **tags** (*dict*) -- Tags that apply to the workflow resource. * *(string) --* * *(string) --* * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. * **type** (*string*) -- **[REQUIRED]** The phase in the image build process for which the workflow resource is responsible. Return type: dict Returns: **Response Syntax** { 'clientToken': 'string', 'workflowBuildVersionArn': 'string' } **Response Structure** * *(dict) --* * **clientToken** *(string) --* The client token that uniquely identifies the request. * **workflowBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the workflow resource that the request created. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.InvalidVersionNumberException" * "imagebuilder.Client.exceptions.ResourceInUseException" * "imagebuilder.Client.exceptions.InvalidParameterCombinationExcep tion" * "imagebuilder.Client.exceptions.ServiceQuotaExceededException" imagebuilder / Client / get_component get_component ************* imagebuilder.Client.get_component(**kwargs) Gets a component object. See also: AWS API Documentation **Request Syntax** response = client.get_component( componentBuildVersionArn='string' ) Parameters: **componentBuildVersionArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the component that you want to get. Regex requires the suffix "/\d+$". Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'component': { 'arn': 'string', 'name': 'string', 'version': 'string', 'description': 'string', 'changeDescription': 'string', 'type': 'BUILD'|'TEST', 'platform': 'Windows'|'Linux'|'macOS', 'supportedOsVersions': [ 'string', ], 'state': { 'status': 'DEPRECATED'|'DISABLED'|'ACTIVE', 'reason': 'string' }, 'parameters': [ { 'name': 'string', 'type': 'string', 'defaultValue': [ 'string', ], 'description': 'string' }, ], 'owner': 'string', 'data': 'string', 'kmsKeyId': 'string', 'encrypted': True|False, 'dateCreated': 'string', 'tags': { 'string': 'string' }, 'publisher': 'string', 'obfuscate': True|False, 'productCodes': [ { 'productCodeId': 'string', 'productCodeType': 'marketplace' }, ] } } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **component** *(dict) --* The component object specified in the request. * **arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **name** *(string) --* The name of the component. * **version** *(string) --* The version of the component. * **description** *(string) --* The description of the component. * **changeDescription** *(string) --* Describes what change has been made in this version of the component, or what makes this version different from other versions of the component. * **type** *(string) --* The component type specifies whether Image Builder uses the component to build the image or only to test it. * **platform** *(string) --* The operating system platform of the component. * **supportedOsVersions** *(list) --* 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. * *(string) --* * **state** *(dict) --* Describes the current status of the component. * **status** *(string) --* The current state of the component. * **reason** *(string) --* Describes how or why the component changed state. * **parameters** *(list) --* Contains parameter details for each of the parameters that the component document defined for the component. * *(dict) --* Defines a parameter that is used to provide configuration details for the component. * **name** *(string) --* The name of this input parameter. * **type** *(string) --* The type of input this parameter provides. The currently supported value is "string". * **defaultValue** *(list) --* The default value of this parameter if no input is provided. * *(string) --* * **description** *(string) --* Describes this parameter. * **owner** *(string) --* The owner of the component. * **data** *(string) --* Component data contains the YAML document content for the component. * **kmsKeyId** *(string) --* The KMS key identifier used to encrypt the component. * **encrypted** *(boolean) --* The encryption status of the component. * **dateCreated** *(string) --* The date that Image Builder created the component. * **tags** *(dict) --* The tags that apply to the component. * *(string) --* * *(string) --* * **publisher** *(string) --* Contains the name of the publisher if this is a third- party component. Otherwise, this property is empty. * **obfuscate** *(boolean) --* Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations. * **productCodes** *(list) --* Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components. * *(dict) --* Information about a single product code. * **productCodeId** *(string) --* For Amazon Web Services Marketplace components, this contains the product code ID that can be stamped onto an EC2 AMI to ensure that components are billed correctly. If this property is empty, it might mean that the component is not published. * **productCodeType** *(string) --* The owner of the product code that's billed. If this property is empty, it might mean that the component is not published. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / cancel_lifecycle_execution cancel_lifecycle_execution ************************** imagebuilder.Client.cancel_lifecycle_execution(**kwargs) Cancel a specific image lifecycle policy runtime instance. See also: AWS API Documentation **Request Syntax** response = client.cancel_lifecycle_execution( lifecycleExecutionId='string', clientToken='string' ) Parameters: * **lifecycleExecutionId** (*string*) -- **[REQUIRED]** Identifies the specific runtime instance of the image lifecycle to cancel. * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'lifecycleExecutionId': 'string' } **Response Structure** * *(dict) --* * **lifecycleExecutionId** *(string) --* The unique identifier for the image lifecycle runtime instance that was canceled. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceInUseException" imagebuilder / Client / close close ***** imagebuilder.Client.close() Closes underlying endpoint connections. imagebuilder / Client / list_waiting_workflow_steps list_waiting_workflow_steps *************************** imagebuilder.Client.list_waiting_workflow_steps(**kwargs) Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.list_waiting_workflow_steps( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'steps': [ { 'stepExecutionId': 'string', 'imageBuildVersionArn': 'string', 'workflowExecutionId': 'string', 'workflowBuildVersionArn': 'string', 'name': 'string', 'action': 'string', 'startTime': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **steps** *(list) --* An array of the workflow steps that are waiting for action in your Amazon Web Services account. * *(dict) --* Contains runtime details for an instance of a workflow that ran for the associated image build version. * **stepExecutionId** *(string) --* Uniquely identifies the workflow step that ran for the associated image build version. * **imageBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the image build version that ran the workflow. * **workflowExecutionId** *(string) --* Uniquely identifies the runtime instance of the workflow that contains the workflow step that ran for the associated image build version. * **workflowBuildVersionArn** *(string) --* The ARN of the workflow resource that ran. * **name** *(string) --* The name of the workflow step. * **action** *(string) --* The name of the step action. * **startTime** *(string) --* The timestamp when the workflow step started. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / create_container_recipe create_container_recipe *********************** imagebuilder.Client.create_container_recipe(**kwargs) Creates a new container recipe. Container recipes define how images are configured, tested, and assessed. See also: AWS API Documentation **Request Syntax** response = client.create_container_recipe( containerType='DOCKER', name='string', description='string', semanticVersion='string', components=[ { 'componentArn': 'string', 'parameters': [ { 'name': 'string', 'value': [ 'string', ] }, ] }, ], instanceConfiguration={ 'image': 'string', 'blockDeviceMappings': [ { 'deviceName': 'string', 'ebs': { 'encrypted': True|False, 'deleteOnTermination': True|False, 'iops': 123, 'kmsKeyId': 'string', 'snapshotId': 'string', 'volumeSize': 123, 'volumeType': 'standard'|'io1'|'io2'|'gp2'|'gp3'|'sc1'|'st1', 'throughput': 123 }, 'virtualName': 'string', 'noDevice': 'string' }, ] }, dockerfileTemplateData='string', dockerfileTemplateUri='string', platformOverride='Windows'|'Linux'|'macOS', imageOsVersionOverride='string', parentImage='string', tags={ 'string': 'string' }, workingDirectory='string', targetRepository={ 'service': 'ECR', 'repositoryName': 'string' }, kmsKeyId='string', clientToken='string' ) Parameters: * **containerType** (*string*) -- **[REQUIRED]** The type of container to create. * **name** (*string*) -- **[REQUIRED]** The name of the container recipe. * **description** (*string*) -- The description of the container recipe. * **semanticVersion** (*string*) -- **[REQUIRED]** The semantic version of the container recipe. This version follows the semantic version syntax. Note: The semantic version has four nodes: ../. 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. * **components** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Configuration details of the component. * **componentArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the component. * **parameters** *(list) --* A group of parameter settings that Image Builder uses to configure the component for a specific recipe. * *(dict) --* Contains a key/value pair that sets the named component parameter. * **name** *(string) --* **[REQUIRED]** The name of the component parameter to set. * **value** *(list) --* **[REQUIRED]** Sets the value for the named component parameter. * *(string) --* * **instanceConfiguration** (*dict*) -- A group of options that can be used to configure an instance for building and testing container images. * **image** *(string) --* The base image for a container build and test instance. This can contain an AMI ID or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by "ssm:", followed by the parameter name or ARN. If not specified, Image Builder uses the appropriate ECS- optimized AMI as a base image. * **blockDeviceMappings** *(list) --* Defines the block devices to attach for building an instance from this Image Builder AMI. * *(dict) --* Defines block device mappings for the instance used to configure your image. * **deviceName** *(string) --* The device to which these mappings apply. * **ebs** *(dict) --* Use to manage Amazon EBS-specific configuration for this mapping. * **encrypted** *(boolean) --* Use to configure device encryption. * **deleteOnTermination** *(boolean) --* Use to configure delete on termination of the associated device. * **iops** *(integer) --* Use to configure device IOPS. * **kmsKeyId** *(string) --* Use to configure the KMS key to use when encrypting the device. * **snapshotId** *(string) --* The snapshot that defines the device contents. * **volumeSize** *(integer) --* Use to override the device's volume size. * **volumeType** *(string) --* Use to override the device's volume type. * **throughput** *(integer) --* **For GP3 volumes only** – The throughput in MiB/s that the volume supports. * **virtualName** *(string) --* Use to manage instance ephemeral devices. * **noDevice** *(string) --* Use to remove a mapping from the base image. * **dockerfileTemplateData** (*string*) -- The Dockerfile template used to build your image as an inline data blob. * **dockerfileTemplateUri** (*string*) -- The Amazon S3 URI for the Dockerfile that will be used to build your container image. * **platformOverride** (*string*) -- Specifies the operating system platform when you use a custom base image. * **imageOsVersionOverride** (*string*) -- Specifies the operating system version for the base image. * **parentImage** (*string*) -- **[REQUIRED]** The base image for the container recipe. * **tags** (*dict*) -- Tags that are attached to the container recipe. * *(string) --* * *(string) --* * **workingDirectory** (*string*) -- The working directory for use during build and test workflows. * **targetRepository** (*dict*) -- **[REQUIRED]** The destination repository for the container image. * **service** *(string) --* **[REQUIRED]** Specifies the service in which this image was registered. * **repositoryName** *(string) --* **[REQUIRED]** The name of the container repository where the output container image is stored. This name is prefixed by the repository location. For example, "/repository_name". * **kmsKeyId** (*string*) -- Identifies which KMS key is used to encrypt the Dockerfile template. * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'clientToken': 'string', 'containerRecipeArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **clientToken** *(string) --* The client token that uniquely identifies the request. * **containerRecipeArn** *(string) --* Returns the Amazon Resource Name (ARN) of the container recipe that the request created. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.InvalidVersionNumberException" * "imagebuilder.Client.exceptions.ResourceInUseException" * "imagebuilder.Client.exceptions.ResourceAlreadyExistsException" * "imagebuilder.Client.exceptions.ServiceQuotaExceededException" imagebuilder / Client / list_image_build_versions list_image_build_versions ************************* imagebuilder.Client.list_image_build_versions(**kwargs) Returns a list of image build versions. See also: AWS API Documentation **Request Syntax** response = client.list_image_build_versions( imageVersionArn='string', filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], maxResults=123, nextToken='string' ) Parameters: * **imageVersionArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve. * **filters** (*list*) -- Use the following filters to streamline results: * "name" * "osVersion" * "platform" * "type" * "version" * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imageSummaryList': [ { 'arn': 'string', 'name': 'string', 'type': 'AMI'|'DOCKER', 'version': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'osVersion': 'string', 'state': { 'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED', 'reason': 'string' }, 'owner': 'string', 'dateCreated': 'string', 'outputResources': { 'amis': [ { 'region': 'string', 'image': 'string', 'name': 'string', 'description': 'string', 'state': { 'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED', 'reason': 'string' }, 'accountId': 'string' }, ], 'containers': [ { 'region': 'string', 'imageUris': [ 'string', ] }, ] }, 'tags': { 'string': 'string' }, 'buildType': 'USER_INITIATED'|'SCHEDULED'|'IMPORT'|'IMPORT_ISO', 'imageSource': 'AMAZON_MANAGED'|'AWS_MARKETPLACE'|'IMPORTED'|'CUSTOM', 'deprecationTime': datetime(2015, 1, 1), 'lifecycleExecutionId': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imageSummaryList** *(list) --* The list of image build versions. * *(dict) --* An image summary. * **arn** *(string) --* The Amazon Resource Name (ARN) of the image. * **name** *(string) --* The name of the image. * **type** *(string) --* Specifies whether this image produces an AMI or a container image. * **version** *(string) --* The version of the image. * **platform** *(string) --* The image operating system platform, such as Linux or Windows. * **osVersion** *(string) --* The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019. * **state** *(dict) --* The state of the image. * **status** *(string) --* The status of the image. * **reason** *(string) --* The reason for the status of the image. * **owner** *(string) --* The owner of the image. * **dateCreated** *(string) --* The date on which Image Builder created this image. * **outputResources** *(dict) --* The output resources that Image Builder produced when it created this image. * **amis** *(list) --* The Amazon EC2 AMIs created by this image. * *(dict) --* Details of an Amazon EC2 AMI. * **region** *(string) --* The Amazon Web Services Region of the Amazon EC2 AMI. * **image** *(string) --* The AMI ID of the Amazon EC2 AMI. * **name** *(string) --* The name of the Amazon EC2 AMI. * **description** *(string) --* The description of the Amazon EC2 AMI. Minimum and maximum length are in characters. * **state** *(dict) --* Image status and the reason for that status. * **status** *(string) --* The status of the image. * **reason** *(string) --* The reason for the status of the image. * **accountId** *(string) --* The account ID of the owner of the AMI. * **containers** *(list) --* Container images that the pipeline has generated and stored in the output repository. * *(dict) --* A container encapsulates the runtime environment for an application. * **region** *(string) --* Containers and container images are Region- specific. This is the Region context for the container. * **imageUris** *(list) --* A list of URIs for containers created in the context Region. * *(string) --* * **tags** *(dict) --* The tags that apply to this image. * *(string) --* * *(string) --* * **buildType** *(string) --* 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. * **IMPORT_ISO** – An ISO disk import created the image. * **imageSource** *(string) --* The origin of the base image that Image Builder used to build this image. * **deprecationTime** *(datetime) --* The time when deprecation occurs for an image resource. This can be a past or future date. * **lifecycleExecutionId** *(string) --* Identifies the last runtime instance of the lifecycle policy to take action on the image. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / list_image_scan_finding_aggregations list_image_scan_finding_aggregations ************************************ imagebuilder.Client.list_image_scan_finding_aggregations(**kwargs) 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" See also: AWS API Documentation **Request Syntax** response = client.list_image_scan_finding_aggregations( filter={ 'name': 'string', 'values': [ 'string', ] }, nextToken='string' ) Parameters: * **filter** (*dict*) -- 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. * **name** *(string) --* The name of the filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'aggregationType': 'string', 'responses': [ { 'accountAggregation': { 'accountId': 'string', 'severityCounts': { 'all': 123, 'critical': 123, 'high': 123, 'medium': 123 } }, 'imageAggregation': { 'imageBuildVersionArn': 'string', 'severityCounts': { 'all': 123, 'critical': 123, 'high': 123, 'medium': 123 } }, 'imagePipelineAggregation': { 'imagePipelineArn': 'string', 'severityCounts': { 'all': 123, 'critical': 123, 'high': 123, 'medium': 123 } }, 'vulnerabilityIdAggregation': { 'vulnerabilityId': 'string', 'severityCounts': { 'all': 123, 'critical': 123, 'high': 123, 'medium': 123 } } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **aggregationType** *(string) --* 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. * **responses** *(list) --* An array of image scan finding aggregations that match the filter criteria. * *(dict) --* This returns exactly one type of aggregation, based on the filter that Image Builder applies in its API action. * **accountAggregation** *(dict) --* Returns an object that contains severity counts based on an account ID. * **accountId** *(string) --* Identifies the account that owns the aggregated resource findings. * **severityCounts** *(dict) --* Counts by severity level for medium severity and higher level findings, plus a total for all of the findings. * **all** *(integer) --* The total number of findings across all severity levels for the specified filter. * **critical** *(integer) --* The number of critical severity findings for the specified filter. * **high** *(integer) --* The number of high severity findings for the specified filter. * **medium** *(integer) --* The number of medium severity findings for the specified filter. * **imageAggregation** *(dict) --* Returns an object that contains severity counts based on the Amazon Resource Name (ARN) for a specific image. * **imageBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) that identifies the image for this aggregation. * **severityCounts** *(dict) --* Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image. * **all** *(integer) --* The total number of findings across all severity levels for the specified filter. * **critical** *(integer) --* The number of critical severity findings for the specified filter. * **high** *(integer) --* The number of high severity findings for the specified filter. * **medium** *(integer) --* The number of medium severity findings for the specified filter. * **imagePipelineAggregation** *(dict) --* Returns an object that contains severity counts based on an image pipeline ARN. * **imagePipelineArn** *(string) --* The Amazon Resource Name (ARN) that identifies the image pipeline for this aggregation. * **severityCounts** *(dict) --* Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image pipeline. * **all** *(integer) --* The total number of findings across all severity levels for the specified filter. * **critical** *(integer) --* The number of critical severity findings for the specified filter. * **high** *(integer) --* The number of high severity findings for the specified filter. * **medium** *(integer) --* The number of medium severity findings for the specified filter. * **vulnerabilityIdAggregation** *(dict) --* Returns an object that contains severity counts based on vulnerability ID. * **vulnerabilityId** *(string) --* The vulnerability Id for this set of counts. * **severityCounts** *(dict) --* Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified vulnerability. * **all** *(integer) --* The total number of findings across all severity levels for the specified filter. * **critical** *(integer) --* The number of critical severity findings for the specified filter. * **high** *(integer) --* The number of high severity findings for the specified filter. * **medium** *(integer) --* The number of medium severity findings for the specified filter. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / list_lifecycle_executions list_lifecycle_executions ************************* imagebuilder.Client.list_lifecycle_executions(**kwargs) Get the lifecycle runtime history for the specified resource. See also: AWS API Documentation **Request Syntax** response = client.list_lifecycle_executions( maxResults=123, nextToken='string', resourceArn='string' ) Parameters: * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource for which to get a list of lifecycle runtime instances. Return type: dict Returns: **Response Syntax** { 'lifecycleExecutions': [ { 'lifecycleExecutionId': 'string', 'lifecyclePolicyArn': 'string', 'resourcesImpactedSummary': { 'hasImpactedResources': True|False }, 'state': { 'status': 'IN_PROGRESS'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'PENDING', 'reason': 'string' }, 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **lifecycleExecutions** *(list) --* A list of lifecycle runtime instances for the specified resource. * *(dict) --* Contains metadata from a runtime instance of a lifecycle policy. * **lifecycleExecutionId** *(string) --* Identifies the lifecycle policy runtime instance. * **lifecyclePolicyArn** *(string) --* The Amazon Resource Name (ARN) of the lifecycle policy that ran. * **resourcesImpactedSummary** *(dict) --* Contains information about associated resources that are identified for action by the runtime instance of the lifecycle policy. * **hasImpactedResources** *(boolean) --* Indicates whether an image resource that was identified for a lifecycle action has associated resources that are also impacted. * **state** *(dict) --* Runtime state that reports if the policy action ran successfully, failed, or was skipped. * **status** *(string) --* The runtime status of the lifecycle execution. * **reason** *(string) --* The reason for the current status. * **startTime** *(datetime) --* The timestamp when the lifecycle runtime instance started. * **endTime** *(datetime) --* The timestamp when the lifecycle runtime instance completed. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / list_workflows list_workflows ************** imagebuilder.Client.list_workflows(**kwargs) Lists workflow build versions based on filtering parameters. See also: AWS API Documentation **Request Syntax** response = client.list_workflows( owner='Self'|'Shared'|'Amazon'|'ThirdParty'|'AWSMarketplace', filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], byName=True|False, maxResults=123, nextToken='string' ) Parameters: * **owner** (*string*) -- Used to get a list of workflow build version filtered by the identity of the creator. * **filters** (*list*) -- Used to streamline search results. * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **byName** (*boolean*) -- Specify all or part of the workflow name to streamline results. * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'workflowVersionList': [ { 'arn': 'string', 'name': 'string', 'version': 'string', 'description': 'string', 'type': 'BUILD'|'TEST'|'DISTRIBUTION', 'owner': 'string', 'dateCreated': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **workflowVersionList** *(list) --* A list of workflow build versions that match the request criteria. * *(dict) --* Contains details about this version of the workflow. * **arn** *(string) --* The Amazon Resource Name (ARN) of the workflow resource. * **name** *(string) --* The name of the workflow. * **version** *(string) --* The semantic version of the workflow resource. The format includes three nodes: ... * **description** *(string) --* Describes the workflow. * **type** *(string) --* The image creation stage that this workflow applies to. Image Builder currently supports build and test stage workflows. * **owner** *(string) --* The owner of the workflow resource. * **dateCreated** *(string) --* The timestamp when Image Builder created the workflow version. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / create_image_pipeline create_image_pipeline ********************* imagebuilder.Client.create_image_pipeline(**kwargs) Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images. See also: AWS API Documentation **Request Syntax** response = client.create_image_pipeline( name='string', description='string', imageRecipeArn='string', containerRecipeArn='string', infrastructureConfigurationArn='string', distributionConfigurationArn='string', imageTestsConfiguration={ 'imageTestsEnabled': True|False, 'timeoutMinutes': 123 }, enhancedImageMetadataEnabled=True|False, schedule={ 'scheduleExpression': 'string', 'timezone': 'string', 'pipelineExecutionStartCondition': 'EXPRESSION_MATCH_ONLY'|'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE' }, status='DISABLED'|'ENABLED', tags={ 'string': 'string' }, clientToken='string', imageScanningConfiguration={ 'imageScanningEnabled': True|False, 'ecrConfiguration': { 'repositoryName': 'string', 'containerTags': [ 'string', ] } }, workflows=[ { 'workflowArn': 'string', 'parameters': [ { 'name': 'string', 'value': [ 'string', ] }, ], 'parallelGroup': 'string', 'onFailure': 'CONTINUE'|'ABORT' }, ], executionRole='string' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the image pipeline. * **description** (*string*) -- The description of the image pipeline. * **imageRecipeArn** (*string*) -- The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline. * **containerRecipeArn** (*string*) -- The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline. * **infrastructureConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline. * **distributionConfigurationArn** (*string*) -- The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline. * **imageTestsConfiguration** (*dict*) -- The image test configuration of the image pipeline. * **imageTestsEnabled** *(boolean) --* Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution. * **timeoutMinutes** *(integer) --* The maximum time in minutes that tests are permitted to run. Note: The timeout property is not currently active. This value is ignored. * **enhancedImageMetadataEnabled** (*boolean*) -- 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. * **schedule** (*dict*) -- The schedule of the image pipeline. * **scheduleExpression** *(string) --* The cron expression determines how often EC2 Image Builder evaluates your "pipelineExecutionStartCondition". For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder. * **timezone** *(string) --* The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC. * **pipelineExecutionStartCondition** *(string) --* The start condition configures when the pipeline should trigger a new image build, as follows. If no value is set Image Builder defaults to "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE". * "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" (default) – When you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder builds a new image only when there are new versions of the base image or components in your recipe that match the filter. Note: For semantic version syntax, see CreateComponent. * "EXPRESSION_MATCH_ONLY" – This condition builds a new image every time the CRON expression matches the current time. * **status** (*string*) -- The status of the image pipeline. * **tags** (*dict*) -- The tags of the image pipeline. * *(string) --* * *(string) --* * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. * **imageScanningConfiguration** (*dict*) -- Contains settings for vulnerability scans. * **imageScanningEnabled** *(boolean) --* A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image. * **ecrConfiguration** *(dict) --* Contains Amazon ECR settings for vulnerability scans. * **repositoryName** *(string) --* 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. * **containerTags** *(list) --* Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can help you identify and manage your scanned images. * *(string) --* * **workflows** (*list*) -- Contains an array of workflow configuration objects. * *(dict) --* Contains control settings and configurable inputs for a workflow resource. * **workflowArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the workflow resource. * **parameters** *(list) --* Contains parameter values for each of the parameters that the workflow document defined for the workflow resource. * *(dict) --* Contains a key/value pair that sets the named workflow parameter. * **name** *(string) --* **[REQUIRED]** The name of the workflow parameter to set. * **value** *(list) --* **[REQUIRED]** Sets the value for the named workflow parameter. * *(string) --* * **parallelGroup** *(string) --* Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows. * **onFailure** *(string) --* The action to take if the workflow fails. * **executionRole** (*string*) -- The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'clientToken': 'string', 'imagePipelineArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **clientToken** *(string) --* The client token that uniquely identifies the request. * **imagePipelineArn** *(string) --* The Amazon Resource Name (ARN) of the image pipeline that was created by this request. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceInUseException" * "imagebuilder.Client.exceptions.ResourceAlreadyExistsException" * "imagebuilder.Client.exceptions.ServiceQuotaExceededException" imagebuilder / Client / import_component import_component **************** imagebuilder.Client.import_component(**kwargs) Imports a component and transforms its data into a component document. See also: AWS API Documentation **Request Syntax** response = client.import_component( name='string', semanticVersion='string', description='string', changeDescription='string', type='BUILD'|'TEST', format='SHELL', platform='Windows'|'Linux'|'macOS', data='string', uri='string', kmsKeyId='string', tags={ 'string': 'string' }, clientToken='string' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the component. * **semanticVersion** (*string*) -- **[REQUIRED]** The semantic version of the component. This version follows the semantic version syntax. Note: The semantic version has four nodes: ../. 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. * **description** (*string*) -- The description of the component. Describes the contents of the component. * **changeDescription** (*string*) -- 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 the component. * **type** (*string*) -- **[REQUIRED]** The type of the component denotes whether the component is used to build the image, or only to test it. * **format** (*string*) -- **[REQUIRED]** The format of the resource that you want to import as a component. * **platform** (*string*) -- **[REQUIRED]** The platform of the component. * **data** (*string*) -- 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. * **uri** (*string*) -- 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. * **kmsKeyId** (*string*) -- The ID of the KMS key that should be used to encrypt this component. * **tags** (*dict*) -- The tags of the component. * *(string) --* * *(string) --* * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'clientToken': 'string', 'componentBuildVersionArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **clientToken** *(string) --* The client token that uniquely identifies the request. * **componentBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the imported component. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.InvalidVersionNumberException" * "imagebuilder.Client.exceptions.ResourceInUseException" * "imagebuilder.Client.exceptions.InvalidParameterCombinationExcep tion" imagebuilder / Client / start_resource_state_update start_resource_state_update *************************** imagebuilder.Client.start_resource_state_update(**kwargs) Begin asynchronous resource state update for lifecycle changes to the specified image resources. See also: AWS API Documentation **Request Syntax** response = client.start_resource_state_update( resourceArn='string', state={ 'status': 'AVAILABLE'|'DELETED'|'DEPRECATED'|'DISABLED' }, executionRole='string', includeResources={ 'amis': True|False, 'snapshots': True|False, 'containers': True|False }, exclusionRules={ 'amis': { 'isPublic': True|False, 'regions': [ 'string', ], 'sharedAccounts': [ 'string', ], 'lastLaunched': { 'value': 123, 'unit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS' }, 'tagMap': { 'string': 'string' } } }, updateAt=datetime(2015, 1, 1), clientToken='string' ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the Image Builder resource that is updated. The state update might also impact associated resources. * **state** (*dict*) -- **[REQUIRED]** Indicates the lifecycle action to take for this request. * **status** *(string) --* Shows the current lifecycle policy action that was applied to an impacted resource. * **executionRole** (*string*) -- The name or Amazon Resource Name (ARN) of the IAM role that’s used to update image state. * **includeResources** (*dict*) -- A list of image resources to update state for. * **amis** *(boolean) --* Specifies whether the lifecycle action should apply to distributed AMIs * **snapshots** *(boolean) --* Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs. * **containers** *(boolean) --* Specifies whether the lifecycle action should apply to distributed containers. * **exclusionRules** (*dict*) -- Skip action on the image resource and associated resources if specified exclusion rules are met. * **amis** *(dict) --* Defines criteria for AMIs that are excluded from lifecycle actions. * **isPublic** *(boolean) --* Configures whether public AMIs are excluded from the lifecycle action. * **regions** *(list) --* Configures Amazon Web Services Regions that are excluded from the lifecycle action. * *(string) --* * **sharedAccounts** *(list) --* Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action. * *(string) --* * **lastLaunched** *(dict) --* Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions. * **value** *(integer) --* **[REQUIRED]** The integer number of units for the time period. For example "6" (months). * **unit** *(string) --* **[REQUIRED]** Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last instance launched from the AMI. For example: days, weeks, months, or years. * **tagMap** *(dict) --* Lists tags that should be excluded from lifecycle actions for the AMIs that have them. * *(string) --* * *(string) --* * **updateAt** (*datetime*) -- The timestamp that indicates when resources are updated by a lifecycle action. * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'lifecycleExecutionId': 'string', 'resourceArn': 'string' } **Response Structure** * *(dict) --* * **lifecycleExecutionId** *(string) --* Identifies the lifecycle runtime instance that started the resource state update. * **resourceArn** *(string) --* The requested ARN of the Image Builder resource for the asynchronous update. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceInUseException" imagebuilder / Client / list_image_pipelines list_image_pipelines ******************** imagebuilder.Client.list_image_pipelines(**kwargs) Returns a list of image pipelines. See also: AWS API Documentation **Request Syntax** response = client.list_image_pipelines( filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], maxResults=123, nextToken='string' ) Parameters: * **filters** (*list*) -- Use the following filters to streamline results: * "description" * "distributionConfigurationArn" * "imageRecipeArn" * "infrastructureConfigurationArn" * "name" * "status" * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imagePipelineList': [ { 'arn': 'string', 'name': 'string', 'description': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'enhancedImageMetadataEnabled': True|False, 'imageRecipeArn': 'string', 'containerRecipeArn': 'string', 'infrastructureConfigurationArn': 'string', 'distributionConfigurationArn': 'string', 'imageTestsConfiguration': { 'imageTestsEnabled': True|False, 'timeoutMinutes': 123 }, 'schedule': { 'scheduleExpression': 'string', 'timezone': 'string', 'pipelineExecutionStartCondition': 'EXPRESSION_MATCH_ONLY'|'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE' }, 'status': 'DISABLED'|'ENABLED', 'dateCreated': 'string', 'dateUpdated': 'string', 'dateLastRun': 'string', 'dateNextRun': 'string', 'tags': { 'string': 'string' }, 'imageScanningConfiguration': { 'imageScanningEnabled': True|False, 'ecrConfiguration': { 'repositoryName': 'string', 'containerTags': [ 'string', ] } }, 'executionRole': 'string', 'workflows': [ { 'workflowArn': 'string', 'parameters': [ { 'name': 'string', 'value': [ 'string', ] }, ], 'parallelGroup': 'string', 'onFailure': 'CONTINUE'|'ABORT' }, ] }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imagePipelineList** *(list) --* The list of image pipelines. * *(dict) --* Details of an image pipeline. * **arn** *(string) --* The Amazon Resource Name (ARN) of the image pipeline. * **name** *(string) --* The name of the image pipeline. * **description** *(string) --* The description of the image pipeline. * **platform** *(string) --* The platform of the image pipeline. * **enhancedImageMetadataEnabled** *(boolean) --* Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default. * **imageRecipeArn** *(string) --* The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline. * **containerRecipeArn** *(string) --* The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline. * **infrastructureConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline. * **distributionConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline. * **imageTestsConfiguration** *(dict) --* The image tests configuration of the image pipeline. * **imageTestsEnabled** *(boolean) --* Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution. * **timeoutMinutes** *(integer) --* The maximum time in minutes that tests are permitted to run. Note: The timeout property is not currently active. This value is ignored. * **schedule** *(dict) --* The schedule of the image pipeline. * **scheduleExpression** *(string) --* The cron expression determines how often EC2 Image Builder evaluates your "pipelineExecutionStartCondition". For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder. * **timezone** *(string) --* The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC. * **pipelineExecutionStartCondition** *(string) --* The start condition configures when the pipeline should trigger a new image build, as follows. If no value is set Image Builder defaults to "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE". * "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" (default) – When you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder builds a new image only when there are new versions of the base image or components in your recipe that match the filter. Note: For semantic version syntax, see CreateComponent. * "EXPRESSION_MATCH_ONLY" – This condition builds a new image every time the CRON expression matches the current time. * **status** *(string) --* The status of the image pipeline. * **dateCreated** *(string) --* The date on which this image pipeline was created. * **dateUpdated** *(string) --* The date on which this image pipeline was last updated. * **dateLastRun** *(string) --* This is no longer supported, and does not return a value. * **dateNextRun** *(string) --* The next date when the pipeline is scheduled to run. * **tags** *(dict) --* The tags of this image pipeline. * *(string) --* * *(string) --* * **imageScanningConfiguration** *(dict) --* Contains settings for vulnerability scans. * **imageScanningEnabled** *(boolean) --* A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image. * **ecrConfiguration** *(dict) --* Contains Amazon ECR settings for vulnerability scans. * **repositoryName** *(string) --* 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. * **containerTags** *(list) --* Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can help you identify and manage your scanned images. * *(string) --* * **executionRole** *(string) --* The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions. * **workflows** *(list) --* Contains the workflows that run for the image pipeline. * *(dict) --* Contains control settings and configurable inputs for a workflow resource. * **workflowArn** *(string) --* The Amazon Resource Name (ARN) of the workflow resource. * **parameters** *(list) --* Contains parameter values for each of the parameters that the workflow document defined for the workflow resource. * *(dict) --* Contains a key/value pair that sets the named workflow parameter. * **name** *(string) --* The name of the workflow parameter to set. * **value** *(list) --* Sets the value for the named workflow parameter. * *(string) --* * **parallelGroup** *(string) --* Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows. * **onFailure** *(string) --* The action to take if the workflow fails. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / get_container_recipe_policy get_container_recipe_policy *************************** imagebuilder.Client.get_container_recipe_policy(**kwargs) Retrieves the policy for a container recipe. See also: AWS API Documentation **Request Syntax** response = client.get_container_recipe_policy( containerRecipeArn='string' ) Parameters: **containerRecipeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the container recipe for the policy being requested. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'policy': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **policy** *(string) --* The container recipe policy object that is returned. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / delete_image_pipeline delete_image_pipeline ********************* imagebuilder.Client.delete_image_pipeline(**kwargs) Deletes an image pipeline. See also: AWS API Documentation **Request Syntax** response = client.delete_image_pipeline( imagePipelineArn='string' ) Parameters: **imagePipelineArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image pipeline to delete. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imagePipelineArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imagePipelineArn** *(string) --* The Amazon Resource Name (ARN) of the image pipeline that was deleted. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceDependencyException" imagebuilder / Client / get_container_recipe get_container_recipe ******************** imagebuilder.Client.get_container_recipe(**kwargs) Retrieves a container recipe. See also: AWS API Documentation **Request Syntax** response = client.get_container_recipe( containerRecipeArn='string' ) Parameters: **containerRecipeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the container recipe to retrieve. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'containerRecipe': { 'arn': 'string', 'containerType': 'DOCKER', 'name': 'string', 'description': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'owner': 'string', 'version': 'string', 'components': [ { 'componentArn': 'string', 'parameters': [ { 'name': 'string', 'value': [ 'string', ] }, ] }, ], 'instanceConfiguration': { 'image': 'string', 'blockDeviceMappings': [ { 'deviceName': 'string', 'ebs': { 'encrypted': True|False, 'deleteOnTermination': True|False, 'iops': 123, 'kmsKeyId': 'string', 'snapshotId': 'string', 'volumeSize': 123, 'volumeType': 'standard'|'io1'|'io2'|'gp2'|'gp3'|'sc1'|'st1', 'throughput': 123 }, 'virtualName': 'string', 'noDevice': 'string' }, ] }, 'dockerfileTemplateData': 'string', 'kmsKeyId': 'string', 'encrypted': True|False, 'parentImage': 'string', 'dateCreated': 'string', 'tags': { 'string': 'string' }, 'workingDirectory': 'string', 'targetRepository': { 'service': 'ECR', 'repositoryName': 'string' } } } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **containerRecipe** *(dict) --* The container recipe object that is returned. * **arn** *(string) --* The Amazon Resource Name (ARN) of the container recipe. Note: 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: .. * Build version ARNs have all four nodes, and point to a specific build for a specific version of an object. * **containerType** *(string) --* Specifies the type of container, such as Docker. * **name** *(string) --* The name of the container recipe. * **description** *(string) --* The description of the container recipe. * **platform** *(string) --* The system platform for the container, such as Windows or Linux. * **owner** *(string) --* The owner of the container recipe. * **version** *(string) --* The semantic version of the container recipe. Note: The semantic version has four nodes: ../. You can assign values for the first three, and can filter on all of them.**Assignment:** For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.**Patterns:** You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.**Filtering:** With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards. * **components** *(list) --* 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. * *(dict) --* Configuration details of the component. * **componentArn** *(string) --* The Amazon Resource Name (ARN) of the component. * **parameters** *(list) --* A group of parameter settings that Image Builder uses to configure the component for a specific recipe. * *(dict) --* Contains a key/value pair that sets the named component parameter. * **name** *(string) --* The name of the component parameter to set. * **value** *(list) --* Sets the value for the named component parameter. * *(string) --* * **instanceConfiguration** *(dict) --* A group of options that can be used to configure an instance for building and testing container images. * **image** *(string) --* The base image for a container build and test instance. This can contain an AMI ID or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by "ssm:", followed by the parameter name or ARN. If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image. * **blockDeviceMappings** *(list) --* Defines the block devices to attach for building an instance from this Image Builder AMI. * *(dict) --* Defines block device mappings for the instance used to configure your image. * **deviceName** *(string) --* The device to which these mappings apply. * **ebs** *(dict) --* Use to manage Amazon EBS-specific configuration for this mapping. * **encrypted** *(boolean) --* Use to configure device encryption. * **deleteOnTermination** *(boolean) --* Use to configure delete on termination of the associated device. * **iops** *(integer) --* Use to configure device IOPS. * **kmsKeyId** *(string) --* Use to configure the KMS key to use when encrypting the device. * **snapshotId** *(string) --* The snapshot that defines the device contents. * **volumeSize** *(integer) --* Use to override the device's volume size. * **volumeType** *(string) --* Use to override the device's volume type. * **throughput** *(integer) --* **For GP3 volumes only** – The throughput in MiB/s that the volume supports. * **virtualName** *(string) --* Use to manage instance ephemeral devices. * **noDevice** *(string) --* Use to remove a mapping from the base image. * **dockerfileTemplateData** *(string) --* Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe. * **kmsKeyId** *(string) --* Identifies which KMS key is used to encrypt the container image for distribution to the target Region. * **encrypted** *(boolean) --* A flag that indicates if the target container is encrypted. * **parentImage** *(string) --* The base image for customizations specified in the container recipe. This can contain an Image Builder image resource ARN or a container image URI, for example "amazonlinux:latest". * **dateCreated** *(string) --* The date when this container recipe was created. * **tags** *(dict) --* Tags that are attached to the container recipe. * *(string) --* * *(string) --* * **workingDirectory** *(string) --* The working directory for use during build and test workflows. * **targetRepository** *(dict) --* The destination repository for the container image. * **service** *(string) --* Specifies the service in which this image was registered. * **repositoryName** *(string) --* The name of the container repository where the output container image is stored. This name is prefixed by the repository location. For example, "/repository_name". **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / get_image_recipe_policy get_image_recipe_policy *********************** imagebuilder.Client.get_image_recipe_policy(**kwargs) Gets an image recipe policy. See also: AWS API Documentation **Request Syntax** response = client.get_image_recipe_policy( imageRecipeArn='string' ) Parameters: **imageRecipeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'policy': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **policy** *(string) --* The image recipe policy object. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / delete_container_recipe delete_container_recipe *********************** imagebuilder.Client.delete_container_recipe(**kwargs) Deletes a container recipe. See also: AWS API Documentation **Request Syntax** response = client.delete_container_recipe( containerRecipeArn='string' ) Parameters: **containerRecipeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the container recipe to delete. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'containerRecipeArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **containerRecipeArn** *(string) --* The Amazon Resource Name (ARN) of the container recipe that was deleted. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceDependencyException" imagebuilder / Client / import_vm_image import_vm_image *************** imagebuilder.Client.import_vm_image(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.import_vm_image( name='string', semanticVersion='string', description='string', platform='Windows'|'Linux'|'macOS', osVersion='string', vmImportTaskId='string', tags={ 'string': 'string' }, clientToken='string' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the base image that is created by the import process. * **semanticVersion** (*string*) -- **[REQUIRED]** The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax. Note: The semantic version has four nodes: ../. 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. * **description** (*string*) -- The description for the base image that is created by the import process. * **platform** (*string*) -- **[REQUIRED]** The operating system platform for the imported VM. * **osVersion** (*string*) -- The operating system version for the imported VM. * **vmImportTaskId** (*string*) -- **[REQUIRED]** 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. * **tags** (*dict*) -- Tags that are attached to the import resources. * *(string) --* * *(string) --* * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imageArn': 'string', 'clientToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imageArn** *(string) --* 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. * **clientToken** *(string) --* The client token that uniquely identifies the request. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" imagebuilder / Client / tag_resource tag_resource ************ imagebuilder.Client.tag_resource(**kwargs) Adds a tag to a resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want to tag. * **tags** (*dict*) -- **[REQUIRED]** The tags to apply to the resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.InvalidParameterException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" imagebuilder / Client / put_container_recipe_policy put_container_recipe_policy *************************** imagebuilder.Client.put_container_recipe_policy(**kwargs) 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_PromoteResourceShareCreatedFromPolic y.html) in order for the resource to be visible to all principals with whom the resource is shared. See also: AWS API Documentation **Request Syntax** response = client.put_container_recipe_policy( containerRecipeArn='string', policy='string' ) Parameters: * **containerRecipeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the container recipe that this policy should be applied to. * **policy** (*string*) -- **[REQUIRED]** The policy to apply to the container recipe. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'containerRecipeArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **containerRecipeArn** *(string) --* The Amazon Resource Name (ARN) of the container recipe that this policy was applied to. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidParameterValueException" * "imagebuilder.Client.exceptions.ResourceNotFoundException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / get_lifecycle_execution get_lifecycle_execution *********************** imagebuilder.Client.get_lifecycle_execution(**kwargs) Get the runtime information that was logged for a specific runtime instance of the lifecycle policy. See also: AWS API Documentation **Request Syntax** response = client.get_lifecycle_execution( lifecycleExecutionId='string' ) Parameters: **lifecycleExecutionId** (*string*) -- **[REQUIRED]** Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details. Return type: dict Returns: **Response Syntax** { 'lifecycleExecution': { 'lifecycleExecutionId': 'string', 'lifecyclePolicyArn': 'string', 'resourcesImpactedSummary': { 'hasImpactedResources': True|False }, 'state': { 'status': 'IN_PROGRESS'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'PENDING', 'reason': 'string' }, 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **lifecycleExecution** *(dict) --* Runtime details for the specified runtime instance of the lifecycle policy. * **lifecycleExecutionId** *(string) --* Identifies the lifecycle policy runtime instance. * **lifecyclePolicyArn** *(string) --* The Amazon Resource Name (ARN) of the lifecycle policy that ran. * **resourcesImpactedSummary** *(dict) --* Contains information about associated resources that are identified for action by the runtime instance of the lifecycle policy. * **hasImpactedResources** *(boolean) --* Indicates whether an image resource that was identified for a lifecycle action has associated resources that are also impacted. * **state** *(dict) --* Runtime state that reports if the policy action ran successfully, failed, or was skipped. * **status** *(string) --* The runtime status of the lifecycle execution. * **reason** *(string) --* The reason for the current status. * **startTime** *(datetime) --* The timestamp when the lifecycle runtime instance started. * **endTime** *(datetime) --* The timestamp when the lifecycle runtime instance completed. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / create_lifecycle_policy create_lifecycle_policy *********************** imagebuilder.Client.create_lifecycle_policy(**kwargs) Create a lifecycle policy resource. See also: AWS API Documentation **Request Syntax** response = client.create_lifecycle_policy( name='string', description='string', status='DISABLED'|'ENABLED', executionRole='string', resourceType='AMI_IMAGE'|'CONTAINER_IMAGE', policyDetails=[ { 'action': { 'type': 'DELETE'|'DEPRECATE'|'DISABLE', 'includeResources': { 'amis': True|False, 'snapshots': True|False, 'containers': True|False } }, 'filter': { 'type': 'AGE'|'COUNT', 'value': 123, 'unit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS', 'retainAtLeast': 123 }, 'exclusionRules': { 'tagMap': { 'string': 'string' }, 'amis': { 'isPublic': True|False, 'regions': [ 'string', ], 'sharedAccounts': [ 'string', ], 'lastLaunched': { 'value': 123, 'unit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS' }, 'tagMap': { 'string': 'string' } } } }, ], resourceSelection={ 'recipes': [ { 'name': 'string', 'semanticVersion': 'string' }, ], 'tagMap': { 'string': 'string' } }, tags={ 'string': 'string' }, clientToken='string' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the lifecycle policy to create. * **description** (*string*) -- Optional description for the lifecycle policy. * **status** (*string*) -- Indicates whether the lifecycle policy resource is enabled. * **executionRole** (*string*) -- **[REQUIRED]** The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions. * **resourceType** (*string*) -- **[REQUIRED]** The type of Image Builder resource that the lifecycle policy applies to. * **policyDetails** (*list*) -- **[REQUIRED]** Configuration details for the lifecycle policy rules. * *(dict) --* The configuration details for a lifecycle policy resource. * **action** *(dict) --* **[REQUIRED]** Configuration details for the policy action. * **type** *(string) --* **[REQUIRED]** Specifies the lifecycle action to take. * **includeResources** *(dict) --* Specifies the resources that the lifecycle policy applies to. * **amis** *(boolean) --* Specifies whether the lifecycle action should apply to distributed AMIs. * **snapshots** *(boolean) --* Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs. * **containers** *(boolean) --* Specifies whether the lifecycle action should apply to distributed containers. * **filter** *(dict) --* **[REQUIRED]** Specifies the resources that the lifecycle policy applies to. * **type** *(string) --* **[REQUIRED]** Filter resources based on either "age" or "count". * **value** *(integer) --* **[REQUIRED]** The number of units for the time period or for the count. For example, a value of "6" might refer to six months or six AMIs. Note: For count-based filters, this value represents the minimum number of resources to keep on hand. If you have fewer resources than this number, the resource is excluded from lifecycle actions. * **unit** *(string) --* Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules. * **retainAtLeast** *(integer) --* For age-based filters, this is the number of resources to keep on hand after the lifecycle "DELETE" action is applied. Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted. * **exclusionRules** *(dict) --* Additional rules to specify resources that should be exempt from policy actions. * **tagMap** *(dict) --* Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them. * *(string) --* * *(string) --* * **amis** *(dict) --* Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action. * **isPublic** *(boolean) --* Configures whether public AMIs are excluded from the lifecycle action. * **regions** *(list) --* Configures Amazon Web Services Regions that are excluded from the lifecycle action. * *(string) --* * **sharedAccounts** *(list) --* Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action. * *(string) --* * **lastLaunched** *(dict) --* Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions. * **value** *(integer) --* **[REQUIRED]** The integer number of units for the time period. For example "6" (months). * **unit** *(string) --* **[REQUIRED]** Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last instance launched from the AMI. For example: days, weeks, months, or years. * **tagMap** *(dict) --* Lists tags that should be excluded from lifecycle actions for the AMIs that have them. * *(string) --* * *(string) --* * **resourceSelection** (*dict*) -- **[REQUIRED]** Selection criteria for the resources that the lifecycle policy applies to. * **recipes** *(list) --* A list of recipes that are used as selection criteria for the output images that the lifecycle policy applies to. * *(dict) --* Specifies an Image Builder recipe that the lifecycle policy uses for resource selection. * **name** *(string) --* **[REQUIRED]** The name of an Image Builder recipe that the lifecycle policy uses for resource selection. * **semanticVersion** *(string) --* **[REQUIRED]** The version of the Image Builder recipe specified by the "name" field. * **tagMap** *(dict) --* A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to. * *(string) --* * *(string) --* * **tags** (*dict*) -- Tags to apply to the lifecycle policy resource. * *(string) --* * *(string) --* * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'clientToken': 'string', 'lifecyclePolicyArn': 'string' } **Response Structure** * *(dict) --* * **clientToken** *(string) --* The client token that uniquely identifies the request. * **lifecyclePolicyArn** *(string) --* The Amazon Resource Name (ARN) of the lifecycle policy that the request created. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceInUseException" * "imagebuilder.Client.exceptions.ResourceAlreadyExistsException" * "imagebuilder.Client.exceptions.ServiceQuotaExceededException" imagebuilder / Client / list_infrastructure_configurations list_infrastructure_configurations ********************************** imagebuilder.Client.list_infrastructure_configurations(**kwargs) Returns a list of infrastructure configurations. See also: AWS API Documentation **Request Syntax** response = client.list_infrastructure_configurations( filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], maxResults=123, nextToken='string' ) Parameters: * **filters** (*list*) -- You can filter on "name" to streamline results. * *(dict) --* 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. * **name** *(string) --* The name of the filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. * *(string) --* * **maxResults** (*integer*) -- The maximum items to return in a request. * **nextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'infrastructureConfigurationSummaryList': [ { 'arn': 'string', 'name': 'string', 'description': 'string', 'dateCreated': 'string', 'dateUpdated': 'string', 'resourceTags': { 'string': 'string' }, 'tags': { 'string': 'string' }, 'instanceTypes': [ 'string', ], 'instanceProfileName': 'string', 'placement': { 'availabilityZone': 'string', 'tenancy': 'default'|'dedicated'|'host', 'hostId': 'string', 'hostResourceGroupArn': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **infrastructureConfigurationSummaryList** *(list) --* The list of infrastructure configurations. * *(dict) --* The infrastructure used when building Amazon EC2 AMIs. * **arn** *(string) --* The Amazon Resource Name (ARN) of the infrastructure configuration. * **name** *(string) --* The name of the infrastructure configuration. * **description** *(string) --* The description of the infrastructure configuration. * **dateCreated** *(string) --* The date on which the infrastructure configuration was created. * **dateUpdated** *(string) --* The date on which the infrastructure configuration was last updated. * **resourceTags** *(dict) --* The tags attached to the image created by Image Builder. * *(string) --* * *(string) --* * **tags** *(dict) --* The tags of the infrastructure configuration. * *(string) --* * *(string) --* * **instanceTypes** *(list) --* The instance types of the infrastructure configuration. * *(string) --* * **instanceProfileName** *(string) --* The instance profile of the infrastructure configuration. * **placement** *(dict) --* The instance placement settings that define where the instances that are launched from your image will run. * **availabilityZone** *(string) --* The Availability Zone where your build and test instances will launch. * **tenancy** *(string) --* The tenancy of the instance. An instance with a tenancy of "dedicated" runs on single-tenant hardware. An instance with a tenancy of "host" runs on a Dedicated Host. If tenancy is set to "host", then you can optionally specify one target for placement – either host ID or host resource group ARN. If automatic placement is enabled for your host, and you don't specify any placement target, Amazon EC2 will try to find an available host for your build and test instances. * **hostId** *(string) --* The ID of the Dedicated Host on which build and test instances run. This only applies if "tenancy" is "host". If you specify the host ID, you must not specify the resource group ARN. If you specify both, Image Builder returns an error. * **hostResourceGroupArn** *(string) --* The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances. This only applies if "tenancy" is "host". If you specify the resource group ARN, you must not specify the host ID. If you specify both, Image Builder returns an error. * **nextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.InvalidPaginationTokenException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / get_image_recipe get_image_recipe **************** imagebuilder.Client.get_image_recipe(**kwargs) Gets an image recipe. See also: AWS API Documentation **Request Syntax** response = client.get_image_recipe( imageRecipeArn='string' ) Parameters: **imageRecipeArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the image recipe that you want to retrieve. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'imageRecipe': { 'arn': 'string', 'type': 'AMI'|'DOCKER', 'name': 'string', 'description': 'string', 'platform': 'Windows'|'Linux'|'macOS', 'owner': 'string', 'version': 'string', 'components': [ { 'componentArn': 'string', 'parameters': [ { 'name': 'string', 'value': [ 'string', ] }, ] }, ], 'parentImage': 'string', 'blockDeviceMappings': [ { 'deviceName': 'string', 'ebs': { 'encrypted': True|False, 'deleteOnTermination': True|False, 'iops': 123, 'kmsKeyId': 'string', 'snapshotId': 'string', 'volumeSize': 123, 'volumeType': 'standard'|'io1'|'io2'|'gp2'|'gp3'|'sc1'|'st1', 'throughput': 123 }, 'virtualName': 'string', 'noDevice': 'string' }, ], 'dateCreated': 'string', 'tags': { 'string': 'string' }, 'workingDirectory': 'string', 'additionalInstanceConfiguration': { 'systemsManagerAgent': { 'uninstallAfterBuild': True|False }, 'userDataOverride': 'string' } } } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **imageRecipe** *(dict) --* The image recipe object. * **arn** *(string) --* The Amazon Resource Name (ARN) of the image recipe. * **type** *(string) --* Specifies which type of image is created by the recipe - an AMI or a container image. * **name** *(string) --* The name of the image recipe. * **description** *(string) --* The description of the image recipe. * **platform** *(string) --* The platform of the image recipe. * **owner** *(string) --* The owner of the image recipe. * **version** *(string) --* The version of the image recipe. * **components** *(list) --* 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. * *(dict) --* Configuration details of the component. * **componentArn** *(string) --* The Amazon Resource Name (ARN) of the component. * **parameters** *(list) --* A group of parameter settings that Image Builder uses to configure the component for a specific recipe. * *(dict) --* Contains a key/value pair that sets the named component parameter. * **name** *(string) --* The name of the component parameter to set. * **value** *(list) --* Sets the value for the named component parameter. * *(string) --* * **parentImage** *(string) --* The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options: * AMI ID * Image Builder image Amazon Resource Name (ARN) * Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by "ssm:", followed by the parameter name or ARN. * Amazon Web Services Marketplace product ID * **blockDeviceMappings** *(list) --* The block device mappings to apply when creating images from this recipe. * *(dict) --* Defines block device mappings for the instance used to configure your image. * **deviceName** *(string) --* The device to which these mappings apply. * **ebs** *(dict) --* Use to manage Amazon EBS-specific configuration for this mapping. * **encrypted** *(boolean) --* Use to configure device encryption. * **deleteOnTermination** *(boolean) --* Use to configure delete on termination of the associated device. * **iops** *(integer) --* Use to configure device IOPS. * **kmsKeyId** *(string) --* Use to configure the KMS key to use when encrypting the device. * **snapshotId** *(string) --* The snapshot that defines the device contents. * **volumeSize** *(integer) --* Use to override the device's volume size. * **volumeType** *(string) --* Use to override the device's volume type. * **throughput** *(integer) --* **For GP3 volumes only** – The throughput in MiB/s that the volume supports. * **virtualName** *(string) --* Use to manage instance ephemeral devices. * **noDevice** *(string) --* Use to remove a mapping from the base image. * **dateCreated** *(string) --* The date on which this image recipe was created. * **tags** *(dict) --* The tags of the image recipe. * *(string) --* * *(string) --* * **workingDirectory** *(string) --* The working directory to be used during build and test workflows. * **additionalInstanceConfiguration** *(dict) --* 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. * **systemsManagerAgent** *(dict) --* Contains settings for the Systems Manager agent on your build instance. * **uninstallAfterBuild** *(boolean) --* 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. * **userDataOverride** *(string) --* 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. Note: The user data is always base 64 encoded. For example, the following commands are encoded as "IyEvYmluL2Jhc2 gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$":*#!/bin/ba sh*mkdir -p /var/bb/touch /var **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / update_lifecycle_policy update_lifecycle_policy *********************** imagebuilder.Client.update_lifecycle_policy(**kwargs) Update the specified lifecycle policy. See also: AWS API Documentation **Request Syntax** response = client.update_lifecycle_policy( lifecyclePolicyArn='string', description='string', status='DISABLED'|'ENABLED', executionRole='string', resourceType='AMI_IMAGE'|'CONTAINER_IMAGE', policyDetails=[ { 'action': { 'type': 'DELETE'|'DEPRECATE'|'DISABLE', 'includeResources': { 'amis': True|False, 'snapshots': True|False, 'containers': True|False } }, 'filter': { 'type': 'AGE'|'COUNT', 'value': 123, 'unit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS', 'retainAtLeast': 123 }, 'exclusionRules': { 'tagMap': { 'string': 'string' }, 'amis': { 'isPublic': True|False, 'regions': [ 'string', ], 'sharedAccounts': [ 'string', ], 'lastLaunched': { 'value': 123, 'unit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS' }, 'tagMap': { 'string': 'string' } } } }, ], resourceSelection={ 'recipes': [ { 'name': 'string', 'semanticVersion': 'string' }, ], 'tagMap': { 'string': 'string' } }, clientToken='string' ) Parameters: * **lifecyclePolicyArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the lifecycle policy resource. * **description** (*string*) -- Optional description for the lifecycle policy. * **status** (*string*) -- Indicates whether the lifecycle policy resource is enabled. * **executionRole** (*string*) -- **[REQUIRED]** The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to update the lifecycle policy. * **resourceType** (*string*) -- **[REQUIRED]** The type of image resource that the lifecycle policy applies to. * **policyDetails** (*list*) -- **[REQUIRED]** The configuration details for a lifecycle policy resource. * *(dict) --* The configuration details for a lifecycle policy resource. * **action** *(dict) --* **[REQUIRED]** Configuration details for the policy action. * **type** *(string) --* **[REQUIRED]** Specifies the lifecycle action to take. * **includeResources** *(dict) --* Specifies the resources that the lifecycle policy applies to. * **amis** *(boolean) --* Specifies whether the lifecycle action should apply to distributed AMIs. * **snapshots** *(boolean) --* Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs. * **containers** *(boolean) --* Specifies whether the lifecycle action should apply to distributed containers. * **filter** *(dict) --* **[REQUIRED]** Specifies the resources that the lifecycle policy applies to. * **type** *(string) --* **[REQUIRED]** Filter resources based on either "age" or "count". * **value** *(integer) --* **[REQUIRED]** The number of units for the time period or for the count. For example, a value of "6" might refer to six months or six AMIs. Note: For count-based filters, this value represents the minimum number of resources to keep on hand. If you have fewer resources than this number, the resource is excluded from lifecycle actions. * **unit** *(string) --* Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules. * **retainAtLeast** *(integer) --* For age-based filters, this is the number of resources to keep on hand after the lifecycle "DELETE" action is applied. Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted. * **exclusionRules** *(dict) --* Additional rules to specify resources that should be exempt from policy actions. * **tagMap** *(dict) --* Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them. * *(string) --* * *(string) --* * **amis** *(dict) --* Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action. * **isPublic** *(boolean) --* Configures whether public AMIs are excluded from the lifecycle action. * **regions** *(list) --* Configures Amazon Web Services Regions that are excluded from the lifecycle action. * *(string) --* * **sharedAccounts** *(list) --* Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action. * *(string) --* * **lastLaunched** *(dict) --* Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions. * **value** *(integer) --* **[REQUIRED]** The integer number of units for the time period. For example "6" (months). * **unit** *(string) --* **[REQUIRED]** Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last instance launched from the AMI. For example: days, weeks, months, or years. * **tagMap** *(dict) --* Lists tags that should be excluded from lifecycle actions for the AMIs that have them. * *(string) --* * *(string) --* * **resourceSelection** (*dict*) -- **[REQUIRED]** Selection criteria for resources that the lifecycle policy applies to. * **recipes** *(list) --* A list of recipes that are used as selection criteria for the output images that the lifecycle policy applies to. * *(dict) --* Specifies an Image Builder recipe that the lifecycle policy uses for resource selection. * **name** *(string) --* **[REQUIRED]** The name of an Image Builder recipe that the lifecycle policy uses for resource selection. * **semanticVersion** *(string) --* **[REQUIRED]** The version of the Image Builder recipe specified by the "name" field. * **tagMap** *(dict) --* A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to. * *(string) --* * *(string) --* * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'lifecyclePolicyArn': 'string' } **Response Structure** * *(dict) --* * **lifecyclePolicyArn** *(string) --* The ARN of the image lifecycle policy resource that was updated. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.ResourceInUseException" * "imagebuilder.Client.exceptions.InvalidParameterCombinationExcep tion" imagebuilder / Client / get_marketplace_resource get_marketplace_resource ************************ imagebuilder.Client.get_marketplace_resource(**kwargs) Verify the subscription and perform resource dependency checks on the requested Amazon Web Services Marketplace resource. For Amazon Web Services Marketplace components, the response contains fields to download the components and their artifacts. See also: AWS API Documentation **Request Syntax** response = client.get_marketplace_resource( resourceType='COMPONENT_DATA'|'COMPONENT_ARTIFACT', resourceArn='string', resourceLocation='string' ) Parameters: * **resourceType** (*string*) -- **[REQUIRED]** Specifies which type of Amazon Web Services Marketplace resource Image Builder retrieves. * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies an Amazon Web Services Marketplace resource. * **resourceLocation** (*string*) -- The bucket path that you can specify to download the resource from Amazon S3. Return type: dict Returns: **Response Syntax** { 'resourceArn': 'string', 'url': 'string', 'data': 'string' } **Response Structure** * *(dict) --* * **resourceArn** *(string) --* The Amazon Resource Name (ARN) for the Amazon Web Services Marketplace resource that was requested. * **url** *(string) --* The obfuscated S3 URL to download the component artifact from. * **data** *(string) --* Returns obfuscated data that contains the YAML content of the component. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" imagebuilder / Client / create_image_recipe create_image_recipe ******************* imagebuilder.Client.create_image_recipe(**kwargs) Creates a new image recipe. Image recipes define how images are configured, tested, and assessed. See also: AWS API Documentation **Request Syntax** response = client.create_image_recipe( name='string', description='string', semanticVersion='string', components=[ { 'componentArn': 'string', 'parameters': [ { 'name': 'string', 'value': [ 'string', ] }, ] }, ], parentImage='string', blockDeviceMappings=[ { 'deviceName': 'string', 'ebs': { 'encrypted': True|False, 'deleteOnTermination': True|False, 'iops': 123, 'kmsKeyId': 'string', 'snapshotId': 'string', 'volumeSize': 123, 'volumeType': 'standard'|'io1'|'io2'|'gp2'|'gp3'|'sc1'|'st1', 'throughput': 123 }, 'virtualName': 'string', 'noDevice': 'string' }, ], tags={ 'string': 'string' }, workingDirectory='string', additionalInstanceConfiguration={ 'systemsManagerAgent': { 'uninstallAfterBuild': True|False }, 'userDataOverride': 'string' }, clientToken='string' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the image recipe. * **description** (*string*) -- The description of the image recipe. * **semanticVersion** (*string*) -- **[REQUIRED]** The semantic version of the image recipe. This version follows the semantic version syntax. Note: The semantic version has four nodes: ../. 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. * **components** (*list*) -- **[REQUIRED]** The components included in the image recipe. * *(dict) --* Configuration details of the component. * **componentArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the component. * **parameters** *(list) --* A group of parameter settings that Image Builder uses to configure the component for a specific recipe. * *(dict) --* Contains a key/value pair that sets the named component parameter. * **name** *(string) --* **[REQUIRED]** The name of the component parameter to set. * **value** *(list) --* **[REQUIRED]** Sets the value for the named component parameter. * *(string) --* * **parentImage** (*string*) -- **[REQUIRED]** The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options: * AMI ID * Image Builder image Amazon Resource Name (ARN) * Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by "ssm:", followed by the parameter name or ARN. * Amazon Web Services Marketplace product ID If you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access to the AMI, and the AMI must be in the source Region. * **blockDeviceMappings** (*list*) -- The block device mappings of the image recipe. * *(dict) --* Defines block device mappings for the instance used to configure your image. * **deviceName** *(string) --* The device to which these mappings apply. * **ebs** *(dict) --* Use to manage Amazon EBS-specific configuration for this mapping. * **encrypted** *(boolean) --* Use to configure device encryption. * **deleteOnTermination** *(boolean) --* Use to configure delete on termination of the associated device. * **iops** *(integer) --* Use to configure device IOPS. * **kmsKeyId** *(string) --* Use to configure the KMS key to use when encrypting the device. * **snapshotId** *(string) --* The snapshot that defines the device contents. * **volumeSize** *(integer) --* Use to override the device's volume size. * **volumeType** *(string) --* Use to override the device's volume type. * **throughput** *(integer) --* **For GP3 volumes only** – The throughput in MiB/s that the volume supports. * **virtualName** *(string) --* Use to manage instance ephemeral devices. * **noDevice** *(string) --* Use to remove a mapping from the base image. * **tags** (*dict*) -- The tags of the image recipe. * *(string) --* * *(string) --* * **workingDirectory** (*string*) -- The working directory used during build and test workflows. * **additionalInstanceConfiguration** (*dict*) -- Specify additional settings and launch scripts for your build instances. * **systemsManagerAgent** *(dict) --* Contains settings for the Systems Manager agent on your build instance. * **uninstallAfterBuild** *(boolean) --* 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. * **userDataOverride** *(string) --* 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. Note: The user data is always base 64 encoded. For example, the following commands are encoded as "IyEvYmluL2Jhc2gKbWtkaX IgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$":*#!/bin/bash*mkdir -p /var/bb/touch /var * **clientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'clientToken': 'string', 'imageRecipeArn': 'string' } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **clientToken** *(string) --* The client token that uniquely identifies the request. * **imageRecipeArn** *(string) --* The Amazon Resource Name (ARN) of the image recipe that was created by this request. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.IdempotentParameterMismatchExcep tion" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException" * "imagebuilder.Client.exceptions.InvalidVersionNumberException" * "imagebuilder.Client.exceptions.ResourceInUseException" * "imagebuilder.Client.exceptions.ResourceAlreadyExistsException" * "imagebuilder.Client.exceptions.ServiceQuotaExceededException" imagebuilder / Client / get_workflow_step_execution get_workflow_step_execution *************************** imagebuilder.Client.get_workflow_step_execution(**kwargs) Get the runtime information that was logged for a specific runtime instance of the workflow step. See also: AWS API Documentation **Request Syntax** response = client.get_workflow_step_execution( stepExecutionId='string' ) Parameters: **stepExecutionId** (*string*) -- **[REQUIRED]** Use the unique identifier for a specific runtime instance of the workflow step to get runtime details for that step. Return type: dict Returns: **Response Syntax** { 'requestId': 'string', 'stepExecutionId': 'string', 'workflowBuildVersionArn': 'string', 'workflowExecutionId': 'string', 'imageBuildVersionArn': 'string', 'name': 'string', 'description': 'string', 'action': 'string', 'status': 'PENDING'|'SKIPPED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLED', 'rollbackStatus': 'RUNNING'|'COMPLETED'|'SKIPPED'|'FAILED', 'message': 'string', 'inputs': 'string', 'outputs': 'string', 'startTime': 'string', 'endTime': 'string', 'onFailure': 'string', 'timeoutSeconds': 123 } **Response Structure** * *(dict) --* * **requestId** *(string) --* The request ID that uniquely identifies this request. * **stepExecutionId** *(string) --* The unique identifier for the runtime version of the workflow step that you specified in the request. * **workflowBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step. * **workflowExecutionId** *(string) --* The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow. * **imageBuildVersionArn** *(string) --* The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates. * **name** *(string) --* The name of the specified runtime instance of the workflow step. * **description** *(string) --* Describes the specified workflow step. * **action** *(string) --* The name of the action that the specified step performs. * **status** *(string) --* The current status for the specified runtime version of the workflow step. * **rollbackStatus** *(string) --* Reports on the rollback status of the specified runtime version of the workflow step, if applicable. * **message** *(string) --* The output message from the specified runtime instance of the workflow step, if applicable. * **inputs** *(string) --* Input parameters that Image Builder provided for the specified runtime instance of the workflow step. * **outputs** *(string) --* The file names that the specified runtime version of the workflow step created as output. * **startTime** *(string) --* The timestamp when the specified runtime version of the workflow step started. * **endTime** *(string) --* The timestamp when the specified runtime instance of the workflow step finished. * **onFailure** *(string) --* The action to perform if the workflow step fails. * **timeoutSeconds** *(integer) --* The maximum duration in seconds for this step to complete its action. **Exceptions** * "imagebuilder.Client.exceptions.ServiceException" * "imagebuilder.Client.exceptions.ClientException" * "imagebuilder.Client.exceptions.ServiceUnavailableException" * "imagebuilder.Client.exceptions.InvalidRequestException" * "imagebuilder.Client.exceptions.ForbiddenException" * "imagebuilder.Client.exceptions.CallRateLimitExceededException"