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_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_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 semantic version.
-
#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.
422 423 424 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 422 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.
470 471 472 473 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 470 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.
512 513 514 515 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 512 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.
631 632 633 634 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 631 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.
790 791 792 793 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 790 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.
906 907 908 909 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 906 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.
1022 1023 1024 1025 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1022 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.
1156 1157 1158 1159 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1156 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.
1292 1293 1294 1295 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1292 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.
1417 1418 1419 1420 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1417 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.
1537 1538 1539 1540 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1537 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.
1642 1643 1644 1645 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1642 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_component(params = {}) ⇒ Types::DeleteComponentResponse
Deletes a component build version.
1673 1674 1675 1676 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1673 def delete_component(params = {}, = {}) req = build_request(:delete_component, params) req.send_request() end |
#delete_container_recipe(params = {}) ⇒ Types::DeleteContainerRecipeResponse
Deletes a container recipe.
1703 1704 1705 1706 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1703 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.
1734 1735 1736 1737 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1734 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.
1783 1784 1785 1786 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1783 def delete_image(params = {}, = {}) req = build_request(:delete_image, params) req.send_request() end |
#delete_image_pipeline(params = {}) ⇒ Types::DeleteImagePipelineResponse
Deletes an image pipeline.
1813 1814 1815 1816 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1813 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.
1843 1844 1845 1846 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1843 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.
1874 1875 1876 1877 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1874 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.
1903 1904 1905 1906 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1903 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.
1931 1932 1933 1934 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1931 def delete_workflow(params = {}, = {}) req = build_request(:delete_workflow, params) req.send_request() end |
#get_component(params = {}) ⇒ Types::GetComponentResponse
Gets a component object.
1987 1988 1989 1990 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1987 def get_component(params = {}, = {}) req = build_request(:get_component, params) req.send_request() end |
#get_component_policy(params = {}) ⇒ Types::GetComponentPolicyResponse
Gets a component policy.
2018 2019 2020 2021 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2018 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.
2083 2084 2085 2086 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2083 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.
2114 2115 2116 2117 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2114 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.
2192 2193 2194 2195 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2192 def get_distribution_configuration(params = {}, = {}) req = build_request(:get_distribution_configuration, params) req.send_request() end |
#get_image(params = {}) ⇒ Types::GetImageResponse
Gets an image.
2406 2407 2408 2409 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2406 def get_image(params = {}, = {}) req = build_request(:get_image, params) req.send_request() end |
#get_image_pipeline(params = {}) ⇒ Types::GetImagePipelineResponse
Gets an image pipeline.
2470 2471 2472 2473 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2470 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.
2501 2502 2503 2504 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2501 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.
2563 2564 2565 2566 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2563 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.
2594 2595 2596 2597 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2594 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.
2646 2647 2648 2649 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2646 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.
2682 2683 2684 2685 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2682 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.
2746 2747 2748 2749 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2746 def get_lifecycle_policy(params = {}, = {}) req = build_request(:get_lifecycle_policy, params) req.send_request() end |
#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse
Get a workflow resource object.
2794 2795 2796 2797 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2794 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.
2850 2851 2852 2853 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2850 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.
2912 2913 2914 2915 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2912 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.
3020 3021 3022 3023 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3020 def import_component(params = {}, = {}) req = build_request(:import_component, 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.
3127 3128 3129 3130 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3127 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 semantic version.
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.
3201 3202 3203 3204 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3201 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.
3298 3299 3300 3301 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3298 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.
3369 3370 3371 3372 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3369 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.
3426 3427 3428 3429 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3426 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.
3517 3518 3519 3520 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3517 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.
3565 3566 3567 3568 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3565 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.
3650 3651 3652 3653 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3650 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.
3744 3745 3746 3747 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3744 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.
3814 3815 3816 3817 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3814 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.
3897 3898 3899 3900 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3897 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.
4004 4005 4006 4007 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4004 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.
4090 4091 4092 4093 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4090 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.
4150 4151 4152 4153 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4150 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.
4224 4225 4226 4227 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4224 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.
4273 4274 4275 4276 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4273 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.
4331 4332 4333 4334 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4331 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.
4361 4362 4363 4364 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4361 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.
4406 4407 4408 4409 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4406 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.
4460 4461 4462 4463 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4460 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.
4521 4522 4523 4524 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4521 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.
4585 4586 4587 4588 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4585 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.
4647 4648 4649 4650 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4647 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.
4691 4692 4693 4694 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4691 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.
4734 4735 4736 4737 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4734 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.
4778 4779 4780 4781 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4778 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.
4823 4824 4825 4826 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4823 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.
4883 4884 4885 4886 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4883 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.
4929 4930 4931 4932 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4929 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.
5016 5017 5018 5019 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5016 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.
5044 5045 5046 5047 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5044 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource.
5070 5071 5072 5073 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5070 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.
5181 5182 5183 5184 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5181 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
.
5318 5319 5320 5321 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5318 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.
5451 5452 5453 5454 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5451 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.
5561 5562 5563 5564 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5561 def update_lifecycle_policy(params = {}, = {}) req = build_request(:update_lifecycle_policy, params) req.send_request() end |