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.
410 411 412 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 410 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.
458 459 460 461 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 458 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.
500 501 502 503 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 500 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.
619 620 621 622 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 619 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.
778 779 780 781 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 778 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.
894 895 896 897 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 894 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.
1010 1011 1012 1013 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1010 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.
1144 1145 1146 1147 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1144 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.
1280 1281 1282 1283 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1280 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.
1405 1406 1407 1408 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1405 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.
1525 1526 1527 1528 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1525 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.
1630 1631 1632 1633 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1630 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_component(params = {}) ⇒ Types::DeleteComponentResponse
Deletes a component build version.
1661 1662 1663 1664 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1661 def delete_component(params = {}, = {}) req = build_request(:delete_component, params) req.send_request() end |
#delete_container_recipe(params = {}) ⇒ Types::DeleteContainerRecipeResponse
Deletes a container recipe.
1691 1692 1693 1694 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1691 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.
1722 1723 1724 1725 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1722 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.
1771 1772 1773 1774 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1771 def delete_image(params = {}, = {}) req = build_request(:delete_image, params) req.send_request() end |
#delete_image_pipeline(params = {}) ⇒ Types::DeleteImagePipelineResponse
Deletes an image pipeline.
1801 1802 1803 1804 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1801 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.
1831 1832 1833 1834 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1831 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.
1862 1863 1864 1865 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1862 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.
1891 1892 1893 1894 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1891 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.
1919 1920 1921 1922 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1919 def delete_workflow(params = {}, = {}) req = build_request(:delete_workflow, params) req.send_request() end |
#get_component(params = {}) ⇒ Types::GetComponentResponse
Gets a component object.
1975 1976 1977 1978 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1975 def get_component(params = {}, = {}) req = build_request(:get_component, params) req.send_request() end |
#get_component_policy(params = {}) ⇒ Types::GetComponentPolicyResponse
Gets a component policy.
2006 2007 2008 2009 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2006 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.
2071 2072 2073 2074 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2071 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.
2102 2103 2104 2105 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2102 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.
2180 2181 2182 2183 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2180 def get_distribution_configuration(params = {}, = {}) req = build_request(:get_distribution_configuration, params) req.send_request() end |
#get_image(params = {}) ⇒ Types::GetImageResponse
Gets an image.
2394 2395 2396 2397 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2394 def get_image(params = {}, = {}) req = build_request(:get_image, params) req.send_request() end |
#get_image_pipeline(params = {}) ⇒ Types::GetImagePipelineResponse
Gets an image pipeline.
2458 2459 2460 2461 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2458 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.
2489 2490 2491 2492 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2489 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.
2551 2552 2553 2554 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2551 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.
2582 2583 2584 2585 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2582 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.
2634 2635 2636 2637 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2634 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.
2670 2671 2672 2673 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2670 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.
2734 2735 2736 2737 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2734 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.
2782 2783 2784 2785 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2782 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.
2838 2839 2840 2841 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2838 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.
2900 2901 2902 2903 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2900 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.
3008 3009 3010 3011 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3008 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.
3115 3116 3117 3118 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3115 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.
3189 3190 3191 3192 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3189 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.
3286 3287 3288 3289 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3286 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.
3357 3358 3359 3360 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3357 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.
3414 3415 3416 3417 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3414 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.
3505 3506 3507 3508 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3505 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.
3553 3554 3555 3556 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3553 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.
3638 3639 3640 3641 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3638 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.
3732 3733 3734 3735 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3732 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.
3802 3803 3804 3805 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3802 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.
3885 3886 3887 3888 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3885 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.
3992 3993 3994 3995 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3992 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.
4078 4079 4080 4081 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4078 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.
4138 4139 4140 4141 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4138 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.
4212 4213 4214 4215 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4212 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.
4261 4262 4263 4264 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4261 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.
4319 4320 4321 4322 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4319 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.
4349 4350 4351 4352 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4349 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.
4394 4395 4396 4397 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4394 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.
4448 4449 4450 4451 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4448 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.
4509 4510 4511 4512 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4509 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.
4573 4574 4575 4576 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4573 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.
4635 4636 4637 4638 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4635 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.
4679 4680 4681 4682 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4679 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.
4722 4723 4724 4725 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4722 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.
4766 4767 4768 4769 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4766 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.
4811 4812 4813 4814 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4811 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.
4871 4872 4873 4874 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4871 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.
4917 4918 4919 4920 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4917 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.
5004 5005 5006 5007 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5004 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.
5032 5033 5034 5035 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5032 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource.
5058 5059 5060 5061 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5058 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.
5169 5170 5171 5172 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5169 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
.
5306 5307 5308 5309 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5306 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.
5439 5440 5441 5442 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5439 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.
5549 5550 5551 5552 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5549 def update_lifecycle_policy(params = {}, = {}) req = build_request(:update_lifecycle_policy, params) req.send_request() end |