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 component version Amazon Resource Name (ARN).
-
#list_components(params = {}) ⇒ Types::ListComponentsResponse
Returns the list of components that can be filtered by name, or by using the listed
filters
to streamline results. -
#list_container_recipes(params = {}) ⇒ Types::ListContainerRecipesResponse
Returns a list of container recipes.
-
#list_distribution_configurations(params = {}) ⇒ Types::ListDistributionConfigurationsResponse
Returns a list of distribution configurations.
-
#list_image_build_versions(params = {}) ⇒ Types::ListImageBuildVersionsResponse
Returns a list of image build versions.
-
#list_image_packages(params = {}) ⇒ Types::ListImagePackagesResponse
List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.
-
#list_image_pipeline_images(params = {}) ⇒ Types::ListImagePipelineImagesResponse
Returns a list of images created by the specified pipeline.
-
#list_image_pipelines(params = {}) ⇒ Types::ListImagePipelinesResponse
Returns a list of image pipelines.
-
#list_image_recipes(params = {}) ⇒ Types::ListImageRecipesResponse
Returns a list of image recipes.
-
#list_image_scan_finding_aggregations(params = {}) ⇒ Types::ListImageScanFindingAggregationsResponse
Returns a list of image scan aggregations for your account.
-
#list_image_scan_findings(params = {}) ⇒ Types::ListImageScanFindingsResponse
Returns a list of image scan findings for your account.
-
#list_images(params = {}) ⇒ Types::ListImagesResponse
Returns the list of images that you have access to.
-
#list_infrastructure_configurations(params = {}) ⇒ Types::ListInfrastructureConfigurationsResponse
Returns a list of infrastructure configurations.
-
#list_lifecycle_execution_resources(params = {}) ⇒ Types::ListLifecycleExecutionResourcesResponse
List resources that the runtime instance of the image lifecycle identified for lifecycle actions.
-
#list_lifecycle_executions(params = {}) ⇒ Types::ListLifecycleExecutionsResponse
Get the lifecycle runtime history for the specified resource.
-
#list_lifecycle_policies(params = {}) ⇒ Types::ListLifecyclePoliciesResponse
Get a list of lifecycle policies in your Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns the list of tags for the specified resource.
-
#list_waiting_workflow_steps(params = {}) ⇒ Types::ListWaitingWorkflowStepsResponse
Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.
-
#list_workflow_build_versions(params = {}) ⇒ Types::ListWorkflowBuildVersionsResponse
Returns a list of build versions for a specific workflow resource.
-
#list_workflow_executions(params = {}) ⇒ Types::ListWorkflowExecutionsResponse
Returns a list of workflow runtime instance metadata objects for a specific image build version.
-
#list_workflow_step_executions(params = {}) ⇒ Types::ListWorkflowStepExecutionsResponse
Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.
-
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Lists workflow build versions based on filtering parameters.
-
#put_component_policy(params = {}) ⇒ Types::PutComponentPolicyResponse
Applies a policy to a component.
-
#put_container_recipe_policy(params = {}) ⇒ Types::PutContainerRecipePolicyResponse
Applies a policy to a container image.
-
#put_image_policy(params = {}) ⇒ Types::PutImagePolicyResponse
Applies a policy to an image.
-
#put_image_recipe_policy(params = {}) ⇒ Types::PutImageRecipePolicyResponse
Applies a policy to an image recipe.
-
#send_workflow_step_action(params = {}) ⇒ Types::SendWorkflowStepActionResponse
Pauses or resumes image creation when the associated workflow runs a
WaitForAction
step. -
#start_image_pipeline_execution(params = {}) ⇒ Types::StartImagePipelineExecutionResponse
Manually triggers a pipeline to create an image.
-
#start_resource_state_update(params = {}) ⇒ Types::StartResourceStateUpdateResponse
Begin asynchronous resource state update for lifecycle changes to the specified image resources.
-
#tag_resource(params = {}) ⇒ Struct
Adds a tag to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource.
-
#update_distribution_configuration(params = {}) ⇒ Types::UpdateDistributionConfigurationResponse
Updates a new distribution configuration.
-
#update_image_pipeline(params = {}) ⇒ Types::UpdateImagePipelineResponse
Updates an image pipeline.
-
#update_infrastructure_configuration(params = {}) ⇒ Types::UpdateInfrastructureConfigurationResponse
Updates a new infrastructure configuration.
-
#update_lifecycle_policy(params = {}) ⇒ Types::UpdateLifecyclePolicyResponse
Update the specified lifecycle policy.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
444 445 446 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 444 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.
492 493 494 495 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 492 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.
534 535 536 537 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 534 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.
653 654 655 656 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 653 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.
812 813 814 815 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 812 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.
928 929 930 931 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 928 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.
1044 1045 1046 1047 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1044 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.
1178 1179 1180 1181 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1178 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.
1314 1315 1316 1317 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1314 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.
1453 1454 1455 1456 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1453 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.
1573 1574 1575 1576 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1573 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.
1678 1679 1680 1681 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1678 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_component(params = {}) ⇒ Types::DeleteComponentResponse
Deletes a component build version.
1709 1710 1711 1712 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1709 def delete_component(params = {}, = {}) req = build_request(:delete_component, params) req.send_request() end |
#delete_container_recipe(params = {}) ⇒ Types::DeleteContainerRecipeResponse
Deletes a container recipe.
1739 1740 1741 1742 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1739 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.
1770 1771 1772 1773 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1770 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.
1819 1820 1821 1822 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1819 def delete_image(params = {}, = {}) req = build_request(:delete_image, params) req.send_request() end |
#delete_image_pipeline(params = {}) ⇒ Types::DeleteImagePipelineResponse
Deletes an image pipeline.
1849 1850 1851 1852 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1849 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.
1879 1880 1881 1882 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1879 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.
1910 1911 1912 1913 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1910 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.
1939 1940 1941 1942 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1939 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.
1967 1968 1969 1970 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 1967 def delete_workflow(params = {}, = {}) req = build_request(:delete_workflow, params) req.send_request() end |
#get_component(params = {}) ⇒ Types::GetComponentResponse
Gets a component object.
2023 2024 2025 2026 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2023 def get_component(params = {}, = {}) req = build_request(:get_component, params) req.send_request() end |
#get_component_policy(params = {}) ⇒ Types::GetComponentPolicyResponse
Gets a component policy.
2054 2055 2056 2057 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2054 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.
2119 2120 2121 2122 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2119 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.
2150 2151 2152 2153 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2150 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.
2228 2229 2230 2231 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2228 def get_distribution_configuration(params = {}, = {}) req = build_request(:get_distribution_configuration, params) req.send_request() end |
#get_image(params = {}) ⇒ Types::GetImageResponse
Gets an image.
2446 2447 2448 2449 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2446 def get_image(params = {}, = {}) req = build_request(:get_image, params) req.send_request() end |
#get_image_pipeline(params = {}) ⇒ Types::GetImagePipelineResponse
Gets an image pipeline.
2510 2511 2512 2513 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2510 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.
2541 2542 2543 2544 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2541 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.
2603 2604 2605 2606 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2603 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.
2634 2635 2636 2637 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2634 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.
2690 2691 2692 2693 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2690 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.
2726 2727 2728 2729 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2726 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.
2790 2791 2792 2793 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2790 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.
2838 2839 2840 2841 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2838 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.
2894 2895 2896 2897 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2894 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.
2956 2957 2958 2959 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 2956 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.
3064 3065 3066 3067 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3064 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.
3171 3172 3173 3174 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3171 def import_vm_image(params = {}, = {}) req = build_request(:import_vm_image, params) req.send_request() end |
#list_component_build_versions(params = {}) ⇒ Types::ListComponentBuildVersionsResponse
Returns the list of component build versions for the specified component version Amazon Resource Name (ARN).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3233 3234 3235 3236 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3233 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.
3330 3331 3332 3333 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3330 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.
3401 3402 3403 3404 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3401 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.
3458 3459 3460 3461 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3458 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.
3549 3550 3551 3552 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3549 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.
3597 3598 3599 3600 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3597 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.
3682 3683 3684 3685 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3682 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.
3776 3777 3778 3779 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3776 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.
3846 3847 3848 3849 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3846 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.
3929 3930 3931 3932 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 3929 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.
4036 4037 4038 4039 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4036 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.
4122 4123 4124 4125 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4122 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.
4186 4187 4188 4189 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4186 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.
4260 4261 4262 4263 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4260 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.
4309 4310 4311 4312 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4309 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.
4367 4368 4369 4370 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4367 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.
4397 4398 4399 4400 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4397 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.
4442 4443 4444 4445 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4442 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.
4496 4497 4498 4499 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4496 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.
4557 4558 4559 4560 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4557 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.
4621 4622 4623 4624 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4621 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.
4683 4684 4685 4686 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4683 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.
4727 4728 4729 4730 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4727 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.
4770 4771 4772 4773 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4770 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.
4814 4815 4816 4817 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4814 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.
4859 4860 4861 4862 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4859 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.
4919 4920 4921 4922 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4919 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.
4965 4966 4967 4968 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 4965 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.
5052 5053 5054 5055 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/client.rb', line 5052 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.