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.
446 447 448 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 446 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.
494 495 496 497 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 494 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.
536 537 538 539 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 536 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.
655 656 657 658 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 655 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.
814 815 816 817 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 814 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.
930 931 932 933 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 930 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.
1046 1047 1048 1049 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1046 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.
1180 1181 1182 1183 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1180 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.
1316 1317 1318 1319 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1316 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.
1441 1442 1443 1444 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1441 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.
1561 1562 1563 1564 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1561 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.
1666 1667 1668 1669 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1666 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_component(params = {}) ⇒ Types::DeleteComponentResponse
Deletes a component build version.
1697 1698 1699 1700 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1697 def delete_component(params = {}, = {}) req = build_request(:delete_component, params) req.send_request() end |
#delete_container_recipe(params = {}) ⇒ Types::DeleteContainerRecipeResponse
Deletes a container recipe.
1727 1728 1729 1730 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1727 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.
1758 1759 1760 1761 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1758 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.
1807 1808 1809 1810 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1807 def delete_image(params = {}, = {}) req = build_request(:delete_image, params) req.send_request() end |
#delete_image_pipeline(params = {}) ⇒ Types::DeleteImagePipelineResponse
Deletes an image pipeline.
1837 1838 1839 1840 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1837 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.
1867 1868 1869 1870 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1867 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.
1898 1899 1900 1901 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1898 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.
1927 1928 1929 1930 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1927 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.
1955 1956 1957 1958 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1955 def delete_workflow(params = {}, = {}) req = build_request(:delete_workflow, params) req.send_request() end |
#get_component(params = {}) ⇒ Types::GetComponentResponse
Gets a component object.
2011 2012 2013 2014 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2011 def get_component(params = {}, = {}) req = build_request(:get_component, params) req.send_request() end |
#get_component_policy(params = {}) ⇒ Types::GetComponentPolicyResponse
Gets a component policy.
2042 2043 2044 2045 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2042 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.
2107 2108 2109 2110 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2107 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.
2138 2139 2140 2141 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2138 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.
2216 2217 2218 2219 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2216 def get_distribution_configuration(params = {}, = {}) req = build_request(:get_distribution_configuration, params) req.send_request() end |
#get_image(params = {}) ⇒ Types::GetImageResponse
Gets an image.
2430 2431 2432 2433 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2430 def get_image(params = {}, = {}) req = build_request(:get_image, params) req.send_request() end |
#get_image_pipeline(params = {}) ⇒ Types::GetImagePipelineResponse
Gets an image pipeline.
2494 2495 2496 2497 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2494 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.
2525 2526 2527 2528 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2525 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.
2587 2588 2589 2590 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2587 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.
2618 2619 2620 2621 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2618 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.
2670 2671 2672 2673 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2670 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.
2706 2707 2708 2709 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2706 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.
2770 2771 2772 2773 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2770 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.
2818 2819 2820 2821 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2818 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.
2874 2875 2876 2877 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2874 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.
2936 2937 2938 2939 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2936 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.
3044 3045 3046 3047 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3044 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.
3151 3152 3153 3154 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3151 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.
3225 3226 3227 3228 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3225 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.
3322 3323 3324 3325 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3322 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.
3393 3394 3395 3396 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3393 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.
3450 3451 3452 3453 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3450 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.
3541 3542 3543 3544 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3541 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.
3589 3590 3591 3592 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3589 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.
3674 3675 3676 3677 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3674 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.
3768 3769 3770 3771 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3768 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.
3838 3839 3840 3841 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3838 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.
3921 3922 3923 3924 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3921 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.
4028 4029 4030 4031 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4028 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.
4114 4115 4116 4117 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4114 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.
4174 4175 4176 4177 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4174 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.
4248 4249 4250 4251 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4248 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.
4297 4298 4299 4300 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4297 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.
4355 4356 4357 4358 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4355 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.
4385 4386 4387 4388 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4385 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.
4430 4431 4432 4433 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4430 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.
4484 4485 4486 4487 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4484 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.
4545 4546 4547 4548 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4545 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.
4609 4610 4611 4612 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4609 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.
4671 4672 4673 4674 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4671 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.
4715 4716 4717 4718 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4715 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.
4758 4759 4760 4761 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4758 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.
4802 4803 4804 4805 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4802 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.
4847 4848 4849 4850 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4847 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.
4907 4908 4909 4910 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4907 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.
4953 4954 4955 4956 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4953 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.
5040 5041 5042 5043 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5040 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.
5068 5069 5070 5071 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5068 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource.
5094 5095 5096 5097 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5094 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.
5205 5206 5207 5208 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5205 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
.
5342 5343 5344 5345 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5342 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.
5475 5476 5477 5478 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5475 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.
5585 5586 5587 5588 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5585 def update_lifecycle_policy(params = {}, = {}) req = build_request(:update_lifecycle_policy, params) req.send_request() end |