imagebuilder

package module
v1.35.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 4, 2024 License: Apache-2.0 Imports: 43 Imported by: 10

Documentation

Overview

Package imagebuilder provides the API client, operations, and parameter types for EC2 Image Builder.

EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.

Index

Constants

View Source 
const ServiceAPIVersion = "2019-12-02"
View Source 
const ServiceID = "imagebuilder"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.24.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.27.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.27.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.27.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.27.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type CancelImageCreationInput 

type CancelImageCreationInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image that you want to cancel creation
	// for.
	//
	// This member is required.
	ImageBuildVersionArn *string
	// contains filtered or unexported fields
}

type CancelImageCreationOutput 

type CancelImageCreationOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The ARN of the image whose creation this request canceled.
	ImageBuildVersionArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelLifecycleExecutionInput added in v1.28.0 

type CancelLifecycleExecutionInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// Identifies the specific runtime instance of the image lifecycle to cancel.
	//
	// This member is required.
	LifecycleExecutionId *string
	// contains filtered or unexported fields
}

type CancelLifecycleExecutionOutput added in v1.28.0 

type CancelLifecycleExecutionOutput struct {

	// The unique identifier for the image lifecycle runtime instance that was
	// canceled.
	LifecycleExecutionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for EC2 Image Builder.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CancelImageCreation 

func (c *Client) CancelImageCreation(ctx context.Context, params *CancelImageCreationInput, optFns ...func(*Options)) (*CancelImageCreationOutput, error)

CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.

func (*Client) CancelLifecycleExecution added in v1.28.0 

func (c *Client) CancelLifecycleExecution(ctx context.Context, params *CancelLifecycleExecutionInput, optFns ...func(*Options)) (*CancelLifecycleExecutionOutput, error)

Cancel a specific image lifecycle policy runtime instance.

func (*Client) CreateComponent 

func (c *Client) CreateComponent(ctx context.Context, params *CreateComponentInput, optFns ...func(*Options)) (*CreateComponentOutput, error)

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.

func (*Client) CreateContainerRecipe added in v0.31.0 

func (c *Client) CreateContainerRecipe(ctx context.Context, params *CreateContainerRecipeInput, optFns ...func(*Options)) (*CreateContainerRecipeOutput, error)

Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.

func (*Client) CreateDistributionConfiguration 

func (c *Client) CreateDistributionConfiguration(ctx context.Context, params *CreateDistributionConfigurationInput, optFns ...func(*Options)) (*CreateDistributionConfigurationOutput, error)

Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.

func (*Client) CreateImage 

func (c *Client) CreateImage(ctx context.Context, params *CreateImageInput, optFns ...func(*Options)) (*CreateImageOutput, error)

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.

func (*Client) CreateImagePipeline 

func (c *Client) CreateImagePipeline(ctx context.Context, params *CreateImagePipelineInput, optFns ...func(*Options)) (*CreateImagePipelineOutput, error)

Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.

func (*Client) CreateImageRecipe 

func (c *Client) CreateImageRecipe(ctx context.Context, params *CreateImageRecipeInput, optFns ...func(*Options)) (*CreateImageRecipeOutput, error)

Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.

func (*Client) CreateInfrastructureConfiguration 

func (c *Client) CreateInfrastructureConfiguration(ctx context.Context, params *CreateInfrastructureConfigurationInput, optFns ...func(*Options)) (*CreateInfrastructureConfigurationOutput, error)

Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

func (*Client) CreateLifecyclePolicy added in v1.28.0 

func (c *Client) CreateLifecyclePolicy(ctx context.Context, params *CreateLifecyclePolicyInput, optFns ...func(*Options)) (*CreateLifecyclePolicyOutput, error)

Create a lifecycle policy resource.

func (*Client) CreateWorkflow added in v1.30.0 

func (c *Client) CreateWorkflow(ctx context.Context, params *CreateWorkflowInput, optFns ...func(*Options)) (*CreateWorkflowOutput, error)

Create a new workflow or a new version of an existing workflow.

func (*Client) DeleteComponent 

func (c *Client) DeleteComponent(ctx context.Context, params *DeleteComponentInput, optFns ...func(*Options)) (*DeleteComponentOutput, error)

Deletes a component build version.

func (*Client) DeleteContainerRecipe added in v0.31.0 

func (c *Client) DeleteContainerRecipe(ctx context.Context, params *DeleteContainerRecipeInput, optFns ...func(*Options)) (*DeleteContainerRecipeOutput, error)

Deletes a container recipe.

func (*Client) DeleteDistributionConfiguration 

func (c *Client) DeleteDistributionConfiguration(ctx context.Context, params *DeleteDistributionConfigurationInput, optFns ...func(*Options)) (*DeleteDistributionConfigurationOutput, error)

Deletes a distribution configuration.

func (*Client) DeleteImage 

func (c *Client) DeleteImage(ctx context.Context, params *DeleteImageInput, optFns ...func(*Options)) (*DeleteImageOutput, error)

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.

func (*Client) DeleteImagePipeline 

func (c *Client) DeleteImagePipeline(ctx context.Context, params *DeleteImagePipelineInput, optFns ...func(*Options)) (*DeleteImagePipelineOutput, error)

Deletes an image pipeline.

func (*Client) DeleteImageRecipe 

func (c *Client) DeleteImageRecipe(ctx context.Context, params *DeleteImageRecipeInput, optFns ...func(*Options)) (*DeleteImageRecipeOutput, error)

Deletes an image recipe.

func (*Client) DeleteInfrastructureConfiguration 

func (c *Client) DeleteInfrastructureConfiguration(ctx context.Context, params *DeleteInfrastructureConfigurationInput, optFns ...func(*Options)) (*DeleteInfrastructureConfigurationOutput, error)

Deletes an infrastructure configuration.

func (*Client) DeleteLifecyclePolicy added in v1.28.0 

func (c *Client) DeleteLifecyclePolicy(ctx context.Context, params *DeleteLifecyclePolicyInput, optFns ...func(*Options)) (*DeleteLifecyclePolicyOutput, error)

Delete the specified lifecycle policy resource.

func (*Client) DeleteWorkflow added in v1.30.0 

func (c *Client) DeleteWorkflow(ctx context.Context, params *DeleteWorkflowInput, optFns ...func(*Options)) (*DeleteWorkflowOutput, error)

Deletes a specific workflow resource.

func (*Client) GetComponent 

func (c *Client) GetComponent(ctx context.Context, params *GetComponentInput, optFns ...func(*Options)) (*GetComponentOutput, error)

Gets a component object.

func (*Client) GetComponentPolicy 

func (c *Client) GetComponentPolicy(ctx context.Context, params *GetComponentPolicyInput, optFns ...func(*Options)) (*GetComponentPolicyOutput, error)

Gets a component policy.

func (*Client) GetContainerRecipe added in v0.31.0 

func (c *Client) GetContainerRecipe(ctx context.Context, params *GetContainerRecipeInput, optFns ...func(*Options)) (*GetContainerRecipeOutput, error)

Retrieves a container recipe.

func (*Client) GetContainerRecipePolicy added in v0.31.0 

func (c *Client) GetContainerRecipePolicy(ctx context.Context, params *GetContainerRecipePolicyInput, optFns ...func(*Options)) (*GetContainerRecipePolicyOutput, error)

Retrieves the policy for a container recipe.

func (*Client) GetDistributionConfiguration 

func (c *Client) GetDistributionConfiguration(ctx context.Context, params *GetDistributionConfigurationInput, optFns ...func(*Options)) (*GetDistributionConfigurationOutput, error)

Gets a distribution configuration.

func (*Client) GetImage 

func (c *Client) GetImage(ctx context.Context, params *GetImageInput, optFns ...func(*Options)) (*GetImageOutput, error)

Gets an image.

func (*Client) GetImagePipeline 

func (c *Client) GetImagePipeline(ctx context.Context, params *GetImagePipelineInput, optFns ...func(*Options)) (*GetImagePipelineOutput, error)

Gets an image pipeline.

func (*Client) GetImagePolicy 

func (c *Client) GetImagePolicy(ctx context.Context, params *GetImagePolicyInput, optFns ...func(*Options)) (*GetImagePolicyOutput, error)

Gets an image policy.

func (*Client) GetImageRecipe 

func (c *Client) GetImageRecipe(ctx context.Context, params *GetImageRecipeInput, optFns ...func(*Options)) (*GetImageRecipeOutput, error)

Gets an image recipe.

func (*Client) GetImageRecipePolicy 

func (c *Client) GetImageRecipePolicy(ctx context.Context, params *GetImageRecipePolicyInput, optFns ...func(*Options)) (*GetImageRecipePolicyOutput, error)

Gets an image recipe policy.

func (*Client) GetInfrastructureConfiguration 

func (c *Client) GetInfrastructureConfiguration(ctx context.Context, params *GetInfrastructureConfigurationInput, optFns ...func(*Options)) (*GetInfrastructureConfigurationOutput, error)

Gets an infrastructure configuration.

func (*Client) GetLifecycleExecution added in v1.28.0 

func (c *Client) GetLifecycleExecution(ctx context.Context, params *GetLifecycleExecutionInput, optFns ...func(*Options)) (*GetLifecycleExecutionOutput, error)

Get the runtime information that was logged for a specific runtime instance of the lifecycle policy.

func (*Client) GetLifecyclePolicy added in v1.28.0 

func (c *Client) GetLifecyclePolicy(ctx context.Context, params *GetLifecyclePolicyInput, optFns ...func(*Options)) (*GetLifecyclePolicyOutput, error)

Get details for the specified image lifecycle policy.

func (*Client) GetWorkflow added in v1.30.0 

func (c *Client) GetWorkflow(ctx context.Context, params *GetWorkflowInput, optFns ...func(*Options)) (*GetWorkflowOutput, error)

Get a workflow resource object.

func (*Client) GetWorkflowExecution added in v1.23.0 

func (c *Client) GetWorkflowExecution(ctx context.Context, params *GetWorkflowExecutionInput, optFns ...func(*Options)) (*GetWorkflowExecutionOutput, error)

Get the runtime information that was logged for a specific runtime instance of the workflow.

func (*Client) GetWorkflowStepExecution added in v1.23.0 

func (c *Client) GetWorkflowStepExecution(ctx context.Context, params *GetWorkflowStepExecutionInput, optFns ...func(*Options)) (*GetWorkflowStepExecutionOutput, error)

Get the runtime information that was logged for a specific runtime instance of the workflow step.

func (*Client) ImportComponent 

func (c *Client) ImportComponent(ctx context.Context, params *ImportComponentInput, optFns ...func(*Options)) (*ImportComponentOutput, error)

Imports a component and transforms its data into a component document.

func (*Client) ImportVmImage added in v1.15.0 

func (c *Client) ImportVmImage(ctx context.Context, params *ImportVmImageInput, optFns ...func(*Options)) (*ImportVmImageOutput, error)

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.

func (*Client) ListComponentBuildVersions 

func (c *Client) ListComponentBuildVersions(ctx context.Context, params *ListComponentBuildVersionsInput, optFns ...func(*Options)) (*ListComponentBuildVersionsOutput, error)

Returns the list of component build versions for the specified semantic version.

The semantic version has four nodes: ../. You can assign values for the first three, and can filter on all of them.

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.

func (*Client) ListComponents 

func (c *Client) ListComponents(ctx context.Context, params *ListComponentsInput, optFns ...func(*Options)) (*ListComponentsOutput, error)

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.

The semantic version has four nodes: ../. You can assign values for the first three, and can filter on all of them.

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.

func (*Client) ListContainerRecipes added in v0.31.0 

func (c *Client) ListContainerRecipes(ctx context.Context, params *ListContainerRecipesInput, optFns ...func(*Options)) (*ListContainerRecipesOutput, error)

Returns a list of container recipes.

func (*Client) ListDistributionConfigurations 

func (c *Client) ListDistributionConfigurations(ctx context.Context, params *ListDistributionConfigurationsInput, optFns ...func(*Options)) (*ListDistributionConfigurationsOutput, error)

Returns a list of distribution configurations.

func (*Client) ListImageBuildVersions 

func (c *Client) ListImageBuildVersions(ctx context.Context, params *ListImageBuildVersionsInput, optFns ...func(*Options)) (*ListImageBuildVersionsOutput, error)

Returns a list of image build versions.

func (*Client) ListImagePackages added in v1.2.0 

func (c *Client) ListImagePackages(ctx context.Context, params *ListImagePackagesInput, optFns ...func(*Options)) (*ListImagePackagesOutput, error)

List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.

func (*Client) ListImagePipelineImages 

func (c *Client) ListImagePipelineImages(ctx context.Context, params *ListImagePipelineImagesInput, optFns ...func(*Options)) (*ListImagePipelineImagesOutput, error)

Returns a list of images created by the specified pipeline.

func (*Client) ListImagePipelines 

func (c *Client) ListImagePipelines(ctx context.Context, params *ListImagePipelinesInput, optFns ...func(*Options)) (*ListImagePipelinesOutput, error)

Returns a list of image pipelines.

func (*Client) ListImageRecipes 

func (c *Client) ListImageRecipes(ctx context.Context, params *ListImageRecipesInput, optFns ...func(*Options)) (*ListImageRecipesOutput, error)

Returns a list of image recipes.

func (*Client) ListImageScanFindingAggregations added in v1.23.0 

func (c *Client) ListImageScanFindingAggregations(ctx context.Context, params *ListImageScanFindingAggregationsInput, optFns ...func(*Options)) (*ListImageScanFindingAggregationsOutput, error)

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

func (*Client) ListImageScanFindings added in v1.23.0 

func (c *Client) ListImageScanFindings(ctx context.Context, params *ListImageScanFindingsInput, optFns ...func(*Options)) (*ListImageScanFindingsOutput, error)

Returns a list of image scan findings for your account.

func (*Client) ListImages 

func (c *Client) ListImages(ctx context.Context, params *ListImagesInput, optFns ...func(*Options)) (*ListImagesOutput, error)

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.

func (*Client) ListInfrastructureConfigurations 

func (c *Client) ListInfrastructureConfigurations(ctx context.Context, params *ListInfrastructureConfigurationsInput, optFns ...func(*Options)) (*ListInfrastructureConfigurationsOutput, error)

Returns a list of infrastructure configurations.

func (*Client) ListLifecycleExecutionResources added in v1.28.0 

func (c *Client) ListLifecycleExecutionResources(ctx context.Context, params *ListLifecycleExecutionResourcesInput, optFns ...func(*Options)) (*ListLifecycleExecutionResourcesOutput, error)

List resources that the runtime instance of the image lifecycle identified for lifecycle actions.

func (*Client) ListLifecycleExecutions added in v1.28.0 

func (c *Client) ListLifecycleExecutions(ctx context.Context, params *ListLifecycleExecutionsInput, optFns ...func(*Options)) (*ListLifecycleExecutionsOutput, error)

Get the lifecycle runtime history for the specified resource.

func (*Client) ListLifecyclePolicies added in v1.28.0 

func (c *Client) ListLifecyclePolicies(ctx context.Context, params *ListLifecyclePoliciesInput, optFns ...func(*Options)) (*ListLifecyclePoliciesOutput, error)

Get a list of lifecycle policies in your Amazon Web Services account.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Returns the list of tags for the specified resource.

func (*Client) ListWaitingWorkflowSteps added in v1.30.0 

func (c *Client) ListWaitingWorkflowSteps(ctx context.Context, params *ListWaitingWorkflowStepsInput, optFns ...func(*Options)) (*ListWaitingWorkflowStepsOutput, error)

Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.

func (*Client) ListWorkflowBuildVersions added in v1.30.0 

func (c *Client) ListWorkflowBuildVersions(ctx context.Context, params *ListWorkflowBuildVersionsInput, optFns ...func(*Options)) (*ListWorkflowBuildVersionsOutput, error)

Returns a list of build versions for a specific workflow resource.

func (*Client) ListWorkflowExecutions added in v1.23.0 

func (c *Client) ListWorkflowExecutions(ctx context.Context, params *ListWorkflowExecutionsInput, optFns ...func(*Options)) (*ListWorkflowExecutionsOutput, error)

Returns a list of workflow runtime instance metadata objects for a specific image build version.

func (*Client) ListWorkflowStepExecutions added in v1.23.0 

func (c *Client) ListWorkflowStepExecutions(ctx context.Context, params *ListWorkflowStepExecutionsInput, optFns ...func(*Options)) (*ListWorkflowStepExecutionsOutput, error)

Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.

func (*Client) ListWorkflows added in v1.30.0 

func (c *Client) ListWorkflows(ctx context.Context, params *ListWorkflowsInput, optFns ...func(*Options)) (*ListWorkflowsOutput, error)

Lists workflow build versions based on filtering parameters.

func (*Client) Options added in v1.29.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutComponentPolicy 

func (c *Client) PutComponentPolicy(ctx context.Context, params *PutComponentPolicyInput, optFns ...func(*Options)) (*PutComponentPolicyOutput, error)

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 PromoteResourceShareCreatedFromPolicyin order for the resource to be visible to all principals with whom the resource is shared.

func (*Client) PutContainerRecipePolicy added in v0.31.0 

func (c *Client) PutContainerRecipePolicy(ctx context.Context, params *PutContainerRecipePolicyInput, optFns ...func(*Options)) (*PutContainerRecipePolicyOutput, error)

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.

func (*Client) PutImagePolicy 

func (c *Client) PutImagePolicy(ctx context.Context, params *PutImagePolicyInput, optFns ...func(*Options)) (*PutImagePolicyOutput, error)

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 PromoteResourceShareCreatedFromPolicyin order for the resource to be visible to all principals with whom the resource is shared.

func (*Client) PutImageRecipePolicy 

func (c *Client) PutImageRecipePolicy(ctx context.Context, params *PutImageRecipePolicyInput, optFns ...func(*Options)) (*PutImageRecipePolicyOutput, error)

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 PromoteResourceShareCreatedFromPolicyin order for the resource to be visible to all principals with whom the resource is shared.

func (*Client) SendWorkflowStepAction added in v1.30.0 

func (c *Client) SendWorkflowStepAction(ctx context.Context, params *SendWorkflowStepActionInput, optFns ...func(*Options)) (*SendWorkflowStepActionOutput, error)

Pauses or resumes image creation when the associated workflow runs a WaitForAction step.

func (*Client) StartImagePipelineExecution 

func (c *Client) StartImagePipelineExecution(ctx context.Context, params *StartImagePipelineExecutionInput, optFns ...func(*Options)) (*StartImagePipelineExecutionOutput, error)

Manually triggers a pipeline to create an image.

func (*Client) StartResourceStateUpdate added in v1.28.0 

func (c *Client) StartResourceStateUpdate(ctx context.Context, params *StartResourceStateUpdateInput, optFns ...func(*Options)) (*StartResourceStateUpdateOutput, error)

Begin asynchronous resource state update for lifecycle changes to the specified image resources.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds a tag to a resource.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes a tag from a resource.

func (*Client) UpdateDistributionConfiguration 

func (c *Client) UpdateDistributionConfiguration(ctx context.Context, params *UpdateDistributionConfigurationInput, optFns ...func(*Options)) (*UpdateDistributionConfigurationOutput, error)

Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.

func (*Client) UpdateImagePipeline 

func (c *Client) UpdateImagePipeline(ctx context.Context, params *UpdateImagePipelineInput, optFns ...func(*Options)) (*UpdateImagePipelineOutput, error)

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 .

UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed.

func (*Client) UpdateInfrastructureConfiguration 

func (c *Client) UpdateInfrastructureConfiguration(ctx context.Context, params *UpdateInfrastructureConfigurationInput, optFns ...func(*Options)) (*UpdateInfrastructureConfigurationOutput, error)

Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

func (*Client) UpdateLifecyclePolicy added in v1.28.0 

func (c *Client) UpdateLifecyclePolicy(ctx context.Context, params *UpdateLifecyclePolicyInput, optFns ...func(*Options)) (*UpdateLifecyclePolicyOutput, error)

Update the specified lifecycle policy.

type CreateComponentInput 

type CreateComponentInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The name of the component.
	//
	// This member is required.
	Name *string

	// The operating system platform of the component.
	//
	// This member is required.
	Platform types.Platform

	// The semantic version of the component. This version follows the semantic
	// version syntax.
	//
	// The semantic version has four nodes: ../. You can assign values for the first
	// three, and can filter on all of them.
	//
	// Assignment: For the first three nodes you can assign any positive integer
	// value, including zero, with an upper limit of 2^30-1, or 1073741823 for each
	// node. Image Builder automatically assigns the build number to the fourth node.
	//
	// Patterns: You can use any numeric pattern that adheres to the assignment
	// requirements for the nodes that you can assign. For example, you might choose a
	// software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
	//
	// This member is required.
	SemanticVersion *string

	// The change description of the component. Describes what change has been made in
	// this version, or what makes this version different from other versions of the
	// component.
	ChangeDescription *string

	// Component data contains inline YAML document content for the component.
	// Alternatively, you can specify the uri of a YAML document file stored in Amazon
	// S3. However, you cannot specify both properties.
	Data *string

	// Describes the contents of the component.
	Description *string

	// The ID of the KMS key that is used to encrypt this component.
	KmsKeyId *string

	// The operating system (OS) version supported by the component. If the OS
	// information is available, a prefix match is performed against the base image OS
	// version during image recipe creation.
	SupportedOsVersions []string

	// The tags that apply to the component.
	Tags map[string]string

	// The uri of a YAML component document file. This must be an S3 URL (
	// s3://bucket/key ), and the requester must have permission to access the S3
	// bucket it points to. If you use Amazon S3, you can specify component content up
	// to your service quota.
	//
	// Alternatively, you can specify the YAML document inline, using the component
	// data property. You cannot specify both properties.
	Uri *string
	// contains filtered or unexported fields
}

type CreateComponentOutput 

type CreateComponentOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the component that the request created.
	ComponentBuildVersionArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateContainerRecipeInput added in v0.31.0 

type CreateContainerRecipeInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// Components for build and test that are included in the container recipe.
	// Recipes require a minimum of one build component, and can have a maximum of 20
	// build and test components in any combination.
	//
	// This member is required.
	Components []types.ComponentConfiguration

	// The type of container to create.
	//
	// This member is required.
	ContainerType types.ContainerType

	// The name of the container recipe.
	//
	// This member is required.
	Name *string

	// The base image for the container recipe.
	//
	// This member is required.
	ParentImage *string

	// The semantic version of the container recipe. This version follows the semantic
	// version syntax.
	//
	// The semantic version has four nodes: ../. You can assign values for the first
	// three, and can filter on all of them.
	//
	// Assignment: For the first three nodes you can assign any positive integer
	// value, including zero, with an upper limit of 2^30-1, or 1073741823 for each
	// node. Image Builder automatically assigns the build number to the fourth node.
	//
	// Patterns: You can use any numeric pattern that adheres to the assignment
	// requirements for the nodes that you can assign. For example, you might choose a
	// software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
	//
	// This member is required.
	SemanticVersion *string

	// The destination repository for the container image.
	//
	// This member is required.
	TargetRepository *types.TargetContainerRepository

	// The description of the container recipe.
	Description *string

	// The Dockerfile template used to build your image as an inline data blob.
	DockerfileTemplateData *string

	// The Amazon S3 URI for the Dockerfile that will be used to build your container
	// image.
	DockerfileTemplateUri *string

	// Specifies the operating system version for the base image.
	ImageOsVersionOverride *string

	// A group of options that can be used to configure an instance for building and
	// testing container images.
	InstanceConfiguration *types.InstanceConfiguration

	// Identifies which KMS key is used to encrypt the container image.
	KmsKeyId *string

	// Specifies the operating system platform when you use a custom base image.
	PlatformOverride types.Platform

	// Tags that are attached to the container recipe.
	Tags map[string]string

	// The working directory for use during build and test workflows.
	WorkingDirectory *string
	// contains filtered or unexported fields
}

type CreateContainerRecipeOutput added in v0.31.0 

type CreateContainerRecipeOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// Returns the Amazon Resource Name (ARN) of the container recipe that the request
	// created.
	ContainerRecipeArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDistributionConfigurationInput 

type CreateDistributionConfigurationInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The distributions of the distribution configuration.
	//
	// This member is required.
	Distributions []types.Distribution

	// The name of the distribution configuration.
	//
	// This member is required.
	Name *string

	// The description of the distribution configuration.
	Description *string

	// The tags of the distribution configuration.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateDistributionConfigurationOutput 

type CreateDistributionConfigurationOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the distribution configuration that was
	// created by this request.
	DistributionConfigurationArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateImageInput 

type CreateImageInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the infrastructure configuration that defines
	// the environment in which your image will be built and tested.
	//
	// This member is required.
	InfrastructureConfigurationArn *string

	// The Amazon Resource Name (ARN) of the container recipe that defines how images
	// are configured and tested.
	ContainerRecipeArn *string

	// The Amazon Resource Name (ARN) of the distribution configuration that defines
	// and configures the outputs of your pipeline.
	DistributionConfigurationArn *string

	// Collects additional information about the image being created, including the
	// operating system (OS) version and package list. This information is used to
	// enhance the overall experience of using EC2 Image Builder. Enabled by default.
	EnhancedImageMetadataEnabled *bool

	// The name or Amazon Resource Name (ARN) for the IAM role you create that grants
	// Image Builder access to perform workflow actions.
	ExecutionRole *string

	// The Amazon Resource Name (ARN) of the image recipe that defines how images are
	// configured, tested, and assessed.
	ImageRecipeArn *string

	// Contains settings for vulnerability scans.
	ImageScanningConfiguration *types.ImageScanningConfiguration

	// The image tests configuration of the image.
	ImageTestsConfiguration *types.ImageTestsConfiguration

	// The tags of the image.
	Tags map[string]string

	// Contains an array of workflow configuration objects.
	Workflows []types.WorkflowConfiguration
	// contains filtered or unexported fields
}

type CreateImageOutput 

type CreateImageOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image that the request created.
	ImageBuildVersionArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateImagePipelineInput 

type CreateImagePipelineInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the infrastructure configuration that will be
	// used to build images created by this image pipeline.
	//
	// This member is required.
	InfrastructureConfigurationArn *string

	// The name of the image pipeline.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the container recipe that is used to
	// configure images created by this container pipeline.
	ContainerRecipeArn *string

	// The description of the image pipeline.
	Description *string

	// The Amazon Resource Name (ARN) of the distribution configuration that will be
	// used to configure and distribute images created by this image pipeline.
	DistributionConfigurationArn *string

	// Collects additional information about the image being created, including the
	// operating system (OS) version and package list. This information is used to
	// enhance the overall experience of using EC2 Image Builder. Enabled by default.
	EnhancedImageMetadataEnabled *bool

	// The name or Amazon Resource Name (ARN) for the IAM role you create that grants
	// Image Builder access to perform workflow actions.
	ExecutionRole *string

	// The Amazon Resource Name (ARN) of the image recipe that will be used to
	// configure images created by this image pipeline.
	ImageRecipeArn *string

	// Contains settings for vulnerability scans.
	ImageScanningConfiguration *types.ImageScanningConfiguration

	// The image test configuration of the image pipeline.
	ImageTestsConfiguration *types.ImageTestsConfiguration

	// The schedule of the image pipeline.
	Schedule *types.Schedule

	// The status of the image pipeline.
	Status types.PipelineStatus

	// The tags of the image pipeline.
	Tags map[string]string

	// Contains an array of workflow configuration objects.
	Workflows []types.WorkflowConfiguration
	// contains filtered or unexported fields
}

type CreateImagePipelineOutput 

type CreateImagePipelineOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image pipeline that was created by this
	// request.
	ImagePipelineArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateImageRecipeInput 

type CreateImageRecipeInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The components included in the image recipe.
	//
	// This member is required.
	Components []types.ComponentConfiguration

	// The name of the image recipe.
	//
	// This member is required.
	Name *string

	// The base image of the image recipe. The value of the string can be the ARN of
	// the base image or an AMI ID. The format for the ARN follows this example:
	// arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x
	// . You can provide the specific version that you want to use, or you can use a
	// wildcard in all of the fields. If you enter an AMI ID for the string value, you
	// must have access to the AMI, and the AMI must be in the same Region in which you
	// are using Image Builder.
	//
	// This member is required.
	ParentImage *string

	// The semantic version of the image recipe. This version follows the semantic
	// version syntax.
	//
	// The semantic version has four nodes: ../. You can assign values for the first
	// three, and can filter on all of them.
	//
	// Assignment: For the first three nodes you can assign any positive integer
	// value, including zero, with an upper limit of 2^30-1, or 1073741823 for each
	// node. Image Builder automatically assigns the build number to the fourth node.
	//
	// Patterns: You can use any numeric pattern that adheres to the assignment
	// requirements for the nodes that you can assign. For example, you might choose a
	// software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
	//
	// This member is required.
	SemanticVersion *string

	// Specify additional settings and launch scripts for your build instances.
	AdditionalInstanceConfiguration *types.AdditionalInstanceConfiguration

	// The block device mappings of the image recipe.
	BlockDeviceMappings []types.InstanceBlockDeviceMapping

	// The description of the image recipe.
	Description *string

	// The tags of the image recipe.
	Tags map[string]string

	// The working directory used during build and test workflows.
	WorkingDirectory *string
	// contains filtered or unexported fields
}

type CreateImageRecipeOutput 

type CreateImageRecipeOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image recipe that was created by this
	// request.
	ImageRecipeArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateInfrastructureConfigurationInput 

type CreateInfrastructureConfigurationInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The instance profile to associate with the instance used to customize your
	// Amazon EC2 AMI.
	//
	// This member is required.
	InstanceProfileName *string

	// The name of the infrastructure configuration.
	//
	// This member is required.
	Name *string

	// The description of the infrastructure configuration.
	Description *string

	// The instance metadata options that you can set for the HTTP requests that
	// pipeline builds use to launch EC2 build and test instances.
	InstanceMetadataOptions *types.InstanceMetadataOptions

	// The instance types of the infrastructure configuration. You can specify one or
	// more instance types to use for this build. The service will pick one of these
	// instance types based on availability.
	InstanceTypes []string

	// The key pair of the infrastructure configuration. You can use this to log on to
	// and debug the instance used to create your image.
	KeyPair *string

	// The logging configuration of the infrastructure configuration.
	Logging *types.Logging

	// The tags attached to the resource created by Image Builder.
	ResourceTags map[string]string

	// The security group IDs to associate with the instance used to customize your
	// Amazon EC2 AMI.
	SecurityGroupIds []string

	// The Amazon Resource Name (ARN) for the SNS topic to which we send image build
	// event notifications.
	//
	// EC2 Image Builder is unable to send notifications to SNS topics that are
	// encrypted using keys from other accounts. The key that is used to encrypt the
	// SNS topic must reside in the account that the Image Builder service runs under.
	SnsTopicArn *string

	// The subnet ID in which to place the instance used to customize your Amazon EC2
	// AMI.
	SubnetId *string

	// The tags of the infrastructure configuration.
	Tags map[string]string

	// The terminate instance on failure setting of the infrastructure configuration.
	// Set to false if you want Image Builder to retain the instance used to configure
	// your AMI if the build or test phase of your workflow fails.
	TerminateInstanceOnFailure *bool
	// contains filtered or unexported fields
}

type CreateInfrastructureConfigurationOutput 

type CreateInfrastructureConfigurationOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the infrastructure configuration that was
	// created by this request.
	InfrastructureConfigurationArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLifecyclePolicyInput added in v1.28.0 

type CreateLifecyclePolicyInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The name or Amazon Resource Name (ARN) for the IAM role you create that grants
	// Image Builder access to run lifecycle actions.
	//
	// This member is required.
	ExecutionRole *string

	// The name of the lifecycle policy to create.
	//
	// This member is required.
	Name *string

	// Configuration details for the lifecycle policy rules.
	//
	// This member is required.
	PolicyDetails []types.LifecyclePolicyDetail

	// Selection criteria for the resources that the lifecycle policy applies to.
	//
	// This member is required.
	ResourceSelection *types.LifecyclePolicyResourceSelection

	// The type of Image Builder resource that the lifecycle policy applies to.
	//
	// This member is required.
	ResourceType types.LifecyclePolicyResourceType

	// Optional description for the lifecycle policy.
	Description *string

	// Indicates whether the lifecycle policy resource is enabled.
	Status types.LifecyclePolicyStatus

	// Tags to apply to the lifecycle policy resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateLifecyclePolicyOutput added in v1.28.0 

type CreateLifecyclePolicyOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the lifecycle policy that the request created.
	LifecyclePolicyArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateWorkflowInput added in v1.30.0 

type CreateWorkflowInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The name of the workflow to create.
	//
	// This member is required.
	Name *string

	// The semantic version of this workflow resource. The semantic version syntax
	// adheres to the following rules.
	//
	// The semantic version has four nodes: ../. You can assign values for the first
	// three, and can filter on all of them.
	//
	// Assignment: For the first three nodes you can assign any positive integer
	// value, including zero, with an upper limit of 2^30-1, or 1073741823 for each
	// node. Image Builder automatically assigns the build number to the fourth node.
	//
	// Patterns: You can use any numeric pattern that adheres to the assignment
	// requirements for the nodes that you can assign. For example, you might choose a
	// software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
	//
	// This member is required.
	SemanticVersion *string

	// The phase in the image build process for which the workflow resource is
	// responsible.
	//
	// This member is required.
	Type types.WorkflowType

	// Describes what change has been made in this version of the workflow, or what
	// makes this version different from other versions of the workflow.
	ChangeDescription *string

	// Contains the UTF-8 encoded YAML document content for the workflow.
	// Alternatively, you can specify the uri of a YAML document file stored in Amazon
	// S3. However, you cannot specify both properties.
	Data *string

	// Describes the workflow.
	Description *string

	// The ID of the KMS key that is used to encrypt this workflow resource.
	KmsKeyId *string

	// Tags that apply to the workflow resource.
	Tags map[string]string

	// The uri of a YAML component document file. This must be an S3 URL (
	// s3://bucket/key ), and the requester must have permission to access the S3
	// bucket it points to. If you use Amazon S3, you can specify component content up
	// to your service quota.
	//
	// Alternatively, you can specify the YAML document inline, using the component
	// data property. You cannot specify both properties.
	Uri *string
	// contains filtered or unexported fields
}

type CreateWorkflowOutput added in v1.30.0 

type CreateWorkflowOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the workflow resource that the request
	// created.
	WorkflowBuildVersionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteComponentInput 

type DeleteComponentInput struct {

	// The Amazon Resource Name (ARN) of the component build version to delete.
	//
	// This member is required.
	ComponentBuildVersionArn *string
	// contains filtered or unexported fields
}

type DeleteComponentOutput 

type DeleteComponentOutput struct {

	// The ARN of the component build version that this request deleted.
	ComponentBuildVersionArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteContainerRecipeInput added in v0.31.0 

type DeleteContainerRecipeInput struct {

	// The Amazon Resource Name (ARN) of the container recipe to delete.
	//
	// This member is required.
	ContainerRecipeArn *string
	// contains filtered or unexported fields
}

type DeleteContainerRecipeOutput added in v0.31.0 

type DeleteContainerRecipeOutput struct {

	// The Amazon Resource Name (ARN) of the container recipe that was deleted.
	ContainerRecipeArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDistributionConfigurationInput 

type DeleteDistributionConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the distribution configuration to delete.
	//
	// This member is required.
	DistributionConfigurationArn *string
	// contains filtered or unexported fields
}

type DeleteDistributionConfigurationOutput 

type DeleteDistributionConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the distribution configuration that was
	// deleted.
	DistributionConfigurationArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteImageInput 

type DeleteImageInput struct {

	// The Amazon Resource Name (ARN) of the Image Builder image resource to delete.
	//
	// This member is required.
	ImageBuildVersionArn *string
	// contains filtered or unexported fields
}

type DeleteImageOutput 

type DeleteImageOutput struct {

	// The ARN of the Image Builder image resource that this request deleted.
	ImageBuildVersionArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteImagePipelineInput 

type DeleteImagePipelineInput struct {

	// The Amazon Resource Name (ARN) of the image pipeline to delete.
	//
	// This member is required.
	ImagePipelineArn *string
	// contains filtered or unexported fields
}

type DeleteImagePipelineOutput 

type DeleteImagePipelineOutput struct {

	// The Amazon Resource Name (ARN) of the image pipeline that was deleted.
	ImagePipelineArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteImageRecipeInput 

type DeleteImageRecipeInput struct {

	// The Amazon Resource Name (ARN) of the image recipe to delete.
	//
	// This member is required.
	ImageRecipeArn *string
	// contains filtered or unexported fields
}

type DeleteImageRecipeOutput 

type DeleteImageRecipeOutput struct {

	// The Amazon Resource Name (ARN) of the image recipe that was deleted.
	ImageRecipeArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteInfrastructureConfigurationInput 

type DeleteInfrastructureConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
	//
	// This member is required.
	InfrastructureConfigurationArn *string
	// contains filtered or unexported fields
}

type DeleteInfrastructureConfigurationOutput 

type DeleteInfrastructureConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the infrastructure configuration that was
	// deleted.
	InfrastructureConfigurationArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLifecyclePolicyInput added in v1.28.0 

type DeleteLifecyclePolicyInput struct {

	// The Amazon Resource Name (ARN) of the lifecycle policy resource to delete.
	//
	// This member is required.
	LifecyclePolicyArn *string
	// contains filtered or unexported fields
}

type DeleteLifecyclePolicyOutput added in v1.28.0 

type DeleteLifecyclePolicyOutput struct {

	// The ARN of the lifecycle policy that was deleted.
	LifecyclePolicyArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWorkflowInput added in v1.30.0 

type DeleteWorkflowInput struct {

	// The Amazon Resource Name (ARN) of the workflow resource to delete.
	//
	// This member is required.
	WorkflowBuildVersionArn *string
	// contains filtered or unexported fields
}

type DeleteWorkflowOutput added in v1.30.0 

type DeleteWorkflowOutput struct {

	// The ARN of the workflow resource that this request deleted.
	WorkflowBuildVersionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.24.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.24.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.24.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.24.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.24.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetComponentInput 

type GetComponentInput struct {

	// The Amazon Resource Name (ARN) of the component that you want to get. Regex
	// requires the suffix /\d+$ .
	//
	// This member is required.
	ComponentBuildVersionArn *string
	// contains filtered or unexported fields
}

type GetComponentOutput 

type GetComponentOutput struct {

	// The component object specified in the request.
	Component *types.Component

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetComponentPolicyInput 

type GetComponentPolicyInput struct {

	// The Amazon Resource Name (ARN) of the component whose policy you want to
	// retrieve.
	//
	// This member is required.
	ComponentArn *string
	// contains filtered or unexported fields
}

type GetComponentPolicyOutput 

type GetComponentPolicyOutput struct {

	// The component policy.
	Policy *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetContainerRecipeInput added in v0.31.0 

type GetContainerRecipeInput struct {

	// The Amazon Resource Name (ARN) of the container recipe to retrieve.
	//
	// This member is required.
	ContainerRecipeArn *string
	// contains filtered or unexported fields
}

type GetContainerRecipeOutput added in v0.31.0 

type GetContainerRecipeOutput struct {

	// The container recipe object that is returned.
	ContainerRecipe *types.ContainerRecipe

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetContainerRecipePolicyInput added in v0.31.0 

type GetContainerRecipePolicyInput struct {

	// The Amazon Resource Name (ARN) of the container recipe for the policy being
	// requested.
	//
	// This member is required.
	ContainerRecipeArn *string
	// contains filtered or unexported fields
}

type GetContainerRecipePolicyOutput added in v0.31.0 

type GetContainerRecipePolicyOutput struct {

	// The container recipe policy object that is returned.
	Policy *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetDistributionConfigurationInput 

type GetDistributionConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the distribution configuration that you want
	// to retrieve.
	//
	// This member is required.
	DistributionConfigurationArn *string
	// contains filtered or unexported fields
}

type GetDistributionConfigurationOutput 

type GetDistributionConfigurationOutput struct {

	// The distribution configuration object.
	DistributionConfiguration *types.DistributionConfiguration

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetImageInput 

type GetImageInput struct {

	// The Amazon Resource Name (ARN) of the image that you want to get.
	//
	// This member is required.
	ImageBuildVersionArn *string
	// contains filtered or unexported fields
}

type GetImageOutput 

type GetImageOutput struct {

	// The image object.
	Image *types.Image

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetImagePipelineInput 

type GetImagePipelineInput struct {

	// The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.
	//
	// This member is required.
	ImagePipelineArn *string
	// contains filtered or unexported fields
}

type GetImagePipelineOutput 

type GetImagePipelineOutput struct {

	// The image pipeline object.
	ImagePipeline *types.ImagePipeline

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetImagePolicyInput 

type GetImagePolicyInput struct {

	// The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.
	//
	// This member is required.
	ImageArn *string
	// contains filtered or unexported fields
}

type GetImagePolicyOutput 

type GetImagePolicyOutput struct {

	// The image policy object.
	Policy *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetImageRecipeInput 

type GetImageRecipeInput struct {

	// The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.
	//
	// This member is required.
	ImageRecipeArn *string
	// contains filtered or unexported fields
}

type GetImageRecipeOutput 

type GetImageRecipeOutput struct {

	// The image recipe object.
	ImageRecipe *types.ImageRecipe

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetImageRecipePolicyInput 

type GetImageRecipePolicyInput struct {

	// The Amazon Resource Name (ARN) of the image recipe whose policy you want to
	// retrieve.
	//
	// This member is required.
	ImageRecipeArn *string
	// contains filtered or unexported fields
}

type GetImageRecipePolicyOutput 

type GetImageRecipePolicyOutput struct {

	// The image recipe policy object.
	Policy *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetInfrastructureConfigurationInput 

type GetInfrastructureConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the infrastructure configuration that you
	// want to retrieve.
	//
	// This member is required.
	InfrastructureConfigurationArn *string
	// contains filtered or unexported fields
}

GetInfrastructureConfiguration request object.

type GetInfrastructureConfigurationOutput 

type GetInfrastructureConfigurationOutput struct {

	// The infrastructure configuration object.
	InfrastructureConfiguration *types.InfrastructureConfiguration

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

GetInfrastructureConfiguration response object.

type GetLifecycleExecutionInput added in v1.28.0 

type GetLifecycleExecutionInput struct {

	// Use the unique identifier for a runtime instance of the lifecycle policy to get
	// runtime details.
	//
	// This member is required.
	LifecycleExecutionId *string
	// contains filtered or unexported fields
}

type GetLifecycleExecutionOutput added in v1.28.0 

type GetLifecycleExecutionOutput struct {

	// Runtime details for the specified runtime instance of the lifecycle policy.
	LifecycleExecution *types.LifecycleExecution

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetLifecyclePolicyInput added in v1.28.0 

type GetLifecyclePolicyInput struct {

	// Specifies the Amazon Resource Name (ARN) of the image lifecycle policy resource
	// to get.
	//
	// This member is required.
	LifecyclePolicyArn *string
	// contains filtered or unexported fields
}

type GetLifecyclePolicyOutput added in v1.28.0 

type GetLifecyclePolicyOutput struct {

	// The ARN of the image lifecycle policy resource that was returned.
	LifecyclePolicy *types.LifecyclePolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWorkflowExecutionInput added in v1.23.0 

type GetWorkflowExecutionInput struct {

	// Use the unique identifier for a runtime instance of the workflow to get runtime
	// details.
	//
	// This member is required.
	WorkflowExecutionId *string
	// contains filtered or unexported fields
}

type GetWorkflowExecutionOutput added in v1.23.0 

type GetWorkflowExecutionOutput struct {

	// The timestamp when the specified runtime instance of the workflow finished.
	EndTime *string

	// The Amazon Resource Name (ARN) of the image resource build version that the
	// specified runtime instance of the workflow created.
	ImageBuildVersionArn *string

	// The output message from the specified runtime instance of the workflow, if
	// applicable.
	Message *string

	// Test workflows are defined within named runtime groups. The parallel group is a
	// named group that contains one or more test workflows.
	ParallelGroup *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// The timestamp when the specified runtime instance of the workflow started.
	StartTime *string

	// The current runtime status for the specified runtime instance of the workflow.
	Status types.WorkflowExecutionStatus

	// The total number of steps in the specified runtime instance of the workflow
	// that ran. This number should equal the sum of the step counts for steps that
	// succeeded, were skipped, and failed.
	TotalStepCount int32

	// A runtime count for the number of steps that failed in the specified runtime
	// instance of the workflow.
	TotalStepsFailed int32

	// A runtime count for the number of steps that were skipped in the specified
	// runtime instance of the workflow.
	TotalStepsSkipped int32

	// A runtime count for the number of steps that ran successfully in the specified
	// runtime instance of the workflow.
	TotalStepsSucceeded int32

	// The type of workflow that Image Builder ran for the specified runtime instance
	// of the workflow.
	Type types.WorkflowType

	// The Amazon Resource Name (ARN) of the build version for the Image Builder
	// workflow resource that defines the specified runtime instance of the workflow.
	WorkflowBuildVersionArn *string

	// The unique identifier that Image Builder assigned to keep track of runtime
	// details when it ran the workflow.
	WorkflowExecutionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWorkflowInput added in v1.30.0 

type GetWorkflowInput struct {

	// The Amazon Resource Name (ARN) of the workflow resource that you want to get.
	//
	// This member is required.
	WorkflowBuildVersionArn *string
	// contains filtered or unexported fields
}

type GetWorkflowOutput added in v1.30.0 

type GetWorkflowOutput struct {

	// The workflow resource specified in the request.
	Workflow *types.Workflow

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWorkflowStepExecutionInput added in v1.23.0 

type GetWorkflowStepExecutionInput struct {

	// Use the unique identifier for a specific runtime instance of the workflow step
	// to get runtime details for that step.
	//
	// This member is required.
	StepExecutionId *string
	// contains filtered or unexported fields
}

type GetWorkflowStepExecutionOutput added in v1.23.0 

type GetWorkflowStepExecutionOutput struct {

	// The name of the action that the specified step performs.
	Action *string

	// Describes the specified workflow step.
	Description *string

	// The timestamp when the specified runtime instance of the workflow step finished.
	EndTime *string

	// The Amazon Resource Name (ARN) of the image resource build version that the
	// specified runtime instance of the workflow step creates.
	ImageBuildVersionArn *string

	// Input parameters that Image Builder provided for the specified runtime instance
	// of the workflow step.
	Inputs *string

	// The output message from the specified runtime instance of the workflow step, if
	// applicable.
	Message *string

	// The name of the specified runtime instance of the workflow step.
	Name *string

	// The action to perform if the workflow step fails.
	OnFailure *string

	// The file names that the specified runtime version of the workflow step created
	// as output.
	Outputs *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Reports on the rollback status of the specified runtime version of the workflow
	// step, if applicable.
	RollbackStatus types.WorkflowStepExecutionRollbackStatus

	// The timestamp when the specified runtime version of the workflow step started.
	StartTime *string

	// The current status for the specified runtime version of the workflow step.
	Status types.WorkflowStepExecutionStatus

	// The unique identifier for the runtime version of the workflow step that you
	// specified in the request.
	StepExecutionId *string

	// The maximum duration in seconds for this step to complete its action.
	TimeoutSeconds *int32

	// The Amazon Resource Name (ARN) of the build version for the Image Builder
	// workflow resource that defines this workflow step.
	WorkflowBuildVersionArn *string

	// The unique identifier that Image Builder assigned to keep track of runtime
	// details when it ran the workflow.
	WorkflowExecutionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ImportComponentInput 

type ImportComponentInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The format of the resource that you want to import as a component.
	//
	// This member is required.
	Format types.ComponentFormat

	// The name of the component.
	//
	// This member is required.
	Name *string

	// The platform of the component.
	//
	// This member is required.
	Platform types.Platform

	// The semantic version of the component. This version follows the semantic
	// version syntax.
	//
	// The semantic version has four nodes: ../. You can assign values for the first
	// three, and can filter on all of them.
	//
	// 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.
	//
	// This member is required.
	SemanticVersion *string

	// The type of the component denotes whether the component is used to build the
	// image, or only to test it.
	//
	// This member is required.
	Type types.ComponentType

	// The change description of the component. This description indicates the change
	// that has been made in this version, or what makes this version different from
	// other versions of the component.
	ChangeDescription *string

	// The data of the component. Used to specify the data inline. Either data or uri
	// can be used to specify the data within the component.
	Data *string

	// The description of the component. Describes the contents of the component.
	Description *string

	// The ID of the KMS key that should be used to encrypt this component.
	KmsKeyId *string

	// The tags of the component.
	Tags map[string]string

	// The uri of the component. Must be an Amazon S3 URL and the requester must have
	// permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify
	// component content up to your service quota. Either data or uri can be used to
	// specify the data within the component.
	Uri *string
	// contains filtered or unexported fields
}

type ImportComponentOutput 

type ImportComponentOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the imported component.
	ComponentBuildVersionArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ImportVmImageInput added in v1.15.0 

type ImportVmImageInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The name of the base image that is created by the import process.
	//
	// This member is required.
	Name *string

	// The operating system platform for the imported VM.
	//
	// This member is required.
	Platform types.Platform

	// The semantic version to attach to the base image that was created during the
	// import process. This version follows the semantic version syntax.
	//
	// The semantic version has four nodes: ../. You can assign values for the first
	// three, and can filter on all of them.
	//
	// Assignment: For the first three nodes you can assign any positive integer
	// value, including zero, with an upper limit of 2^30-1, or 1073741823 for each
	// node. Image Builder automatically assigns the build number to the fourth node.
	//
	// Patterns: You can use any numeric pattern that adheres to the assignment
	// requirements for the nodes that you can assign. For example, you might choose a
	// software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
	//
	// This member is required.
	SemanticVersion *string

	// The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import
	// process. Image Builder retrieves information from the import process to pull in
	// the AMI that is created from the VM source as the base image for your recipe.
	//
	// This member is required.
	VmImportTaskId *string

	// The description for the base image that is created by the import process.
	Description *string

	// The operating system version for the imported VM.
	OsVersion *string

	// Tags that are attached to the import resources.
	Tags map[string]string
	// contains filtered or unexported fields
}

type ImportVmImageOutput added in v1.15.0 

type ImportVmImageOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the AMI that was created during the VM import
	// process. This AMI is used as the base image for the recipe that imported the VM.
	ImageArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListComponentBuildVersionsAPIClient added in v0.30.0 

type ListComponentBuildVersionsAPIClient interface {
	ListComponentBuildVersions(context.Context, *ListComponentBuildVersionsInput, ...func(*Options)) (*ListComponentBuildVersionsOutput, error)
}

ListComponentBuildVersionsAPIClient is a client that implements the ListComponentBuildVersions operation.

type ListComponentBuildVersionsInput 

type ListComponentBuildVersionsInput struct {

	// The component version Amazon Resource Name (ARN) whose versions you want to
	// list.
	//
	// This member is required.
	ComponentVersionArn *string

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListComponentBuildVersionsOutput 

type ListComponentBuildVersionsOutput struct {

	// The list of component summaries for the specified semantic version.
	ComponentSummaryList []types.ComponentSummary

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListComponentBuildVersionsPaginator added in v0.30.0 

type ListComponentBuildVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListComponentBuildVersionsPaginator is a paginator for ListComponentBuildVersions

func NewListComponentBuildVersionsPaginator added in v0.30.0 

func NewListComponentBuildVersionsPaginator(client ListComponentBuildVersionsAPIClient, params *ListComponentBuildVersionsInput, optFns ...func(*ListComponentBuildVersionsPaginatorOptions)) *ListComponentBuildVersionsPaginator

NewListComponentBuildVersionsPaginator returns a new ListComponentBuildVersionsPaginator

func (*ListComponentBuildVersionsPaginator) HasMorePages added in v0.30.0 

func (p *ListComponentBuildVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListComponentBuildVersionsPaginator) NextPage added in v0.30.0 

func (p *ListComponentBuildVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListComponentBuildVersionsOutput, error)

NextPage retrieves the next ListComponentBuildVersions page.

type ListComponentBuildVersionsPaginatorOptions added in v0.30.0 

type ListComponentBuildVersionsPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListComponentBuildVersionsPaginatorOptions is the paginator options for ListComponentBuildVersions

type ListComponentsAPIClient added in v0.30.0 

type ListComponentsAPIClient interface {
	ListComponents(context.Context, *ListComponentsInput, ...func(*Options)) (*ListComponentsOutput, error)
}

ListComponentsAPIClient is a client that implements the ListComponents operation.

type ListComponentsInput 

type ListComponentsInput struct {

	// Returns the list of components for the specified name.
	ByName bool

	// Use the following filters to streamline results:
	//
	//   - description
	//
	//   - name
	//
	//   - platform
	//
	//   - supportedOsVersion
	//
	//   - type
	//
	//   - version
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string

	// Filters results based on the type of owner for the component. By default, this
	// request returns a list of components that your account owns. To see results for
	// other types of owners, you can specify components that Amazon manages, third
	// party components, or components that other accounts have shared with you.
	Owner types.Ownership
	// contains filtered or unexported fields
}

type ListComponentsOutput 

type ListComponentsOutput struct {

	// The list of component semantic versions.
	//
	// The semantic version has four nodes: ../. You can assign values for the first
	// three, and can filter on all of them.
	ComponentVersionList []types.ComponentVersion

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListComponentsPaginator added in v0.30.0 

type ListComponentsPaginator struct {
	// contains filtered or unexported fields
}

ListComponentsPaginator is a paginator for ListComponents

func NewListComponentsPaginator added in v0.30.0 

func NewListComponentsPaginator(client ListComponentsAPIClient, params *ListComponentsInput, optFns ...func(*ListComponentsPaginatorOptions)) *ListComponentsPaginator

NewListComponentsPaginator returns a new ListComponentsPaginator

func (*ListComponentsPaginator) HasMorePages added in v0.30.0 

func (p *ListComponentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListComponentsPaginator) NextPage added in v0.30.0 

func (p *ListComponentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListComponentsOutput, error)

NextPage retrieves the next ListComponents page.

type ListComponentsPaginatorOptions added in v0.30.0 

type ListComponentsPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListComponentsPaginatorOptions is the paginator options for ListComponents

type ListContainerRecipesAPIClient added in v1.2.0 

type ListContainerRecipesAPIClient interface {
	ListContainerRecipes(context.Context, *ListContainerRecipesInput, ...func(*Options)) (*ListContainerRecipesOutput, error)
}

ListContainerRecipesAPIClient is a client that implements the ListContainerRecipes operation.

type ListContainerRecipesInput added in v0.31.0 

type ListContainerRecipesInput struct {

	// Use the following filters to streamline results:
	//
	//   - containerType
	//
	//   - name
	//
	//   - parentImage
	//
	//   - platform
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string

	// Returns container recipes belonging to the specified owner, that have been
	// shared with you. You can omit this field to return container recipes belonging
	// to your account.
	Owner types.Ownership
	// contains filtered or unexported fields
}

type ListContainerRecipesOutput added in v0.31.0 

type ListContainerRecipesOutput struct {

	// The list of container recipes returned for the request.
	ContainerRecipeSummaryList []types.ContainerRecipeSummary

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListContainerRecipesPaginator added in v1.2.0 

type ListContainerRecipesPaginator struct {
	// contains filtered or unexported fields
}

ListContainerRecipesPaginator is a paginator for ListContainerRecipes

func NewListContainerRecipesPaginator added in v1.2.0 

func NewListContainerRecipesPaginator(client ListContainerRecipesAPIClient, params *ListContainerRecipesInput, optFns ...func(*ListContainerRecipesPaginatorOptions)) *ListContainerRecipesPaginator

NewListContainerRecipesPaginator returns a new ListContainerRecipesPaginator

func (*ListContainerRecipesPaginator) HasMorePages added in v1.2.0 

func (p *ListContainerRecipesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListContainerRecipesPaginator) NextPage added in v1.2.0 

func (p *ListContainerRecipesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListContainerRecipesOutput, error)

NextPage retrieves the next ListContainerRecipes page.

type ListContainerRecipesPaginatorOptions added in v1.2.0 

type ListContainerRecipesPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListContainerRecipesPaginatorOptions is the paginator options for ListContainerRecipes

type ListDistributionConfigurationsAPIClient added in v0.30.0 

type ListDistributionConfigurationsAPIClient interface {
	ListDistributionConfigurations(context.Context, *ListDistributionConfigurationsInput, ...func(*Options)) (*ListDistributionConfigurationsOutput, error)
}

ListDistributionConfigurationsAPIClient is a client that implements the ListDistributionConfigurations operation.

type ListDistributionConfigurationsInput 

type ListDistributionConfigurationsInput struct {

	// You can filter on name to streamline results.
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDistributionConfigurationsOutput 

type ListDistributionConfigurationsOutput struct {

	// The list of distributions.
	DistributionConfigurationSummaryList []types.DistributionConfigurationSummary

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDistributionConfigurationsPaginator added in v0.30.0 

type ListDistributionConfigurationsPaginator struct {
	// contains filtered or unexported fields
}

ListDistributionConfigurationsPaginator is a paginator for ListDistributionConfigurations

func NewListDistributionConfigurationsPaginator added in v0.30.0 

func NewListDistributionConfigurationsPaginator(client ListDistributionConfigurationsAPIClient, params *ListDistributionConfigurationsInput, optFns ...func(*ListDistributionConfigurationsPaginatorOptions)) *ListDistributionConfigurationsPaginator

NewListDistributionConfigurationsPaginator returns a new ListDistributionConfigurationsPaginator

func (*ListDistributionConfigurationsPaginator) HasMorePages added in v0.30.0 

func (p *ListDistributionConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDistributionConfigurationsPaginator) NextPage added in v0.30.0 

func (p *ListDistributionConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDistributionConfigurationsOutput, error)

NextPage retrieves the next ListDistributionConfigurations page.

type ListDistributionConfigurationsPaginatorOptions added in v0.30.0 

type ListDistributionConfigurationsPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDistributionConfigurationsPaginatorOptions is the paginator options for ListDistributionConfigurations

type ListImageBuildVersionsAPIClient added in v0.30.0 

type ListImageBuildVersionsAPIClient interface {
	ListImageBuildVersions(context.Context, *ListImageBuildVersionsInput, ...func(*Options)) (*ListImageBuildVersionsOutput, error)
}

ListImageBuildVersionsAPIClient is a client that implements the ListImageBuildVersions operation.

type ListImageBuildVersionsInput 

type ListImageBuildVersionsInput struct {

	// The Amazon Resource Name (ARN) of the image whose build versions you want to
	// retrieve.
	//
	// This member is required.
	ImageVersionArn *string

	// Use the following filters to streamline results:
	//
	//   - name
	//
	//   - osVersion
	//
	//   - platform
	//
	//   - type
	//
	//   - version
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListImageBuildVersionsOutput 

type ListImageBuildVersionsOutput struct {

	// The list of image build versions.
	ImageSummaryList []types.ImageSummary

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListImageBuildVersionsPaginator added in v0.30.0 

type ListImageBuildVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListImageBuildVersionsPaginator is a paginator for ListImageBuildVersions

func NewListImageBuildVersionsPaginator added in v0.30.0 

func NewListImageBuildVersionsPaginator(client ListImageBuildVersionsAPIClient, params *ListImageBuildVersionsInput, optFns ...func(*ListImageBuildVersionsPaginatorOptions)) *ListImageBuildVersionsPaginator

NewListImageBuildVersionsPaginator returns a new ListImageBuildVersionsPaginator

func (*ListImageBuildVersionsPaginator) HasMorePages added in v0.30.0 

func (p *ListImageBuildVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImageBuildVersionsPaginator) NextPage added in v0.30.0 

func (p *ListImageBuildVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImageBuildVersionsOutput, error)

NextPage retrieves the next ListImageBuildVersions page.

type ListImageBuildVersionsPaginatorOptions added in v0.30.0 

type ListImageBuildVersionsPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListImageBuildVersionsPaginatorOptions is the paginator options for ListImageBuildVersions

type ListImagePackagesAPIClient added in v1.2.0 

type ListImagePackagesAPIClient interface {
	ListImagePackages(context.Context, *ListImagePackagesInput, ...func(*Options)) (*ListImagePackagesOutput, error)
}

ListImagePackagesAPIClient is a client that implements the ListImagePackages operation.

type ListImagePackagesInput added in v1.2.0 

type ListImagePackagesInput struct {

	// Filter results for the ListImagePackages request by the Image Build Version ARN
	//
	// This member is required.
	ImageBuildVersionArn *string

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListImagePackagesOutput added in v1.2.0 

type ListImagePackagesOutput struct {

	// The list of Image Packages returned in the response.
	ImagePackageList []types.ImagePackage

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListImagePackagesPaginator added in v1.2.0 

type ListImagePackagesPaginator struct {
	// contains filtered or unexported fields
}

ListImagePackagesPaginator is a paginator for ListImagePackages

func NewListImagePackagesPaginator added in v1.2.0 

func NewListImagePackagesPaginator(client ListImagePackagesAPIClient, params *ListImagePackagesInput, optFns ...func(*ListImagePackagesPaginatorOptions)) *ListImagePackagesPaginator

NewListImagePackagesPaginator returns a new ListImagePackagesPaginator

func (*ListImagePackagesPaginator) HasMorePages added in v1.2.0 

func (p *ListImagePackagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImagePackagesPaginator) NextPage added in v1.2.0 

func (p *ListImagePackagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImagePackagesOutput, error)

NextPage retrieves the next ListImagePackages page.

type ListImagePackagesPaginatorOptions added in v1.2.0 

type ListImagePackagesPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListImagePackagesPaginatorOptions is the paginator options for ListImagePackages

type ListImagePipelineImagesAPIClient added in v0.30.0 

type ListImagePipelineImagesAPIClient interface {
	ListImagePipelineImages(context.Context, *ListImagePipelineImagesInput, ...func(*Options)) (*ListImagePipelineImagesOutput, error)
}

ListImagePipelineImagesAPIClient is a client that implements the ListImagePipelineImages operation.

type ListImagePipelineImagesInput 

type ListImagePipelineImagesInput struct {

	// The Amazon Resource Name (ARN) of the image pipeline whose images you want to
	// view.
	//
	// This member is required.
	ImagePipelineArn *string

	// Use the following filters to streamline results:
	//
	//   - name
	//
	//   - version
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListImagePipelineImagesOutput 

type ListImagePipelineImagesOutput struct {

	// The list of images built by this pipeline.
	ImageSummaryList []types.ImageSummary

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListImagePipelineImagesPaginator added in v0.30.0 

type ListImagePipelineImagesPaginator struct {
	// contains filtered or unexported fields
}

ListImagePipelineImagesPaginator is a paginator for ListImagePipelineImages

func NewListImagePipelineImagesPaginator added in v0.30.0 

func NewListImagePipelineImagesPaginator(client ListImagePipelineImagesAPIClient, params *ListImagePipelineImagesInput, optFns ...func(*ListImagePipelineImagesPaginatorOptions)) *ListImagePipelineImagesPaginator

NewListImagePipelineImagesPaginator returns a new ListImagePipelineImagesPaginator

func (*ListImagePipelineImagesPaginator) HasMorePages added in v0.30.0 

func (p *ListImagePipelineImagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImagePipelineImagesPaginator) NextPage added in v0.30.0 

func (p *ListImagePipelineImagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImagePipelineImagesOutput, error)

NextPage retrieves the next ListImagePipelineImages page.

type ListImagePipelineImagesPaginatorOptions added in v0.30.0 

type ListImagePipelineImagesPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListImagePipelineImagesPaginatorOptions is the paginator options for ListImagePipelineImages

type ListImagePipelinesAPIClient added in v0.30.0 

type ListImagePipelinesAPIClient interface {
	ListImagePipelines(context.Context, *ListImagePipelinesInput, ...func(*Options)) (*ListImagePipelinesOutput, error)
}

ListImagePipelinesAPIClient is a client that implements the ListImagePipelines operation.

type ListImagePipelinesInput 

type ListImagePipelinesInput struct {

	// Use the following filters to streamline results:
	//
	//   - description
	//
	//   - distributionConfigurationArn
	//
	//   - imageRecipeArn
	//
	//   - infrastructureConfigurationArn
	//
	//   - name
	//
	//   - status
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListImagePipelinesOutput 

type ListImagePipelinesOutput struct {

	// The list of image pipelines.
	ImagePipelineList []types.ImagePipeline

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListImagePipelinesPaginator added in v0.30.0 

type ListImagePipelinesPaginator struct {
	// contains filtered or unexported fields
}

ListImagePipelinesPaginator is a paginator for ListImagePipelines

func NewListImagePipelinesPaginator added in v0.30.0 

func NewListImagePipelinesPaginator(client ListImagePipelinesAPIClient, params *ListImagePipelinesInput, optFns ...func(*ListImagePipelinesPaginatorOptions)) *ListImagePipelinesPaginator

NewListImagePipelinesPaginator returns a new ListImagePipelinesPaginator

func (*ListImagePipelinesPaginator) HasMorePages added in v0.30.0 

func (p *ListImagePipelinesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImagePipelinesPaginator) NextPage added in v0.30.0 

func (p *ListImagePipelinesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImagePipelinesOutput, error)

NextPage retrieves the next ListImagePipelines page.

type ListImagePipelinesPaginatorOptions added in v0.30.0 

type ListImagePipelinesPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListImagePipelinesPaginatorOptions is the paginator options for ListImagePipelines

type ListImageRecipesAPIClient added in v0.30.0 

type ListImageRecipesAPIClient interface {
	ListImageRecipes(context.Context, *ListImageRecipesInput, ...func(*Options)) (*ListImageRecipesOutput, error)
}

ListImageRecipesAPIClient is a client that implements the ListImageRecipes operation.

type ListImageRecipesInput 

type ListImageRecipesInput struct {

	// Use the following filters to streamline results:
	//
	//   - name
	//
	//   - parentImage
	//
	//   - platform
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string

	// The owner defines which image recipes you want to list. By default, this
	// request will only show image recipes owned by your account. You can use this
	// field to specify if you want to view image recipes owned by yourself, by Amazon,
	// or those image recipes that have been shared with you by other customers.
	Owner types.Ownership
	// contains filtered or unexported fields
}

type ListImageRecipesOutput 

type ListImageRecipesOutput struct {

	// The list of image pipelines.
	ImageRecipeSummaryList []types.ImageRecipeSummary

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListImageRecipesPaginator added in v0.30.0 

type ListImageRecipesPaginator struct {
	// contains filtered or unexported fields
}

ListImageRecipesPaginator is a paginator for ListImageRecipes

func NewListImageRecipesPaginator added in v0.30.0 

func NewListImageRecipesPaginator(client ListImageRecipesAPIClient, params *ListImageRecipesInput, optFns ...func(*ListImageRecipesPaginatorOptions)) *ListImageRecipesPaginator

NewListImageRecipesPaginator returns a new ListImageRecipesPaginator

func (*ListImageRecipesPaginator) HasMorePages added in v0.30.0 

func (p *ListImageRecipesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImageRecipesPaginator) NextPage added in v0.30.0 

func (p *ListImageRecipesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImageRecipesOutput, error)

NextPage retrieves the next ListImageRecipes page.

type ListImageRecipesPaginatorOptions added in v0.30.0 

type ListImageRecipesPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListImageRecipesPaginatorOptions is the paginator options for ListImageRecipes

type ListImageScanFindingAggregationsAPIClient added in v1.23.0 

type ListImageScanFindingAggregationsAPIClient interface {
	ListImageScanFindingAggregations(context.Context, *ListImageScanFindingAggregationsInput, ...func(*Options)) (*ListImageScanFindingAggregationsOutput, error)
}

ListImageScanFindingAggregationsAPIClient is a client that implements the ListImageScanFindingAggregations operation.

type ListImageScanFindingAggregationsInput added in v1.23.0 

type ListImageScanFindingAggregationsInput struct {

	// A filter name and value pair that is used to return a more specific list of
	// results from a list operation. Filters can be used to match a set of resources
	// by specific criteria, such as tags, attributes, or IDs.
	Filter *types.Filter

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListImageScanFindingAggregationsOutput added in v1.23.0 

type ListImageScanFindingAggregationsOutput struct {

	// The aggregation type specifies what type of key is used to group the image scan
	// findings. Image Builder returns results based on the request filter. If you
	// didn't specify a filter in the request, the type defaults to accountId .
	//
	// Aggregation types
	//
	//   - accountId
	//
	//   - imageBuildVersionArn
	//
	//   - imagePipelineArn
	//
	//   - vulnerabilityId
	//
	// Each aggregation includes counts by severity level for medium severity and
	// higher level findings, plus a total for all of the findings for each key value.
	AggregationType *string

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// An array of image scan finding aggregations that match the filter criteria.
	Responses []types.ImageScanFindingAggregation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListImageScanFindingAggregationsPaginator added in v1.23.0 

type ListImageScanFindingAggregationsPaginator struct {
	// contains filtered or unexported fields
}

ListImageScanFindingAggregationsPaginator is a paginator for ListImageScanFindingAggregations

func NewListImageScanFindingAggregationsPaginator added in v1.23.0 

func NewListImageScanFindingAggregationsPaginator(client ListImageScanFindingAggregationsAPIClient, params *ListImageScanFindingAggregationsInput, optFns ...func(*ListImageScanFindingAggregationsPaginatorOptions)) *ListImageScanFindingAggregationsPaginator

NewListImageScanFindingAggregationsPaginator returns a new ListImageScanFindingAggregationsPaginator

func (*ListImageScanFindingAggregationsPaginator) HasMorePages added in v1.23.0 

func (p *ListImageScanFindingAggregationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImageScanFindingAggregationsPaginator) NextPage added in v1.23.0 

func (p *ListImageScanFindingAggregationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImageScanFindingAggregationsOutput, error)

NextPage retrieves the next ListImageScanFindingAggregations page.

type ListImageScanFindingAggregationsPaginatorOptions added in v1.23.0 

type ListImageScanFindingAggregationsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListImageScanFindingAggregationsPaginatorOptions is the paginator options for ListImageScanFindingAggregations

type ListImageScanFindingsAPIClient added in v1.23.0 

type ListImageScanFindingsAPIClient interface {
	ListImageScanFindings(context.Context, *ListImageScanFindingsInput, ...func(*Options)) (*ListImageScanFindingsOutput, error)
}

ListImageScanFindingsAPIClient is a client that implements the ListImageScanFindings operation.

type ListImageScanFindingsInput added in v1.23.0 

type ListImageScanFindingsInput struct {

	// An array of name value pairs that you can use to filter your results. You can
	// use the following filters to streamline results:
	//
	//   - imageBuildVersionArn
	//
	//   - imagePipelineArn
	//
	//   - vulnerabilityId
	//
	//   - severity
	//
	// If you don't request a filter, then all findings in your account are listed.
	Filters []types.ImageScanFindingsFilter

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListImageScanFindingsOutput added in v1.23.0 

type ListImageScanFindingsOutput struct {

	// The image scan findings for your account that meet your request filter criteria.
	Findings []types.ImageScanFinding

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListImageScanFindingsPaginator added in v1.23.0 

type ListImageScanFindingsPaginator struct {
	// contains filtered or unexported fields
}

ListImageScanFindingsPaginator is a paginator for ListImageScanFindings

func NewListImageScanFindingsPaginator added in v1.23.0 

func NewListImageScanFindingsPaginator(client ListImageScanFindingsAPIClient, params *ListImageScanFindingsInput, optFns ...func(*ListImageScanFindingsPaginatorOptions)) *ListImageScanFindingsPaginator

NewListImageScanFindingsPaginator returns a new ListImageScanFindingsPaginator

func (*ListImageScanFindingsPaginator) HasMorePages added in v1.23.0 

func (p *ListImageScanFindingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImageScanFindingsPaginator) NextPage added in v1.23.0 

func (p *ListImageScanFindingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImageScanFindingsOutput, error)

NextPage retrieves the next ListImageScanFindings page.

type ListImageScanFindingsPaginatorOptions added in v1.23.0 

type ListImageScanFindingsPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListImageScanFindingsPaginatorOptions is the paginator options for ListImageScanFindings

type ListImagesAPIClient added in v0.30.0 

type ListImagesAPIClient interface {
	ListImages(context.Context, *ListImagesInput, ...func(*Options)) (*ListImagesOutput, error)
}

ListImagesAPIClient is a client that implements the ListImages operation.

type ListImagesInput 

type ListImagesInput struct {

	// Requests a list of images with a specific recipe name.
	ByName bool

	// Use the following filters to streamline results:
	//
	//   - name
	//
	//   - osVersion
	//
	//   - platform
	//
	//   - type
	//
	//   - version
	Filters []types.Filter

	// Includes deprecated images in the response list.
	IncludeDeprecated *bool

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string

	// The owner defines which images you want to list. By default, this request will
	// only show images owned by your account. You can use this field to specify if you
	// want to view images owned by yourself, by Amazon, or those images that have been
	// shared with you by other customers.
	Owner types.Ownership
	// contains filtered or unexported fields
}

type ListImagesOutput 

type ListImagesOutput struct {

	// The list of image semantic versions.
	//
	// The semantic version has four nodes: ../. You can assign values for the first
	// three, and can filter on all of them.
	//
	// 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.
	ImageVersionList []types.ImageVersion

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListImagesPaginator added in v0.30.0 

type ListImagesPaginator struct {
	// contains filtered or unexported fields
}

ListImagesPaginator is a paginator for ListImages

func NewListImagesPaginator added in v0.30.0 

func NewListImagesPaginator(client ListImagesAPIClient, params *ListImagesInput, optFns ...func(*ListImagesPaginatorOptions)) *ListImagesPaginator

NewListImagesPaginator returns a new ListImagesPaginator

func (*ListImagesPaginator) HasMorePages added in v0.30.0 

func (p *ListImagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImagesPaginator) NextPage added in v0.30.0 

func (p *ListImagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImagesOutput, error)

NextPage retrieves the next ListImages page.

type ListImagesPaginatorOptions added in v0.30.0 

type ListImagesPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListImagesPaginatorOptions is the paginator options for ListImages

type ListInfrastructureConfigurationsAPIClient added in v0.30.0 

type ListInfrastructureConfigurationsAPIClient interface {
	ListInfrastructureConfigurations(context.Context, *ListInfrastructureConfigurationsInput, ...func(*Options)) (*ListInfrastructureConfigurationsOutput, error)
}

ListInfrastructureConfigurationsAPIClient is a client that implements the ListInfrastructureConfigurations operation.

type ListInfrastructureConfigurationsInput 

type ListInfrastructureConfigurationsInput struct {

	// You can filter on name to streamline results.
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListInfrastructureConfigurationsOutput 

type ListInfrastructureConfigurationsOutput struct {

	// The list of infrastructure configurations.
	InfrastructureConfigurationSummaryList []types.InfrastructureConfigurationSummary

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListInfrastructureConfigurationsPaginator added in v0.30.0 

type ListInfrastructureConfigurationsPaginator struct {
	// contains filtered or unexported fields
}

ListInfrastructureConfigurationsPaginator is a paginator for ListInfrastructureConfigurations

func NewListInfrastructureConfigurationsPaginator added in v0.30.0 

func NewListInfrastructureConfigurationsPaginator(client ListInfrastructureConfigurationsAPIClient, params *ListInfrastructureConfigurationsInput, optFns ...func(*ListInfrastructureConfigurationsPaginatorOptions)) *ListInfrastructureConfigurationsPaginator

NewListInfrastructureConfigurationsPaginator returns a new ListInfrastructureConfigurationsPaginator

func (*ListInfrastructureConfigurationsPaginator) HasMorePages added in v0.30.0 

func (p *ListInfrastructureConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInfrastructureConfigurationsPaginator) NextPage added in v0.30.0 

func (p *ListInfrastructureConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInfrastructureConfigurationsOutput, error)

NextPage retrieves the next ListInfrastructureConfigurations page.

type ListInfrastructureConfigurationsPaginatorOptions added in v0.30.0 

type ListInfrastructureConfigurationsPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListInfrastructureConfigurationsPaginatorOptions is the paginator options for ListInfrastructureConfigurations

type ListLifecycleExecutionResourcesAPIClient added in v1.28.0 

type ListLifecycleExecutionResourcesAPIClient interface {
	ListLifecycleExecutionResources(context.Context, *ListLifecycleExecutionResourcesInput, ...func(*Options)) (*ListLifecycleExecutionResourcesOutput, error)
}

ListLifecycleExecutionResourcesAPIClient is a client that implements the ListLifecycleExecutionResources operation.

type ListLifecycleExecutionResourcesInput added in v1.28.0 

type ListLifecycleExecutionResourcesInput struct {

	// Use the unique identifier for a runtime instance of the lifecycle policy to get
	// runtime details.
	//
	// This member is required.
	LifecycleExecutionId *string

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string

	// You can leave this empty to get a list of Image Builder resources that were
	// identified for lifecycle actions.
	//
	// To get a list of associated resources that are impacted for an individual
	// resource (the parent), specify its Amazon Resource Name (ARN). Associated
	// resources are produced from your image and distributed when you run a build,
	// such as AMIs or container images stored in ECR repositories.
	ParentResourceId *string
	// contains filtered or unexported fields
}

type ListLifecycleExecutionResourcesOutput added in v1.28.0 

type ListLifecycleExecutionResourcesOutput struct {

	// Runtime details for the specified runtime instance of the lifecycle policy.
	LifecycleExecutionId *string

	// The current state of the lifecycle runtime instance.
	LifecycleExecutionState *types.LifecycleExecutionState

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// A list of resources that were identified for lifecycle actions.
	Resources []types.LifecycleExecutionResource

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLifecycleExecutionResourcesPaginator added in v1.28.0 

type ListLifecycleExecutionResourcesPaginator struct {
	// contains filtered or unexported fields
}

ListLifecycleExecutionResourcesPaginator is a paginator for ListLifecycleExecutionResources

func NewListLifecycleExecutionResourcesPaginator added in v1.28.0 

func NewListLifecycleExecutionResourcesPaginator(client ListLifecycleExecutionResourcesAPIClient, params *ListLifecycleExecutionResourcesInput, optFns ...func(*ListLifecycleExecutionResourcesPaginatorOptions)) *ListLifecycleExecutionResourcesPaginator

NewListLifecycleExecutionResourcesPaginator returns a new ListLifecycleExecutionResourcesPaginator

func (*ListLifecycleExecutionResourcesPaginator) HasMorePages added in v1.28.0 

func (p *ListLifecycleExecutionResourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLifecycleExecutionResourcesPaginator) NextPage added in v1.28.0 

func (p *ListLifecycleExecutionResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLifecycleExecutionResourcesOutput, error)

NextPage retrieves the next ListLifecycleExecutionResources page.

type ListLifecycleExecutionResourcesPaginatorOptions added in v1.28.0 

type ListLifecycleExecutionResourcesPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLifecycleExecutionResourcesPaginatorOptions is the paginator options for ListLifecycleExecutionResources

type ListLifecycleExecutionsAPIClient added in v1.28.0 

type ListLifecycleExecutionsAPIClient interface {
	ListLifecycleExecutions(context.Context, *ListLifecycleExecutionsInput, ...func(*Options)) (*ListLifecycleExecutionsOutput, error)
}

ListLifecycleExecutionsAPIClient is a client that implements the ListLifecycleExecutions operation.

type ListLifecycleExecutionsInput added in v1.28.0 

type ListLifecycleExecutionsInput struct {

	// The Amazon Resource Name (ARN) of the resource for which to get a list of
	// lifecycle runtime instances.
	//
	// This member is required.
	ResourceArn *string

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLifecycleExecutionsOutput added in v1.28.0 

type ListLifecycleExecutionsOutput struct {

	// A list of lifecycle runtime instances for the specified resource.
	LifecycleExecutions []types.LifecycleExecution

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLifecycleExecutionsPaginator added in v1.28.0 

type ListLifecycleExecutionsPaginator struct {
	// contains filtered or unexported fields
}

ListLifecycleExecutionsPaginator is a paginator for ListLifecycleExecutions

func NewListLifecycleExecutionsPaginator added in v1.28.0 

func NewListLifecycleExecutionsPaginator(client ListLifecycleExecutionsAPIClient, params *ListLifecycleExecutionsInput, optFns ...func(*ListLifecycleExecutionsPaginatorOptions)) *ListLifecycleExecutionsPaginator

NewListLifecycleExecutionsPaginator returns a new ListLifecycleExecutionsPaginator

func (*ListLifecycleExecutionsPaginator) HasMorePages added in v1.28.0 

func (p *ListLifecycleExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLifecycleExecutionsPaginator) NextPage added in v1.28.0 

func (p *ListLifecycleExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLifecycleExecutionsOutput, error)

NextPage retrieves the next ListLifecycleExecutions page.

type ListLifecycleExecutionsPaginatorOptions added in v1.28.0 

type ListLifecycleExecutionsPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLifecycleExecutionsPaginatorOptions is the paginator options for ListLifecycleExecutions

type ListLifecyclePoliciesAPIClient added in v1.28.0 

type ListLifecyclePoliciesAPIClient interface {
	ListLifecyclePolicies(context.Context, *ListLifecyclePoliciesInput, ...func(*Options)) (*ListLifecyclePoliciesOutput, error)
}

ListLifecyclePoliciesAPIClient is a client that implements the ListLifecyclePolicies operation.

type ListLifecyclePoliciesInput added in v1.28.0 

type ListLifecyclePoliciesInput struct {

	// Streamline results based on one of the following values: Name , Status .
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLifecyclePoliciesOutput added in v1.28.0 

type ListLifecyclePoliciesOutput struct {

	// A list of lifecycle policies in your Amazon Web Services account that meet the
	// criteria specified in the request.
	LifecyclePolicySummaryList []types.LifecyclePolicySummary

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLifecyclePoliciesPaginator added in v1.28.0 

type ListLifecyclePoliciesPaginator struct {
	// contains filtered or unexported fields
}

ListLifecyclePoliciesPaginator is a paginator for ListLifecyclePolicies

func NewListLifecyclePoliciesPaginator added in v1.28.0 

func NewListLifecyclePoliciesPaginator(client ListLifecyclePoliciesAPIClient, params *ListLifecyclePoliciesInput, optFns ...func(*ListLifecyclePoliciesPaginatorOptions)) *ListLifecyclePoliciesPaginator

NewListLifecyclePoliciesPaginator returns a new ListLifecyclePoliciesPaginator

func (*ListLifecyclePoliciesPaginator) HasMorePages added in v1.28.0 

func (p *ListLifecyclePoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLifecyclePoliciesPaginator) NextPage added in v1.28.0 

func (p *ListLifecyclePoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLifecyclePoliciesOutput, error)

NextPage retrieves the next ListLifecyclePolicies page.

type ListLifecyclePoliciesPaginatorOptions added in v1.28.0 

type ListLifecyclePoliciesPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLifecyclePoliciesPaginatorOptions is the paginator options for ListLifecyclePolicies

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags for the specified resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWaitingWorkflowStepsAPIClient added in v1.30.0 

type ListWaitingWorkflowStepsAPIClient interface {
	ListWaitingWorkflowSteps(context.Context, *ListWaitingWorkflowStepsInput, ...func(*Options)) (*ListWaitingWorkflowStepsOutput, error)
}

ListWaitingWorkflowStepsAPIClient is a client that implements the ListWaitingWorkflowSteps operation.

type ListWaitingWorkflowStepsInput added in v1.30.0 

type ListWaitingWorkflowStepsInput struct {

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListWaitingWorkflowStepsOutput added in v1.30.0 

type ListWaitingWorkflowStepsOutput struct {

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// An array of the workflow steps that are waiting for action in your Amazon Web
	// Services account.
	Steps []types.WorkflowStepExecution

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWaitingWorkflowStepsPaginator added in v1.30.0 

type ListWaitingWorkflowStepsPaginator struct {
	// contains filtered or unexported fields
}

ListWaitingWorkflowStepsPaginator is a paginator for ListWaitingWorkflowSteps

func NewListWaitingWorkflowStepsPaginator added in v1.30.0 

func NewListWaitingWorkflowStepsPaginator(client ListWaitingWorkflowStepsAPIClient, params *ListWaitingWorkflowStepsInput, optFns ...func(*ListWaitingWorkflowStepsPaginatorOptions)) *ListWaitingWorkflowStepsPaginator

NewListWaitingWorkflowStepsPaginator returns a new ListWaitingWorkflowStepsPaginator

func (*ListWaitingWorkflowStepsPaginator) HasMorePages added in v1.30.0 

func (p *ListWaitingWorkflowStepsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWaitingWorkflowStepsPaginator) NextPage added in v1.30.0 

func (p *ListWaitingWorkflowStepsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWaitingWorkflowStepsOutput, error)

NextPage retrieves the next ListWaitingWorkflowSteps page.

type ListWaitingWorkflowStepsPaginatorOptions added in v1.30.0 

type ListWaitingWorkflowStepsPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWaitingWorkflowStepsPaginatorOptions is the paginator options for ListWaitingWorkflowSteps

type ListWorkflowBuildVersionsAPIClient added in v1.30.0 

type ListWorkflowBuildVersionsAPIClient interface {
	ListWorkflowBuildVersions(context.Context, *ListWorkflowBuildVersionsInput, ...func(*Options)) (*ListWorkflowBuildVersionsOutput, error)
}

ListWorkflowBuildVersionsAPIClient is a client that implements the ListWorkflowBuildVersions operation.

type ListWorkflowBuildVersionsInput added in v1.30.0 

type ListWorkflowBuildVersionsInput struct {

	// The Amazon Resource Name (ARN) of the workflow resource for which to get a list
	// of build versions.
	//
	// This member is required.
	WorkflowVersionArn *string

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListWorkflowBuildVersionsOutput added in v1.30.0 

type ListWorkflowBuildVersionsOutput struct {

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// A list that contains metadata for the workflow builds that have run for the
	// workflow resource specified in the request.
	WorkflowSummaryList []types.WorkflowSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWorkflowBuildVersionsPaginator added in v1.30.0 

type ListWorkflowBuildVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListWorkflowBuildVersionsPaginator is a paginator for ListWorkflowBuildVersions

func NewListWorkflowBuildVersionsPaginator added in v1.30.0 

func NewListWorkflowBuildVersionsPaginator(client ListWorkflowBuildVersionsAPIClient, params *ListWorkflowBuildVersionsInput, optFns ...func(*ListWorkflowBuildVersionsPaginatorOptions)) *ListWorkflowBuildVersionsPaginator

NewListWorkflowBuildVersionsPaginator returns a new ListWorkflowBuildVersionsPaginator

func (*ListWorkflowBuildVersionsPaginator) HasMorePages added in v1.30.0 

func (p *ListWorkflowBuildVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkflowBuildVersionsPaginator) NextPage added in v1.30.0 

func (p *ListWorkflowBuildVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkflowBuildVersionsOutput, error)

NextPage retrieves the next ListWorkflowBuildVersions page.

type ListWorkflowBuildVersionsPaginatorOptions added in v1.30.0 

type ListWorkflowBuildVersionsPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorkflowBuildVersionsPaginatorOptions is the paginator options for ListWorkflowBuildVersions

type ListWorkflowExecutionsAPIClient added in v1.23.0 

type ListWorkflowExecutionsAPIClient interface {
	ListWorkflowExecutions(context.Context, *ListWorkflowExecutionsInput, ...func(*Options)) (*ListWorkflowExecutionsOutput, error)
}

ListWorkflowExecutionsAPIClient is a client that implements the ListWorkflowExecutions operation.

type ListWorkflowExecutionsInput added in v1.23.0 

type ListWorkflowExecutionsInput struct {

	// List all workflow runtime instances for the specified image build version
	// resource ARN.
	//
	// This member is required.
	ImageBuildVersionArn *string

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListWorkflowExecutionsOutput added in v1.23.0 

type ListWorkflowExecutionsOutput struct {

	// The resource ARN of the image build version for which you requested a list of
	// workflow runtime details.
	ImageBuildVersionArn *string

	// The output message from the list action, if applicable.
	Message *string

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Contains an array of runtime details that represents each time a workflow ran
	// for the requested image build version.
	WorkflowExecutions []types.WorkflowExecutionMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWorkflowExecutionsPaginator added in v1.23.0 

type ListWorkflowExecutionsPaginator struct {
	// contains filtered or unexported fields
}

ListWorkflowExecutionsPaginator is a paginator for ListWorkflowExecutions

func NewListWorkflowExecutionsPaginator added in v1.23.0 

func NewListWorkflowExecutionsPaginator(client ListWorkflowExecutionsAPIClient, params *ListWorkflowExecutionsInput, optFns ...func(*ListWorkflowExecutionsPaginatorOptions)) *ListWorkflowExecutionsPaginator

NewListWorkflowExecutionsPaginator returns a new ListWorkflowExecutionsPaginator

func (*ListWorkflowExecutionsPaginator) HasMorePages added in v1.23.0 

func (p *ListWorkflowExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkflowExecutionsPaginator) NextPage added in v1.23.0 

func (p *ListWorkflowExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkflowExecutionsOutput, error)

NextPage retrieves the next ListWorkflowExecutions page.

type ListWorkflowExecutionsPaginatorOptions added in v1.23.0 

type ListWorkflowExecutionsPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorkflowExecutionsPaginatorOptions is the paginator options for ListWorkflowExecutions

type ListWorkflowStepExecutionsAPIClient added in v1.23.0 

type ListWorkflowStepExecutionsAPIClient interface {
	ListWorkflowStepExecutions(context.Context, *ListWorkflowStepExecutionsInput, ...func(*Options)) (*ListWorkflowStepExecutionsOutput, error)
}

ListWorkflowStepExecutionsAPIClient is a client that implements the ListWorkflowStepExecutions operation.

type ListWorkflowStepExecutionsInput added in v1.23.0 

type ListWorkflowStepExecutionsInput struct {

	// The unique identifier that Image Builder assigned to keep track of runtime
	// details when it ran the workflow.
	//
	// This member is required.
	WorkflowExecutionId *string

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListWorkflowStepExecutionsOutput added in v1.23.0 

type ListWorkflowStepExecutionsOutput struct {

	// The image build version resource ARN that's associated with the specified
	// runtime instance of the workflow.
	ImageBuildVersionArn *string

	// The output message from the list action, if applicable.
	Message *string

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Contains an array of runtime details that represents each step in this runtime
	// instance of the workflow.
	Steps []types.WorkflowStepMetadata

	// The build version ARN for the Image Builder workflow resource that defines the
	// steps for this runtime instance of the workflow.
	WorkflowBuildVersionArn *string

	// The unique identifier that Image Builder assigned to keep track of runtime
	// details when it ran the workflow.
	WorkflowExecutionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWorkflowStepExecutionsPaginator added in v1.23.0 

type ListWorkflowStepExecutionsPaginator struct {
	// contains filtered or unexported fields
}

ListWorkflowStepExecutionsPaginator is a paginator for ListWorkflowStepExecutions

func NewListWorkflowStepExecutionsPaginator added in v1.23.0 

func NewListWorkflowStepExecutionsPaginator(client ListWorkflowStepExecutionsAPIClient, params *ListWorkflowStepExecutionsInput, optFns ...func(*ListWorkflowStepExecutionsPaginatorOptions)) *ListWorkflowStepExecutionsPaginator

NewListWorkflowStepExecutionsPaginator returns a new ListWorkflowStepExecutionsPaginator

func (*ListWorkflowStepExecutionsPaginator) HasMorePages added in v1.23.0 

func (p *ListWorkflowStepExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkflowStepExecutionsPaginator) NextPage added in v1.23.0 

func (p *ListWorkflowStepExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkflowStepExecutionsOutput, error)

NextPage retrieves the next ListWorkflowStepExecutions page.

type ListWorkflowStepExecutionsPaginatorOptions added in v1.23.0 

type ListWorkflowStepExecutionsPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorkflowStepExecutionsPaginatorOptions is the paginator options for ListWorkflowStepExecutions

type ListWorkflowsAPIClient added in v1.30.0 

type ListWorkflowsAPIClient interface {
	ListWorkflows(context.Context, *ListWorkflowsInput, ...func(*Options)) (*ListWorkflowsOutput, error)
}

ListWorkflowsAPIClient is a client that implements the ListWorkflows operation.

type ListWorkflowsInput added in v1.30.0 

type ListWorkflowsInput struct {

	// Specify all or part of the workflow name to streamline results.
	ByName bool

	// Used to streamline search results.
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string

	// Used to get a list of workflow build version filtered by the identity of the
	// creator.
	Owner types.Ownership
	// contains filtered or unexported fields
}

type ListWorkflowsOutput added in v1.30.0 

type ListWorkflowsOutput struct {

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// A list of workflow build versions that match the request criteria.
	WorkflowVersionList []types.WorkflowVersion

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWorkflowsPaginator added in v1.30.0 

type ListWorkflowsPaginator struct {
	// contains filtered or unexported fields
}

ListWorkflowsPaginator is a paginator for ListWorkflows

func NewListWorkflowsPaginator added in v1.30.0 

func NewListWorkflowsPaginator(client ListWorkflowsAPIClient, params *ListWorkflowsInput, optFns ...func(*ListWorkflowsPaginatorOptions)) *ListWorkflowsPaginator

NewListWorkflowsPaginator returns a new ListWorkflowsPaginator

func (*ListWorkflowsPaginator) HasMorePages added in v1.30.0 

func (p *ListWorkflowsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkflowsPaginator) NextPage added in v1.30.0 

func (p *ListWorkflowsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkflowsOutput, error)

NextPage retrieves the next ListWorkflows page.

type ListWorkflowsPaginatorOptions added in v1.30.0 

type ListWorkflowsPaginatorOptions struct {
	// The maximum items to return in a request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorkflowsPaginatorOptions is the paginator options for ListWorkflows

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Indicates how aws account ID is applied in endpoint2.0 routing
	AccountIDEndpointMode aws.AccountIDEndpointMode

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.27.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutComponentPolicyInput 

type PutComponentPolicyInput struct {

	// The Amazon Resource Name (ARN) of the component that this policy should be
	// applied to.
	//
	// This member is required.
	ComponentArn *string

	// The policy to apply.
	//
	// This member is required.
	Policy *string
	// contains filtered or unexported fields
}

type PutComponentPolicyOutput 

type PutComponentPolicyOutput struct {

	// The Amazon Resource Name (ARN) of the component that this policy was applied to.
	ComponentArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutContainerRecipePolicyInput added in v0.31.0 

type PutContainerRecipePolicyInput struct {

	// The Amazon Resource Name (ARN) of the container recipe that this policy should
	// be applied to.
	//
	// This member is required.
	ContainerRecipeArn *string

	// The policy to apply to the container recipe.
	//
	// This member is required.
	Policy *string
	// contains filtered or unexported fields
}

type PutContainerRecipePolicyOutput added in v0.31.0 

type PutContainerRecipePolicyOutput struct {

	// The Amazon Resource Name (ARN) of the container recipe that this policy was
	// applied to.
	ContainerRecipeArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutImagePolicyInput 

type PutImagePolicyInput struct {

	// The Amazon Resource Name (ARN) of the image that this policy should be applied
	// to.
	//
	// This member is required.
	ImageArn *string

	// The policy to apply.
	//
	// This member is required.
	Policy *string
	// contains filtered or unexported fields
}

type PutImagePolicyOutput 

type PutImagePolicyOutput struct {

	// The Amazon Resource Name (ARN) of the image that this policy was applied to.
	ImageArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutImageRecipePolicyInput 

type PutImageRecipePolicyInput struct {

	// The Amazon Resource Name (ARN) of the image recipe that this policy should be
	// applied to.
	//
	// This member is required.
	ImageRecipeArn *string

	// The policy to apply.
	//
	// This member is required.
	Policy *string
	// contains filtered or unexported fields
}

type PutImageRecipePolicyOutput 

type PutImageRecipePolicyOutput struct {

	// The Amazon Resource Name (ARN) of the image recipe that this policy was applied
	// to.
	ImageRecipeArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SendWorkflowStepActionInput added in v1.30.0 

type SendWorkflowStepActionInput struct {

	// The action for the image creation process to take while a workflow WaitForAction
	// step waits for an asynchronous action to complete.
	//
	// This member is required.
	Action types.WorkflowStepActionType

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image build version to send action for.
	//
	// This member is required.
	ImageBuildVersionArn *string

	// Uniquely identifies the workflow step that sent the step action.
	//
	// This member is required.
	StepExecutionId *string

	// The reason why this action is sent.
	Reason *string
	// contains filtered or unexported fields
}

type SendWorkflowStepActionOutput added in v1.30.0 

type SendWorkflowStepActionOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image build version that received the
	// action request.
	ImageBuildVersionArn *string

	// The workflow step that sent the step action.
	StepExecutionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartImagePipelineExecutionInput 

type StartImagePipelineExecutionInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image pipeline that you want to manually
	// invoke.
	//
	// This member is required.
	ImagePipelineArn *string
	// contains filtered or unexported fields
}

type StartImagePipelineExecutionOutput 

type StartImagePipelineExecutionOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image that the request created.
	ImageBuildVersionArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartResourceStateUpdateInput added in v1.28.0 

type StartResourceStateUpdateInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The ARN of the Image Builder resource that is updated. The state update might
	// also impact associated resources.
	//
	// This member is required.
	ResourceArn *string

	// Indicates the lifecycle action to take for this request.
	//
	// This member is required.
	State *types.ResourceState

	// Skip action on the image resource and associated resources if specified
	// exclusion rules are met.
	ExclusionRules *types.ResourceStateUpdateExclusionRules

	// The name or Amazon Resource Name (ARN) of the IAM role that’s used to update
	// image state.
	ExecutionRole *string

	// A list of image resources to update state for.
	IncludeResources *types.ResourceStateUpdateIncludeResources

	// The timestamp that indicates when resources are updated by a lifecycle action.
	UpdateAt *time.Time
	// contains filtered or unexported fields
}

type StartResourceStateUpdateOutput added in v1.28.0 

type StartResourceStateUpdateOutput struct {

	// Identifies the lifecycle runtime instance that started the resource state
	// update.
	LifecycleExecutionId *string

	// The requested ARN of the Image Builder resource for the asynchronous update.
	ResourceArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to tag.
	//
	// This member is required.
	ResourceArn *string

	// The tags to apply to the resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to untag.
	//
	// This member is required.
	ResourceArn *string

	// The tag keys to remove from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDistributionConfigurationInput 

type UpdateDistributionConfigurationInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the distribution configuration that you want
	// to update.
	//
	// This member is required.
	DistributionConfigurationArn *string

	// The distributions of the distribution configuration.
	//
	// This member is required.
	Distributions []types.Distribution

	// The description of the distribution configuration.
	Description *string
	// contains filtered or unexported fields
}

type UpdateDistributionConfigurationOutput 

type UpdateDistributionConfigurationOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the distribution configuration that was
	// updated by this request.
	DistributionConfigurationArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateImagePipelineInput 

type UpdateImagePipelineInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image pipeline that you want to update.
	//
	// This member is required.
	ImagePipelineArn *string

	// The Amazon Resource Name (ARN) of the infrastructure configuration that Image
	// Builder uses to build images that this image pipeline has updated.
	//
	// This member is required.
	InfrastructureConfigurationArn *string

	// The Amazon Resource Name (ARN) of the container pipeline to update.
	ContainerRecipeArn *string

	// The description of the image pipeline.
	Description *string

	// The Amazon Resource Name (ARN) of the distribution configuration that Image
	// Builder uses to configure and distribute images that this image pipeline has
	// updated.
	DistributionConfigurationArn *string

	// Collects additional information about the image being created, including the
	// operating system (OS) version and package list. This information is used to
	// enhance the overall experience of using EC2 Image Builder. Enabled by default.
	EnhancedImageMetadataEnabled *bool

	// The name or Amazon Resource Name (ARN) for the IAM role you create that grants
	// Image Builder access to perform workflow actions.
	ExecutionRole *string

	// The Amazon Resource Name (ARN) of the image recipe that will be used to
	// configure images updated by this image pipeline.
	ImageRecipeArn *string

	// Contains settings for vulnerability scans.
	ImageScanningConfiguration *types.ImageScanningConfiguration

	// The image test configuration of the image pipeline.
	ImageTestsConfiguration *types.ImageTestsConfiguration

	// The schedule of the image pipeline.
	Schedule *types.Schedule

	// The status of the image pipeline.
	Status types.PipelineStatus

	// Contains the workflows to run for the pipeline.
	Workflows []types.WorkflowConfiguration
	// contains filtered or unexported fields
}

type UpdateImagePipelineOutput 

type UpdateImagePipelineOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image pipeline that was updated by this
	// request.
	ImagePipelineArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateInfrastructureConfigurationInput 

type UpdateInfrastructureConfigurationInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the infrastructure configuration that you
	// want to update.
	//
	// This member is required.
	InfrastructureConfigurationArn *string

	// The instance profile to associate with the instance used to customize your
	// Amazon EC2 AMI.
	//
	// This member is required.
	InstanceProfileName *string

	// The description of the infrastructure configuration.
	Description *string

	// The instance metadata options that you can set for the HTTP requests that
	// pipeline builds use to launch EC2 build and test instances. For more information
	// about instance metadata options, see one of the following links:
	//
	// [Configure the instance metadata options]
	//   - in the Amazon EC2 User Guide for Linux instances.
	//
	// [Configure the instance metadata options]
	//   - in the Amazon EC2 Windows Guide for Windows instances.
	//
	// [Configure the instance metadata options]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html
	InstanceMetadataOptions *types.InstanceMetadataOptions

	// The instance types of the infrastructure configuration. You can specify one or
	// more instance types to use for this build. The service will pick one of these
	// instance types based on availability.
	InstanceTypes []string

	// The key pair of the infrastructure configuration. You can use this to log on to
	// and debug the instance used to create your image.
	KeyPair *string

	// The logging configuration of the infrastructure configuration.
	Logging *types.Logging

	// The tags attached to the resource created by Image Builder.
	ResourceTags map[string]string

	// The security group IDs to associate with the instance used to customize your
	// Amazon EC2 AMI.
	SecurityGroupIds []string

	// The Amazon Resource Name (ARN) for the SNS topic to which we send image build
	// event notifications.
	//
	// EC2 Image Builder is unable to send notifications to SNS topics that are
	// encrypted using keys from other accounts. The key that is used to encrypt the
	// SNS topic must reside in the account that the Image Builder service runs under.
	SnsTopicArn *string

	// The subnet ID to place the instance used to customize your Amazon EC2 AMI in.
	SubnetId *string

	// The terminate instance on failure setting of the infrastructure configuration.
	// Set to false if you want Image Builder to retain the instance used to configure
	// your AMI if the build or test phase of your workflow fails.
	TerminateInstanceOnFailure *bool
	// contains filtered or unexported fields
}

type UpdateInfrastructureConfigurationOutput 

type UpdateInfrastructureConfigurationOutput struct {

	// The client token that uniquely identifies the request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the infrastructure configuration that was
	// updated by this request.
	InfrastructureConfigurationArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateLifecyclePolicyInput added in v1.28.0 

type UpdateLifecyclePolicyInput struct {

	// Unique, case-sensitive identifier you provide to ensure idempotency of the
	// request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	//
	// This member is required.
	ClientToken *string

	// The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses
	// to update the lifecycle policy.
	//
	// This member is required.
	ExecutionRole *string

	// The Amazon Resource Name (ARN) of the lifecycle policy resource.
	//
	// This member is required.
	LifecyclePolicyArn *string

	// The configuration details for a lifecycle policy resource.
	//
	// This member is required.
	PolicyDetails []types.LifecyclePolicyDetail

	// Selection criteria for resources that the lifecycle policy applies to.
	//
	// This member is required.
	ResourceSelection *types.LifecyclePolicyResourceSelection

	// The type of image resource that the lifecycle policy applies to.
	//
	// This member is required.
	ResourceType types.LifecyclePolicyResourceType

	// Optional description for the lifecycle policy.
	Description *string

	// Indicates whether the lifecycle policy resource is enabled.
	Status types.LifecyclePolicyStatus
	// contains filtered or unexported fields
}

type UpdateLifecyclePolicyOutput added in v1.28.0 

type UpdateLifecyclePolicyOutput struct {

	// The ARN of the image lifecycle policy resource that was updated.
	LifecyclePolicyArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.