Class: Aws::Imagebuilder::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Imagebuilder::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb
Overview
An API client for Imagebuilder. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Imagebuilder::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#cancel_image_creation(params = {}) ⇒ Types::CancelImageCreationResponse
CancelImageCreation cancels the creation of Image.
-
#cancel_lifecycle_execution(params = {}) ⇒ Types::CancelLifecycleExecutionResponse
Cancel a specific image lifecycle policy runtime instance.
-
#create_component(params = {}) ⇒ Types::CreateComponentResponse
Creates a new component that can be used to build, validate, test, and assess your image.
-
#create_container_recipe(params = {}) ⇒ Types::CreateContainerRecipeResponse
Creates a new container recipe.
-
#create_distribution_configuration(params = {}) ⇒ Types::CreateDistributionConfigurationResponse
Creates a new distribution configuration.
-
#create_image(params = {}) ⇒ Types::CreateImageResponse
Creates a new image.
-
#create_image_pipeline(params = {}) ⇒ Types::CreateImagePipelineResponse
Creates a new image pipeline.
-
#create_image_recipe(params = {}) ⇒ Types::CreateImageRecipeResponse
Creates a new image recipe.
-
#create_infrastructure_configuration(params = {}) ⇒ Types::CreateInfrastructureConfigurationResponse
Creates a new infrastructure configuration.
-
#create_lifecycle_policy(params = {}) ⇒ Types::CreateLifecyclePolicyResponse
Create a lifecycle policy resource.
-
#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse
Create a new workflow or a new version of an existing workflow.
-
#delete_component(params = {}) ⇒ Types::DeleteComponentResponse
Deletes a component build version.
-
#delete_container_recipe(params = {}) ⇒ Types::DeleteContainerRecipeResponse
Deletes a container recipe.
-
#delete_distribution_configuration(params = {}) ⇒ Types::DeleteDistributionConfigurationResponse
Deletes a distribution configuration.
-
#delete_image(params = {}) ⇒ Types::DeleteImageResponse
Deletes an Image Builder image resource.
-
#delete_image_pipeline(params = {}) ⇒ Types::DeleteImagePipelineResponse
Deletes an image pipeline.
-
#delete_image_recipe(params = {}) ⇒ Types::DeleteImageRecipeResponse
Deletes an image recipe.
-
#delete_infrastructure_configuration(params = {}) ⇒ Types::DeleteInfrastructureConfigurationResponse
Deletes an infrastructure configuration.
-
#delete_lifecycle_policy(params = {}) ⇒ Types::DeleteLifecyclePolicyResponse
Delete the specified lifecycle policy resource.
-
#delete_workflow(params = {}) ⇒ Types::DeleteWorkflowResponse
Deletes a specific workflow resource.
-
#get_component(params = {}) ⇒ Types::GetComponentResponse
Gets a component object.
-
#get_component_policy(params = {}) ⇒ Types::GetComponentPolicyResponse
Gets a component policy.
-
#get_container_recipe(params = {}) ⇒ Types::GetContainerRecipeResponse
Retrieves a container recipe.
-
#get_container_recipe_policy(params = {}) ⇒ Types::GetContainerRecipePolicyResponse
Retrieves the policy for a container recipe.
-
#get_distribution_configuration(params = {}) ⇒ Types::GetDistributionConfigurationResponse
Gets a distribution configuration.
-
#get_image(params = {}) ⇒ Types::GetImageResponse
Gets an image.
-
#get_image_pipeline(params = {}) ⇒ Types::GetImagePipelineResponse
Gets an image pipeline.
-
#get_image_policy(params = {}) ⇒ Types::GetImagePolicyResponse
Gets an image policy.
-
#get_image_recipe(params = {}) ⇒ Types::GetImageRecipeResponse
Gets an image recipe.
-
#get_image_recipe_policy(params = {}) ⇒ Types::GetImageRecipePolicyResponse
Gets an image recipe policy.
-
#get_infrastructure_configuration(params = {}) ⇒ Types::GetInfrastructureConfigurationResponse
Gets an infrastructure configuration.
-
#get_lifecycle_execution(params = {}) ⇒ Types::GetLifecycleExecutionResponse
Get the runtime information that was logged for a specific runtime instance of the lifecycle policy.
-
#get_lifecycle_policy(params = {}) ⇒ Types::GetLifecyclePolicyResponse
Get details for the specified image lifecycle policy.
-
#get_marketplace_resource(params = {}) ⇒ Types::GetMarketplaceResourceResponse
Verify the subscription and perform resource dependency checks on the requested Amazon Web Services Marketplace resource.
-
#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse
Get a workflow resource object.
-
#get_workflow_execution(params = {}) ⇒ Types::GetWorkflowExecutionResponse
Get the runtime information that was logged for a specific runtime instance of the workflow.
-
#get_workflow_step_execution(params = {}) ⇒ Types::GetWorkflowStepExecutionResponse
Get the runtime information that was logged for a specific runtime instance of the workflow step.
-
#import_component(params = {}) ⇒ Types::ImportComponentResponse
Imports a component and transforms its data into a component document.
-
#import_disk_image(params = {}) ⇒ Types::ImportDiskImageResponse
Import a Windows operating system image from a verified Microsoft ISO disk file.
-
#import_vm_image(params = {}) ⇒ Types::ImportVmImageResponse
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.
-
#list_component_build_versions(params = {}) ⇒ Types::ListComponentBuildVersionsResponse
Returns the list of component build versions for the specified component version Amazon Resource Name (ARN).
-
#list_components(params = {}) ⇒ Types::ListComponentsResponse
Returns the list of components that can be filtered by name, or by using the listed
filters
to streamline results. -
#list_container_recipes(params = {}) ⇒ Types::ListContainerRecipesResponse
Returns a list of container recipes.
-
#list_distribution_configurations(params = {}) ⇒ Types::ListDistributionConfigurationsResponse
Returns a list of distribution configurations.
-
#list_image_build_versions(params = {}) ⇒ Types::ListImageBuildVersionsResponse
Returns a list of image build versions.
-
#list_image_packages(params = {}) ⇒ Types::ListImagePackagesResponse
List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.
-
#list_image_pipeline_images(params = {}) ⇒ Types::ListImagePipelineImagesResponse
Returns a list of images created by the specified pipeline.
-
#list_image_pipelines(params = {}) ⇒ Types::ListImagePipelinesResponse
Returns a list of image pipelines.
-
#list_image_recipes(params = {}) ⇒ Types::ListImageRecipesResponse
Returns a list of image recipes.
-
#list_image_scan_finding_aggregations(params = {}) ⇒ Types::ListImageScanFindingAggregationsResponse
Returns a list of image scan aggregations for your account.
-
#list_image_scan_findings(params = {}) ⇒ Types::ListImageScanFindingsResponse
Returns a list of image scan findings for your account.
-
#list_images(params = {}) ⇒ Types::ListImagesResponse
Returns the list of images that you have access to.
-
#list_infrastructure_configurations(params = {}) ⇒ Types::ListInfrastructureConfigurationsResponse
Returns a list of infrastructure configurations.
-
#list_lifecycle_execution_resources(params = {}) ⇒ Types::ListLifecycleExecutionResourcesResponse
List resources that the runtime instance of the image lifecycle identified for lifecycle actions.
-
#list_lifecycle_executions(params = {}) ⇒ Types::ListLifecycleExecutionsResponse
Get the lifecycle runtime history for the specified resource.
-
#list_lifecycle_policies(params = {}) ⇒ Types::ListLifecyclePoliciesResponse
Get a list of lifecycle policies in your Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns the list of tags for the specified resource.
-
#list_waiting_workflow_steps(params = {}) ⇒ Types::ListWaitingWorkflowStepsResponse
Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.
-
#list_workflow_build_versions(params = {}) ⇒ Types::ListWorkflowBuildVersionsResponse
Returns a list of build versions for a specific workflow resource.
-
#list_workflow_executions(params = {}) ⇒ Types::ListWorkflowExecutionsResponse
Returns a list of workflow runtime instance metadata objects for a specific image build version.
-
#list_workflow_step_executions(params = {}) ⇒ Types::ListWorkflowStepExecutionsResponse
Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.
-
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Lists workflow build versions based on filtering parameters.
-
#put_component_policy(params = {}) ⇒ Types::PutComponentPolicyResponse
Applies a policy to a component.
-
#put_container_recipe_policy(params = {}) ⇒ Types::PutContainerRecipePolicyResponse
Applies a policy to a container image.
-
#put_image_policy(params = {}) ⇒ Types::PutImagePolicyResponse
Applies a policy to an image.
-
#put_image_recipe_policy(params = {}) ⇒ Types::PutImageRecipePolicyResponse
Applies a policy to an image recipe.
-
#send_workflow_step_action(params = {}) ⇒ Types::SendWorkflowStepActionResponse
Pauses or resumes image creation when the associated workflow runs a
WaitForAction
step. -
#start_image_pipeline_execution(params = {}) ⇒ Types::StartImagePipelineExecutionResponse
Manually triggers a pipeline to create an image.
-
#start_resource_state_update(params = {}) ⇒ Types::StartResourceStateUpdateResponse
Begin asynchronous resource state update for lifecycle changes to the specified image resources.
-
#tag_resource(params = {}) ⇒ Struct
Adds a tag to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource.
-
#update_distribution_configuration(params = {}) ⇒ Types::UpdateDistributionConfigurationResponse
Updates a new distribution configuration.
-
#update_image_pipeline(params = {}) ⇒ Types::UpdateImagePipelineResponse
Updates an image pipeline.
-
#update_infrastructure_configuration(params = {}) ⇒ Types::UpdateInfrastructureConfigurationResponse
Updates a new infrastructure configuration.
-
#update_lifecycle_policy(params = {}) ⇒ Types::UpdateLifecyclePolicyResponse
Update the specified lifecycle policy.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
466 467 468 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 466 def initialize(*args) super end |
Instance Method Details
#cancel_image_creation(params = {}) ⇒ Types::CancelImageCreationResponse
CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
514 515 516 517 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 514 def cancel_image_creation(params = {}, = {}) req = build_request(:cancel_image_creation, params) req.send_request() end |
#cancel_lifecycle_execution(params = {}) ⇒ Types::CancelLifecycleExecutionResponse
Cancel a specific image lifecycle policy runtime instance.
556 557 558 559 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 556 def cancel_lifecycle_execution(params = {}, = {}) req = build_request(:cancel_lifecycle_execution, params) req.send_request() end |
#create_component(params = {}) ⇒ Types::CreateComponentResponse
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.
675 676 677 678 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 675 def create_component(params = {}, = {}) req = build_request(:create_component, params) req.send_request() end |
#create_container_recipe(params = {}) ⇒ Types::CreateContainerRecipeResponse
Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
834 835 836 837 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 834 def create_container_recipe(params = {}, = {}) req = build_request(:create_container_recipe, params) req.send_request() end |
#create_distribution_configuration(params = {}) ⇒ Types::CreateDistributionConfigurationResponse
Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
957 958 959 960 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 957 def create_distribution_configuration(params = {}, = {}) req = build_request(:create_distribution_configuration, params) req.send_request() end |
#create_image(params = {}) ⇒ Types::CreateImageResponse
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.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1073 def create_image(params = {}, = {}) req = build_request(:create_image, params) req.send_request() end |
#create_image_pipeline(params = {}) ⇒ Types::CreateImagePipelineResponse
Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
1207 1208 1209 1210 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1207 def create_image_pipeline(params = {}, = {}) req = build_request(:create_image_pipeline, params) req.send_request() end |
#create_image_recipe(params = {}) ⇒ Types::CreateImageRecipeResponse
Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.
1350 1351 1352 1353 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1350 def create_image_recipe(params = {}, = {}) req = build_request(:create_image_recipe, params) req.send_request() end |
#create_infrastructure_configuration(params = {}) ⇒ Types::CreateInfrastructureConfigurationResponse
Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
1489 1490 1491 1492 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1489 def create_infrastructure_configuration(params = {}, = {}) req = build_request(:create_infrastructure_configuration, params) req.send_request() end |
#create_lifecycle_policy(params = {}) ⇒ Types::CreateLifecyclePolicyResponse
Create a lifecycle policy resource.
1609 1610 1611 1612 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1609 def create_lifecycle_policy(params = {}, = {}) req = build_request(:create_lifecycle_policy, params) req.send_request() end |
#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse
Create a new workflow or a new version of an existing workflow.
1714 1715 1716 1717 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1714 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_component(params = {}) ⇒ Types::DeleteComponentResponse
Deletes a component build version.
1745 1746 1747 1748 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1745 def delete_component(params = {}, = {}) req = build_request(:delete_component, params) req.send_request() end |
#delete_container_recipe(params = {}) ⇒ Types::DeleteContainerRecipeResponse
Deletes a container recipe.
1775 1776 1777 1778 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1775 def delete_container_recipe(params = {}, = {}) req = build_request(:delete_container_recipe, params) req.send_request() end |
#delete_distribution_configuration(params = {}) ⇒ Types::DeleteDistributionConfigurationResponse
Deletes a distribution configuration.
1806 1807 1808 1809 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1806 def delete_distribution_configuration(params = {}, = {}) req = build_request(:delete_distribution_configuration, params) req.send_request() end |
#delete_image(params = {}) ⇒ Types::DeleteImageResponse
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.
1855 1856 1857 1858 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1855 def delete_image(params = {}, = {}) req = build_request(:delete_image, params) req.send_request() end |
#delete_image_pipeline(params = {}) ⇒ Types::DeleteImagePipelineResponse
Deletes an image pipeline.
1885 1886 1887 1888 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1885 def delete_image_pipeline(params = {}, = {}) req = build_request(:delete_image_pipeline, params) req.send_request() end |
#delete_image_recipe(params = {}) ⇒ Types::DeleteImageRecipeResponse
Deletes an image recipe.
1915 1916 1917 1918 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1915 def delete_image_recipe(params = {}, = {}) req = build_request(:delete_image_recipe, params) req.send_request() end |
#delete_infrastructure_configuration(params = {}) ⇒ Types::DeleteInfrastructureConfigurationResponse
Deletes an infrastructure configuration.
1946 1947 1948 1949 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1946 def delete_infrastructure_configuration(params = {}, = {}) req = build_request(:delete_infrastructure_configuration, params) req.send_request() end |
#delete_lifecycle_policy(params = {}) ⇒ Types::DeleteLifecyclePolicyResponse
Delete the specified lifecycle policy resource.
1975 1976 1977 1978 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1975 def delete_lifecycle_policy(params = {}, = {}) req = build_request(:delete_lifecycle_policy, params) req.send_request() end |
#delete_workflow(params = {}) ⇒ Types::DeleteWorkflowResponse
Deletes a specific workflow resource.
2003 2004 2005 2006 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2003 def delete_workflow(params = {}, = {}) req = build_request(:delete_workflow, params) req.send_request() end |
#get_component(params = {}) ⇒ Types::GetComponentResponse
Gets a component object.
2062 2063 2064 2065 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2062 def get_component(params = {}, = {}) req = build_request(:get_component, params) req.send_request() end |
#get_component_policy(params = {}) ⇒ Types::GetComponentPolicyResponse
Gets a component policy.
2093 2094 2095 2096 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2093 def get_component_policy(params = {}, = {}) req = build_request(:get_component_policy, params) req.send_request() end |
#get_container_recipe(params = {}) ⇒ Types::GetContainerRecipeResponse
Retrieves a container recipe.
2158 2159 2160 2161 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2158 def get_container_recipe(params = {}, = {}) req = build_request(:get_container_recipe, params) req.send_request() end |
#get_container_recipe_policy(params = {}) ⇒ Types::GetContainerRecipePolicyResponse
Retrieves the policy for a container recipe.
2189 2190 2191 2192 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2189 def get_container_recipe_policy(params = {}, = {}) req = build_request(:get_container_recipe_policy, params) req.send_request() end |
#get_distribution_configuration(params = {}) ⇒ Types::GetDistributionConfigurationResponse
Gets a distribution configuration.
2271 2272 2273 2274 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2271 def get_distribution_configuration(params = {}, = {}) req = build_request(:get_distribution_configuration, params) req.send_request() end |
#get_image(params = {}) ⇒ Types::GetImageResponse
Gets an image.
2493 2494 2495 2496 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2493 def get_image(params = {}, = {}) req = build_request(:get_image, params) req.send_request() end |
#get_image_pipeline(params = {}) ⇒ Types::GetImagePipelineResponse
Gets an image pipeline.
2557 2558 2559 2560 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2557 def get_image_pipeline(params = {}, = {}) req = build_request(:get_image_pipeline, params) req.send_request() end |
#get_image_policy(params = {}) ⇒ Types::GetImagePolicyResponse
Gets an image policy.
2588 2589 2590 2591 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2588 def get_image_policy(params = {}, = {}) req = build_request(:get_image_policy, params) req.send_request() end |
#get_image_recipe(params = {}) ⇒ Types::GetImageRecipeResponse
Gets an image recipe.
2650 2651 2652 2653 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2650 def get_image_recipe(params = {}, = {}) req = build_request(:get_image_recipe, params) req.send_request() end |
#get_image_recipe_policy(params = {}) ⇒ Types::GetImageRecipePolicyResponse
Gets an image recipe policy.
2681 2682 2683 2684 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2681 def get_image_recipe_policy(params = {}, = {}) req = build_request(:get_image_recipe_policy, params) req.send_request() end |
#get_infrastructure_configuration(params = {}) ⇒ Types::GetInfrastructureConfigurationResponse
Gets an infrastructure configuration.
2737 2738 2739 2740 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2737 def get_infrastructure_configuration(params = {}, = {}) req = build_request(:get_infrastructure_configuration, params) req.send_request() end |
#get_lifecycle_execution(params = {}) ⇒ Types::GetLifecycleExecutionResponse
Get the runtime information that was logged for a specific runtime instance of the lifecycle policy.
2773 2774 2775 2776 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2773 def get_lifecycle_execution(params = {}, = {}) req = build_request(:get_lifecycle_execution, params) req.send_request() end |
#get_lifecycle_policy(params = {}) ⇒ Types::GetLifecyclePolicyResponse
Get details for the specified image lifecycle policy.
2837 2838 2839 2840 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2837 def get_lifecycle_policy(params = {}, = {}) req = build_request(:get_lifecycle_policy, params) req.send_request() end |
#get_marketplace_resource(params = {}) ⇒ Types::GetMarketplaceResourceResponse
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.
2883 2884 2885 2886 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2883 def get_marketplace_resource(params = {}, = {}) req = build_request(:get_marketplace_resource, params) req.send_request() end |
#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse
Get a workflow resource object.
2931 2932 2933 2934 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2931 def get_workflow(params = {}, = {}) req = build_request(:get_workflow, params) req.send_request() end |
#get_workflow_execution(params = {}) ⇒ Types::GetWorkflowExecutionResponse
Get the runtime information that was logged for a specific runtime instance of the workflow.
2987 2988 2989 2990 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2987 def get_workflow_execution(params = {}, = {}) req = build_request(:get_workflow_execution, params) req.send_request() end |
#get_workflow_step_execution(params = {}) ⇒ Types::GetWorkflowStepExecutionResponse
Get the runtime information that was logged for a specific runtime instance of the workflow step.
3049 3050 3051 3052 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3049 def get_workflow_step_execution(params = {}, = {}) req = build_request(:get_workflow_step_execution, params) req.send_request() end |
#import_component(params = {}) ⇒ Types::ImportComponentResponse
Imports a component and transforms its data into a component document.
3157 3158 3159 3160 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3157 def import_component(params = {}, = {}) req = build_request(:import_component, params) req.send_request() end |
#import_disk_image(params = {}) ⇒ Types::ImportDiskImageResponse
Import a Windows operating system image from a verified Microsoft ISO disk file. The following disk images are supported:
- Windows 11 Enterprise
^
3246 3247 3248 3249 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3246 def import_disk_image(params = {}, = {}) req = build_request(:import_disk_image, params) req.send_request() end |
#import_vm_image(params = {}) ⇒ Types::ImportVmImageResponse
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.
3353 3354 3355 3356 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3353 def import_vm_image(params = {}, = {}) req = build_request(:import_vm_image, params) req.send_request() end |
#list_component_build_versions(params = {}) ⇒ Types::ListComponentBuildVersionsResponse
Returns the list of component build versions for the specified component version Amazon Resource Name (ARN).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3415 3416 3417 3418 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3415 def list_component_build_versions(params = {}, = {}) req = build_request(:list_component_build_versions, params) req.send_request() end |
#list_components(params = {}) ⇒ Types::ListComponentsResponse
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.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3516 3517 3518 3519 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3516 def list_components(params = {}, = {}) req = build_request(:list_components, params) req.send_request() end |
#list_container_recipes(params = {}) ⇒ Types::ListContainerRecipesResponse
Returns a list of container recipes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3587 3588 3589 3590 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3587 def list_container_recipes(params = {}, = {}) req = build_request(:list_container_recipes, params) req.send_request() end |
#list_distribution_configurations(params = {}) ⇒ Types::ListDistributionConfigurationsResponse
Returns a list of distribution configurations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3644 3645 3646 3647 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3644 def list_distribution_configurations(params = {}, = {}) req = build_request(:list_distribution_configurations, params) req.send_request() end |
#list_image_build_versions(params = {}) ⇒ Types::ListImageBuildVersionsResponse
Returns a list of image build versions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3735 3736 3737 3738 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3735 def list_image_build_versions(params = {}, = {}) req = build_request(:list_image_build_versions, params) req.send_request() end |
#list_image_packages(params = {}) ⇒ Types::ListImagePackagesResponse
List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3783 3784 3785 3786 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3783 def list_image_packages(params = {}, = {}) req = build_request(:list_image_packages, params) req.send_request() end |
#list_image_pipeline_images(params = {}) ⇒ Types::ListImagePipelineImagesResponse
Returns a list of images created by the specified pipeline.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3868 3869 3870 3871 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3868 def list_image_pipeline_images(params = {}, = {}) req = build_request(:list_image_pipeline_images, params) req.send_request() end |
#list_image_pipelines(params = {}) ⇒ Types::ListImagePipelinesResponse
Returns a list of image pipelines.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3962 3963 3964 3965 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3962 def list_image_pipelines(params = {}, = {}) req = build_request(:list_image_pipelines, params) req.send_request() end |
#list_image_recipes(params = {}) ⇒ Types::ListImageRecipesResponse
Returns a list of image recipes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4032 4033 4034 4035 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4032 def list_image_recipes(params = {}, = {}) req = build_request(:list_image_recipes, params) req.send_request() end |
#list_image_scan_finding_aggregations(params = {}) ⇒ Types::ListImageScanFindingAggregationsResponse
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
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4115 4116 4117 4118 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4115 def list_image_scan_finding_aggregations(params = {}, = {}) req = build_request(:list_image_scan_finding_aggregations, params) req.send_request() end |
#list_image_scan_findings(params = {}) ⇒ Types::ListImageScanFindingsResponse
Returns a list of image scan findings for your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4222 4223 4224 4225 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4222 def list_image_scan_findings(params = {}, = {}) req = build_request(:list_image_scan_findings, params) req.send_request() end |
#list_images(params = {}) ⇒ Types::ListImagesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4308 4309 4310 4311 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4308 def list_images(params = {}, = {}) req = build_request(:list_images, params) req.send_request() end |
#list_infrastructure_configurations(params = {}) ⇒ Types::ListInfrastructureConfigurationsResponse
Returns a list of infrastructure configurations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4372 4373 4374 4375 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4372 def list_infrastructure_configurations(params = {}, = {}) req = build_request(:list_infrastructure_configurations, params) req.send_request() end |
#list_lifecycle_execution_resources(params = {}) ⇒ Types::ListLifecycleExecutionResourcesResponse
List resources that the runtime instance of the image lifecycle identified for lifecycle actions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4446 4447 4448 4449 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4446 def list_lifecycle_execution_resources(params = {}, = {}) req = build_request(:list_lifecycle_execution_resources, params) req.send_request() end |
#list_lifecycle_executions(params = {}) ⇒ Types::ListLifecycleExecutionsResponse
Get the lifecycle runtime history for the specified resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4495 4496 4497 4498 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4495 def list_lifecycle_executions(params = {}, = {}) req = build_request(:list_lifecycle_executions, params) req.send_request() end |
#list_lifecycle_policies(params = {}) ⇒ Types::ListLifecyclePoliciesResponse
Get a list of lifecycle policies in your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4553 4554 4555 4556 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4553 def list_lifecycle_policies(params = {}, = {}) req = build_request(:list_lifecycle_policies, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns the list of tags for the specified resource.
4583 4584 4585 4586 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4583 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_waiting_workflow_steps(params = {}) ⇒ Types::ListWaitingWorkflowStepsResponse
Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4628 4629 4630 4631 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4628 def list_waiting_workflow_steps(params = {}, = {}) req = build_request(:list_waiting_workflow_steps, params) req.send_request() end |
#list_workflow_build_versions(params = {}) ⇒ Types::ListWorkflowBuildVersionsResponse
Returns a list of build versions for a specific workflow resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4682 4683 4684 4685 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4682 def list_workflow_build_versions(params = {}, = {}) req = build_request(:list_workflow_build_versions, params) req.send_request() end |
#list_workflow_executions(params = {}) ⇒ Types::ListWorkflowExecutionsResponse
Returns a list of workflow runtime instance metadata objects for a specific image build version.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4743 4744 4745 4746 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4743 def list_workflow_executions(params = {}, = {}) req = build_request(:list_workflow_executions, params) req.send_request() end |
#list_workflow_step_executions(params = {}) ⇒ Types::ListWorkflowStepExecutionsResponse
Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4807 4808 4809 4810 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4807 def list_workflow_step_executions(params = {}, = {}) req = build_request(:list_workflow_step_executions, params) req.send_request() end |
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Lists workflow build versions based on filtering parameters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4869 4870 4871 4872 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4869 def list_workflows(params = {}, = {}) req = build_request(:list_workflows, params) req.send_request() end |
#put_component_policy(params = {}) ⇒ Types::PutComponentPolicyResponse
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.
4913 4914 4915 4916 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4913 def put_component_policy(params = {}, = {}) req = build_request(:put_component_policy, params) req.send_request() end |
#put_container_recipe_policy(params = {}) ⇒ Types::PutContainerRecipePolicyResponse
Applies a policy to a container image. We recommend that you call the
RAM API CreateResourceShare
(https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html)
to share resources. If you call the Image Builder API
PutContainerImagePolicy
, you must also call the RAM API
PromoteResourceShareCreatedFromPolicy
(https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html)
in order for the resource to be visible to all principals with whom
the resource is shared.
4956 4957 4958 4959 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4956 def put_container_recipe_policy(params = {}, = {}) req = build_request(:put_container_recipe_policy, params) req.send_request() end |
#put_image_policy(params = {}) ⇒ Types::PutImagePolicyResponse
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.
5000 5001 5002 5003 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5000 def put_image_policy(params = {}, = {}) req = build_request(:put_image_policy, params) req.send_request() end |
#put_image_recipe_policy(params = {}) ⇒ Types::PutImageRecipePolicyResponse
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.
5045 5046 5047 5048 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5045 def put_image_recipe_policy(params = {}, = {}) req = build_request(:put_image_recipe_policy, params) req.send_request() end |
#send_workflow_step_action(params = {}) ⇒ Types::SendWorkflowStepActionResponse
Pauses or resumes image creation when the associated workflow runs a
WaitForAction
step.
5105 5106 5107 5108 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5105 def send_workflow_step_action(params = {}, = {}) req = build_request(:send_workflow_step_action, params) req.send_request() end |
#start_image_pipeline_execution(params = {}) ⇒ Types::StartImagePipelineExecutionResponse
Manually triggers a pipeline to create an image.
5151 5152 5153 5154 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5151 def start_image_pipeline_execution(params = {}, = {}) req = build_request(:start_image_pipeline_execution, params) req.send_request() end |
#start_resource_state_update(params = {}) ⇒ Types::StartResourceStateUpdateResponse
Begin asynchronous resource state update for lifecycle changes to the specified image resources.
5238 5239 5240 5241 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5238 def start_resource_state_update(params = {}, = {}) req = build_request(:start_resource_state_update, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds a tag to a resource.
5266 5267 5268 5269 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5266 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource.
5292 5293 5294 5295 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5292 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_distribution_configuration(params = {}) ⇒ Types::UpdateDistributionConfigurationResponse
Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
5410 5411 5412 5413 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5410 def update_distribution_configuration(params = {}, = {}) req = build_request(:update_distribution_configuration, params) req.send_request() end |
#update_image_pipeline(params = {}) ⇒ Types::UpdateImagePipelineResponse
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
.
5547 5548 5549 5550 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5547 def update_image_pipeline(params = {}, = {}) req = build_request(:update_image_pipeline, params) req.send_request() end |
#update_infrastructure_configuration(params = {}) ⇒ Types::UpdateInfrastructureConfigurationResponse
Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
5690 5691 5692 5693 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5690 def update_infrastructure_configuration(params = {}, = {}) req = build_request(:update_infrastructure_configuration, params) req.send_request() end |
#update_lifecycle_policy(params = {}) ⇒ Types::UpdateLifecyclePolicyResponse
Update the specified lifecycle policy.
5800 5801 5802 5803 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5800 def update_lifecycle_policy(params = {}, = {}) req = build_request(:update_lifecycle_policy, params) req.send_request() end |