cloudworker-proxy
Version:
An api gateway for cloudflare workers
1,074 lines • 92.1 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Imagebuilder extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Imagebuilder.Types.ClientConfiguration)
config: Config & Imagebuilder.Types.ClientConfiguration;
/**
* CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
*/
cancelImageCreation(params: Imagebuilder.Types.CancelImageCreationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.CancelImageCreationResponse) => void): Request<Imagebuilder.Types.CancelImageCreationResponse, AWSError>;
/**
* CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
*/
cancelImageCreation(callback?: (err: AWSError, data: Imagebuilder.Types.CancelImageCreationResponse) => void): Request<Imagebuilder.Types.CancelImageCreationResponse, AWSError>;
/**
* Creates a new component that can be used to build, validate, test, and assess your image.
*/
createComponent(params: Imagebuilder.Types.CreateComponentRequest, callback?: (err: AWSError, data: Imagebuilder.Types.CreateComponentResponse) => void): Request<Imagebuilder.Types.CreateComponentResponse, AWSError>;
/**
* Creates a new component that can be used to build, validate, test, and assess your image.
*/
createComponent(callback?: (err: AWSError, data: Imagebuilder.Types.CreateComponentResponse) => void): Request<Imagebuilder.Types.CreateComponentResponse, AWSError>;
/**
* Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
*/
createDistributionConfiguration(params: Imagebuilder.Types.CreateDistributionConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.CreateDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.CreateDistributionConfigurationResponse, AWSError>;
/**
* Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
*/
createDistributionConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.CreateDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.CreateDistributionConfigurationResponse, AWSError>;
/**
* Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration.
*/
createImage(params: Imagebuilder.Types.CreateImageRequest, callback?: (err: AWSError, data: Imagebuilder.Types.CreateImageResponse) => void): Request<Imagebuilder.Types.CreateImageResponse, AWSError>;
/**
* Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration.
*/
createImage(callback?: (err: AWSError, data: Imagebuilder.Types.CreateImageResponse) => void): Request<Imagebuilder.Types.CreateImageResponse, AWSError>;
/**
* Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
*/
createImagePipeline(params: Imagebuilder.Types.CreateImagePipelineRequest, callback?: (err: AWSError, data: Imagebuilder.Types.CreateImagePipelineResponse) => void): Request<Imagebuilder.Types.CreateImagePipelineResponse, AWSError>;
/**
* Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
*/
createImagePipeline(callback?: (err: AWSError, data: Imagebuilder.Types.CreateImagePipelineResponse) => void): Request<Imagebuilder.Types.CreateImagePipelineResponse, AWSError>;
/**
* Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.
*/
createImageRecipe(params: Imagebuilder.Types.CreateImageRecipeRequest, callback?: (err: AWSError, data: Imagebuilder.Types.CreateImageRecipeResponse) => void): Request<Imagebuilder.Types.CreateImageRecipeResponse, AWSError>;
/**
* Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.
*/
createImageRecipe(callback?: (err: AWSError, data: Imagebuilder.Types.CreateImageRecipeResponse) => void): Request<Imagebuilder.Types.CreateImageRecipeResponse, AWSError>;
/**
* Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
*/
createInfrastructureConfiguration(params: Imagebuilder.Types.CreateInfrastructureConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.CreateInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.CreateInfrastructureConfigurationResponse, AWSError>;
/**
* Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
*/
createInfrastructureConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.CreateInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.CreateInfrastructureConfigurationResponse, AWSError>;
/**
* Deletes a component build version.
*/
deleteComponent(params: Imagebuilder.Types.DeleteComponentRequest, callback?: (err: AWSError, data: Imagebuilder.Types.DeleteComponentResponse) => void): Request<Imagebuilder.Types.DeleteComponentResponse, AWSError>;
/**
* Deletes a component build version.
*/
deleteComponent(callback?: (err: AWSError, data: Imagebuilder.Types.DeleteComponentResponse) => void): Request<Imagebuilder.Types.DeleteComponentResponse, AWSError>;
/**
* Deletes a distribution configuration.
*/
deleteDistributionConfiguration(params: Imagebuilder.Types.DeleteDistributionConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.DeleteDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.DeleteDistributionConfigurationResponse, AWSError>;
/**
* Deletes a distribution configuration.
*/
deleteDistributionConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.DeleteDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.DeleteDistributionConfigurationResponse, AWSError>;
/**
* Deletes an image.
*/
deleteImage(params: Imagebuilder.Types.DeleteImageRequest, callback?: (err: AWSError, data: Imagebuilder.Types.DeleteImageResponse) => void): Request<Imagebuilder.Types.DeleteImageResponse, AWSError>;
/**
* Deletes an image.
*/
deleteImage(callback?: (err: AWSError, data: Imagebuilder.Types.DeleteImageResponse) => void): Request<Imagebuilder.Types.DeleteImageResponse, AWSError>;
/**
* Deletes an image pipeline.
*/
deleteImagePipeline(params: Imagebuilder.Types.DeleteImagePipelineRequest, callback?: (err: AWSError, data: Imagebuilder.Types.DeleteImagePipelineResponse) => void): Request<Imagebuilder.Types.DeleteImagePipelineResponse, AWSError>;
/**
* Deletes an image pipeline.
*/
deleteImagePipeline(callback?: (err: AWSError, data: Imagebuilder.Types.DeleteImagePipelineResponse) => void): Request<Imagebuilder.Types.DeleteImagePipelineResponse, AWSError>;
/**
* Deletes an image recipe.
*/
deleteImageRecipe(params: Imagebuilder.Types.DeleteImageRecipeRequest, callback?: (err: AWSError, data: Imagebuilder.Types.DeleteImageRecipeResponse) => void): Request<Imagebuilder.Types.DeleteImageRecipeResponse, AWSError>;
/**
* Deletes an image recipe.
*/
deleteImageRecipe(callback?: (err: AWSError, data: Imagebuilder.Types.DeleteImageRecipeResponse) => void): Request<Imagebuilder.Types.DeleteImageRecipeResponse, AWSError>;
/**
* Deletes an infrastructure configuration.
*/
deleteInfrastructureConfiguration(params: Imagebuilder.Types.DeleteInfrastructureConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.DeleteInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.DeleteInfrastructureConfigurationResponse, AWSError>;
/**
* Deletes an infrastructure configuration.
*/
deleteInfrastructureConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.DeleteInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.DeleteInfrastructureConfigurationResponse, AWSError>;
/**
* Gets a component object.
*/
getComponent(params: Imagebuilder.Types.GetComponentRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetComponentResponse) => void): Request<Imagebuilder.Types.GetComponentResponse, AWSError>;
/**
* Gets a component object.
*/
getComponent(callback?: (err: AWSError, data: Imagebuilder.Types.GetComponentResponse) => void): Request<Imagebuilder.Types.GetComponentResponse, AWSError>;
/**
* Gets a component policy.
*/
getComponentPolicy(params: Imagebuilder.Types.GetComponentPolicyRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetComponentPolicyResponse) => void): Request<Imagebuilder.Types.GetComponentPolicyResponse, AWSError>;
/**
* Gets a component policy.
*/
getComponentPolicy(callback?: (err: AWSError, data: Imagebuilder.Types.GetComponentPolicyResponse) => void): Request<Imagebuilder.Types.GetComponentPolicyResponse, AWSError>;
/**
* Gets a distribution configuration.
*/
getDistributionConfiguration(params: Imagebuilder.Types.GetDistributionConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.GetDistributionConfigurationResponse, AWSError>;
/**
* Gets a distribution configuration.
*/
getDistributionConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.GetDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.GetDistributionConfigurationResponse, AWSError>;
/**
* Gets an image.
*/
getImage(params: Imagebuilder.Types.GetImageRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetImageResponse) => void): Request<Imagebuilder.Types.GetImageResponse, AWSError>;
/**
* Gets an image.
*/
getImage(callback?: (err: AWSError, data: Imagebuilder.Types.GetImageResponse) => void): Request<Imagebuilder.Types.GetImageResponse, AWSError>;
/**
* Gets an image pipeline.
*/
getImagePipeline(params: Imagebuilder.Types.GetImagePipelineRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetImagePipelineResponse) => void): Request<Imagebuilder.Types.GetImagePipelineResponse, AWSError>;
/**
* Gets an image pipeline.
*/
getImagePipeline(callback?: (err: AWSError, data: Imagebuilder.Types.GetImagePipelineResponse) => void): Request<Imagebuilder.Types.GetImagePipelineResponse, AWSError>;
/**
* Gets an image policy.
*/
getImagePolicy(params: Imagebuilder.Types.GetImagePolicyRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetImagePolicyResponse) => void): Request<Imagebuilder.Types.GetImagePolicyResponse, AWSError>;
/**
* Gets an image policy.
*/
getImagePolicy(callback?: (err: AWSError, data: Imagebuilder.Types.GetImagePolicyResponse) => void): Request<Imagebuilder.Types.GetImagePolicyResponse, AWSError>;
/**
* Gets an image recipe.
*/
getImageRecipe(params: Imagebuilder.Types.GetImageRecipeRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetImageRecipeResponse) => void): Request<Imagebuilder.Types.GetImageRecipeResponse, AWSError>;
/**
* Gets an image recipe.
*/
getImageRecipe(callback?: (err: AWSError, data: Imagebuilder.Types.GetImageRecipeResponse) => void): Request<Imagebuilder.Types.GetImageRecipeResponse, AWSError>;
/**
* Gets an image recipe policy.
*/
getImageRecipePolicy(params: Imagebuilder.Types.GetImageRecipePolicyRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetImageRecipePolicyResponse) => void): Request<Imagebuilder.Types.GetImageRecipePolicyResponse, AWSError>;
/**
* Gets an image recipe policy.
*/
getImageRecipePolicy(callback?: (err: AWSError, data: Imagebuilder.Types.GetImageRecipePolicyResponse) => void): Request<Imagebuilder.Types.GetImageRecipePolicyResponse, AWSError>;
/**
* Gets an infrastructure configuration.
*/
getInfrastructureConfiguration(params: Imagebuilder.Types.GetInfrastructureConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.GetInfrastructureConfigurationResponse, AWSError>;
/**
* Gets an infrastructure configuration.
*/
getInfrastructureConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.GetInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.GetInfrastructureConfigurationResponse, AWSError>;
/**
* Imports a component and transforms its data into a component document.
*/
importComponent(params: Imagebuilder.Types.ImportComponentRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ImportComponentResponse) => void): Request<Imagebuilder.Types.ImportComponentResponse, AWSError>;
/**
* Imports a component and transforms its data into a component document.
*/
importComponent(callback?: (err: AWSError, data: Imagebuilder.Types.ImportComponentResponse) => void): Request<Imagebuilder.Types.ImportComponentResponse, AWSError>;
/**
* Returns the list of component build versions for the specified semantic version.
*/
listComponentBuildVersions(params: Imagebuilder.Types.ListComponentBuildVersionsRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListComponentBuildVersionsResponse) => void): Request<Imagebuilder.Types.ListComponentBuildVersionsResponse, AWSError>;
/**
* Returns the list of component build versions for the specified semantic version.
*/
listComponentBuildVersions(callback?: (err: AWSError, data: Imagebuilder.Types.ListComponentBuildVersionsResponse) => void): Request<Imagebuilder.Types.ListComponentBuildVersionsResponse, AWSError>;
/**
* Returns the list of component build versions for the specified semantic version.
*/
listComponents(params: Imagebuilder.Types.ListComponentsRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListComponentsResponse) => void): Request<Imagebuilder.Types.ListComponentsResponse, AWSError>;
/**
* Returns the list of component build versions for the specified semantic version.
*/
listComponents(callback?: (err: AWSError, data: Imagebuilder.Types.ListComponentsResponse) => void): Request<Imagebuilder.Types.ListComponentsResponse, AWSError>;
/**
* Returns a list of distribution configurations.
*/
listDistributionConfigurations(params: Imagebuilder.Types.ListDistributionConfigurationsRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListDistributionConfigurationsResponse) => void): Request<Imagebuilder.Types.ListDistributionConfigurationsResponse, AWSError>;
/**
* Returns a list of distribution configurations.
*/
listDistributionConfigurations(callback?: (err: AWSError, data: Imagebuilder.Types.ListDistributionConfigurationsResponse) => void): Request<Imagebuilder.Types.ListDistributionConfigurationsResponse, AWSError>;
/**
* Returns a list of image build versions.
*/
listImageBuildVersions(params: Imagebuilder.Types.ListImageBuildVersionsRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListImageBuildVersionsResponse) => void): Request<Imagebuilder.Types.ListImageBuildVersionsResponse, AWSError>;
/**
* Returns a list of image build versions.
*/
listImageBuildVersions(callback?: (err: AWSError, data: Imagebuilder.Types.ListImageBuildVersionsResponse) => void): Request<Imagebuilder.Types.ListImageBuildVersionsResponse, AWSError>;
/**
* Returns a list of images created by the specified pipeline.
*/
listImagePipelineImages(params: Imagebuilder.Types.ListImagePipelineImagesRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListImagePipelineImagesResponse) => void): Request<Imagebuilder.Types.ListImagePipelineImagesResponse, AWSError>;
/**
* Returns a list of images created by the specified pipeline.
*/
listImagePipelineImages(callback?: (err: AWSError, data: Imagebuilder.Types.ListImagePipelineImagesResponse) => void): Request<Imagebuilder.Types.ListImagePipelineImagesResponse, AWSError>;
/**
* Returns a list of image pipelines.
*/
listImagePipelines(params: Imagebuilder.Types.ListImagePipelinesRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListImagePipelinesResponse) => void): Request<Imagebuilder.Types.ListImagePipelinesResponse, AWSError>;
/**
* Returns a list of image pipelines.
*/
listImagePipelines(callback?: (err: AWSError, data: Imagebuilder.Types.ListImagePipelinesResponse) => void): Request<Imagebuilder.Types.ListImagePipelinesResponse, AWSError>;
/**
* Returns a list of image recipes.
*/
listImageRecipes(params: Imagebuilder.Types.ListImageRecipesRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListImageRecipesResponse) => void): Request<Imagebuilder.Types.ListImageRecipesResponse, AWSError>;
/**
* Returns a list of image recipes.
*/
listImageRecipes(callback?: (err: AWSError, data: Imagebuilder.Types.ListImageRecipesResponse) => void): Request<Imagebuilder.Types.ListImageRecipesResponse, AWSError>;
/**
* Returns the list of images that you have access to.
*/
listImages(params: Imagebuilder.Types.ListImagesRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListImagesResponse) => void): Request<Imagebuilder.Types.ListImagesResponse, AWSError>;
/**
* Returns the list of images that you have access to.
*/
listImages(callback?: (err: AWSError, data: Imagebuilder.Types.ListImagesResponse) => void): Request<Imagebuilder.Types.ListImagesResponse, AWSError>;
/**
* Returns a list of infrastructure configurations.
*/
listInfrastructureConfigurations(params: Imagebuilder.Types.ListInfrastructureConfigurationsRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListInfrastructureConfigurationsResponse) => void): Request<Imagebuilder.Types.ListInfrastructureConfigurationsResponse, AWSError>;
/**
* Returns a list of infrastructure configurations.
*/
listInfrastructureConfigurations(callback?: (err: AWSError, data: Imagebuilder.Types.ListInfrastructureConfigurationsResponse) => void): Request<Imagebuilder.Types.ListInfrastructureConfigurationsResponse, AWSError>;
/**
* Returns the list of tags for the specified resource.
*/
listTagsForResource(params: Imagebuilder.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListTagsForResourceResponse) => void): Request<Imagebuilder.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns the list of tags for the specified resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Imagebuilder.Types.ListTagsForResourceResponse) => void): Request<Imagebuilder.Types.ListTagsForResourceResponse, AWSError>;
/**
* Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
*/
putComponentPolicy(params: Imagebuilder.Types.PutComponentPolicyRequest, callback?: (err: AWSError, data: Imagebuilder.Types.PutComponentPolicyResponse) => void): Request<Imagebuilder.Types.PutComponentPolicyResponse, AWSError>;
/**
* Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
*/
putComponentPolicy(callback?: (err: AWSError, data: Imagebuilder.Types.PutComponentPolicyResponse) => void): Request<Imagebuilder.Types.PutComponentPolicyResponse, AWSError>;
/**
* Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
*/
putImagePolicy(params: Imagebuilder.Types.PutImagePolicyRequest, callback?: (err: AWSError, data: Imagebuilder.Types.PutImagePolicyResponse) => void): Request<Imagebuilder.Types.PutImagePolicyResponse, AWSError>;
/**
* Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
*/
putImagePolicy(callback?: (err: AWSError, data: Imagebuilder.Types.PutImagePolicyResponse) => void): Request<Imagebuilder.Types.PutImagePolicyResponse, AWSError>;
/**
* Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
*/
putImageRecipePolicy(params: Imagebuilder.Types.PutImageRecipePolicyRequest, callback?: (err: AWSError, data: Imagebuilder.Types.PutImageRecipePolicyResponse) => void): Request<Imagebuilder.Types.PutImageRecipePolicyResponse, AWSError>;
/**
* Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
*/
putImageRecipePolicy(callback?: (err: AWSError, data: Imagebuilder.Types.PutImageRecipePolicyResponse) => void): Request<Imagebuilder.Types.PutImageRecipePolicyResponse, AWSError>;
/**
* Manually triggers a pipeline to create an image.
*/
startImagePipelineExecution(params: Imagebuilder.Types.StartImagePipelineExecutionRequest, callback?: (err: AWSError, data: Imagebuilder.Types.StartImagePipelineExecutionResponse) => void): Request<Imagebuilder.Types.StartImagePipelineExecutionResponse, AWSError>;
/**
* Manually triggers a pipeline to create an image.
*/
startImagePipelineExecution(callback?: (err: AWSError, data: Imagebuilder.Types.StartImagePipelineExecutionResponse) => void): Request<Imagebuilder.Types.StartImagePipelineExecutionResponse, AWSError>;
/**
* Adds a tag to a resource.
*/
tagResource(params: Imagebuilder.Types.TagResourceRequest, callback?: (err: AWSError, data: Imagebuilder.Types.TagResourceResponse) => void): Request<Imagebuilder.Types.TagResourceResponse, AWSError>;
/**
* Adds a tag to a resource.
*/
tagResource(callback?: (err: AWSError, data: Imagebuilder.Types.TagResourceResponse) => void): Request<Imagebuilder.Types.TagResourceResponse, AWSError>;
/**
* Removes a tag from a resource.
*/
untagResource(params: Imagebuilder.Types.UntagResourceRequest, callback?: (err: AWSError, data: Imagebuilder.Types.UntagResourceResponse) => void): Request<Imagebuilder.Types.UntagResourceResponse, AWSError>;
/**
* Removes a tag from a resource.
*/
untagResource(callback?: (err: AWSError, data: Imagebuilder.Types.UntagResourceResponse) => void): Request<Imagebuilder.Types.UntagResourceResponse, AWSError>;
/**
* Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
*/
updateDistributionConfiguration(params: Imagebuilder.Types.UpdateDistributionConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.UpdateDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.UpdateDistributionConfigurationResponse, AWSError>;
/**
* Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
*/
updateDistributionConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.UpdateDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.UpdateDistributionConfigurationResponse, AWSError>;
/**
* Updates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
*/
updateImagePipeline(params: Imagebuilder.Types.UpdateImagePipelineRequest, callback?: (err: AWSError, data: Imagebuilder.Types.UpdateImagePipelineResponse) => void): Request<Imagebuilder.Types.UpdateImagePipelineResponse, AWSError>;
/**
* Updates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
*/
updateImagePipeline(callback?: (err: AWSError, data: Imagebuilder.Types.UpdateImagePipelineResponse) => void): Request<Imagebuilder.Types.UpdateImagePipelineResponse, AWSError>;
/**
* Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
*/
updateInfrastructureConfiguration(params: Imagebuilder.Types.UpdateInfrastructureConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.UpdateInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.UpdateInfrastructureConfigurationResponse, AWSError>;
/**
* Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
*/
updateInfrastructureConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.UpdateInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.UpdateInfrastructureConfigurationResponse, AWSError>;
}
declare namespace Imagebuilder {
export type AccountList = NonEmptyString[];
export interface Ami {
/**
* The AWS Region of the EC2 AMI.
*/
region?: NonEmptyString;
/**
* The AMI ID of the EC2 AMI.
*/
image?: NonEmptyString;
/**
* The name of the EC2 AMI.
*/
name?: NonEmptyString;
/**
* The description of the EC2 AMI.
*/
description?: NonEmptyString;
state?: ImageState;
}
export interface AmiDistributionConfiguration {
/**
* The name of the distribution configuration.
*/
name?: AmiNameString;
/**
* The description of the distribution configuration.
*/
description?: NonEmptyString;
/**
* The tags to apply to AMIs distributed to this Region.
*/
amiTags?: TagMap;
/**
* The KMS key identifier used to encrypt the distributed image.
*/
kmsKeyId?: NonEmptyString;
/**
* Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
*/
launchPermission?: LaunchPermissionConfiguration;
}
export type AmiList = Ami[];
export type AmiNameString = string;
export type Arn = string;
export type ArnList = Arn[];
export interface CancelImageCreationRequest {
/**
* The Amazon Resource Name (ARN) of the image whose creation you want to cancel.
*/
imageBuildVersionArn: ImageBuildVersionArn;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken: ClientToken;
}
export interface CancelImageCreationResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the image whose creation has been cancelled.
*/
imageBuildVersionArn?: ImageBuildVersionArn;
}
export type ClientToken = string;
export interface Component {
/**
* The Amazon Resource Name (ARN) of the component.
*/
arn?: ImageBuilderArn;
/**
* The name of the component.
*/
name?: ResourceName;
/**
* The version of the component.
*/
version?: VersionNumber;
/**
* The description of the component.
*/
description?: NonEmptyString;
/**
* The change description of the component.
*/
changeDescription?: NonEmptyString;
/**
* The type of the component denotes whether the component is used to build the image or only to test it.
*/
type?: ComponentType;
/**
* The platform of the component.
*/
platform?: Platform;
/**
* The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.
*/
supportedOsVersions?: OsVersionList;
/**
* The owner of the component.
*/
owner?: NonEmptyString;
/**
* The data of the component.
*/
data?: ComponentData;
/**
* The KMS key identifier used to encrypt the component.
*/
kmsKeyId?: NonEmptyString;
/**
* The encryption status of the component.
*/
encrypted?: NullableBoolean;
/**
* The date that the component was created.
*/
dateCreated?: DateTime;
/**
* The tags associated with the component.
*/
tags?: TagMap;
}
export type ComponentBuildVersionArn = string;
export interface ComponentConfiguration {
/**
* The Amazon Resource Name (ARN) of the component.
*/
componentArn: ComponentVersionArnOrBuildVersionArn;
}
export type ComponentConfigurationList = ComponentConfiguration[];
export type ComponentData = string;
export type ComponentFormat = "SHELL"|string;
export interface ComponentSummary {
/**
* The Amazon Resource Name (ARN) of the component.
*/
arn?: ImageBuilderArn;
/**
* The name of the component.
*/
name?: ResourceName;
/**
* The version of the component.
*/
version?: VersionNumber;
/**
* The platform of the component.
*/
platform?: Platform;
/**
* The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.
*/
supportedOsVersions?: OsVersionList;
/**
* The type of the component denotes whether the component is used to build the image or only to test it.
*/
type?: ComponentType;
/**
* The owner of the component.
*/
owner?: NonEmptyString;
/**
* The description of the component.
*/
description?: NonEmptyString;
/**
* The change description of the component.
*/
changeDescription?: NonEmptyString;
/**
* The date that the component was created.
*/
dateCreated?: DateTime;
/**
* The tags associated with the component.
*/
tags?: TagMap;
}
export type ComponentSummaryList = ComponentSummary[];
export type ComponentType = "BUILD"|"TEST"|string;
export interface ComponentVersion {
/**
* The Amazon Resource Name (ARN) of the component.
*/
arn?: ImageBuilderArn;
/**
* The name of the component.
*/
name?: ResourceName;
/**
* The semantic version of the component.
*/
version?: VersionNumber;
/**
* The description of the component.
*/
description?: NonEmptyString;
/**
* The platform of the component.
*/
platform?: Platform;
/**
* The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.
*/
supportedOsVersions?: OsVersionList;
/**
* The type of the component denotes whether the component is used to build the image or only to test it.
*/
type?: ComponentType;
/**
* The owner of the component.
*/
owner?: NonEmptyString;
/**
* The date that the component was created.
*/
dateCreated?: DateTime;
}
export type ComponentVersionArn = string;
export type ComponentVersionArnOrBuildVersionArn = string;
export type ComponentVersionList = ComponentVersion[];
export interface CreateComponentRequest {
/**
* The name of the component.
*/
name: ResourceName;
/**
* The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).
*/
semanticVersion: VersionNumber;
/**
* The description of the component. Describes the contents of the component.
*/
description?: NonEmptyString;
/**
* 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 this component.
*/
changeDescription?: NonEmptyString;
/**
* The platform of the component.
*/
platform: Platform;
/**
* The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.
*/
supportedOsVersions?: OsVersionList;
/**
* 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?: InlineComponentData;
/**
* The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use 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?: Uri;
/**
* The ID of the KMS key that should be used to encrypt this component.
*/
kmsKeyId?: NonEmptyString;
/**
* The tags of the component.
*/
tags?: TagMap;
/**
* The idempotency token of the component.
*/
clientToken: ClientToken;
}
export interface CreateComponentResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the component that was created by this request.
*/
componentBuildVersionArn?: ComponentBuildVersionArn;
}
export interface CreateDistributionConfigurationRequest {
/**
* The name of the distribution configuration.
*/
name: ResourceName;
/**
* The description of the distribution configuration.
*/
description?: NonEmptyString;
/**
* The distributions of the distribution configuration.
*/
distributions: DistributionList;
/**
* The tags of the distribution configuration.
*/
tags?: TagMap;
/**
* The idempotency token of the distribution configuration.
*/
clientToken: ClientToken;
}
export interface CreateDistributionConfigurationResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.
*/
distributionConfigurationArn?: DistributionConfigurationArn;
}
export interface CreateImagePipelineRequest {
/**
* The name of the image pipeline.
*/
name: ResourceName;
/**
* The description of the image pipeline.
*/
description?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.
*/
imageRecipeArn: ImageRecipeArn;
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.
*/
infrastructureConfigurationArn: InfrastructureConfigurationArn;
/**
* The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.
*/
distributionConfigurationArn?: DistributionConfigurationArn;
/**
* The image test configuration of the image pipeline.
*/
imageTestsConfiguration?: ImageTestsConfiguration;
/**
* 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?: NullableBoolean;
/**
* The schedule of the image pipeline.
*/
schedule?: Schedule;
/**
* The status of the image pipeline.
*/
status?: PipelineStatus;
/**
* The tags of the image pipeline.
*/
tags?: TagMap;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken: ClientToken;
}
export interface CreateImagePipelineResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the image pipeline that was created by this request.
*/
imagePipelineArn?: ImagePipelineArn;
}
export interface CreateImageRecipeRequest {
/**
* The name of the image recipe.
*/
name: ResourceName;
/**
* The description of the image recipe.
*/
description?: NonEmptyString;
/**
* The semantic version of the image recipe.
*/
semanticVersion: VersionNumber;
/**
* The components of the image recipe.
*/
components: ComponentConfigurationList;
/**
* The parent image of the image recipe. The value of the string can be the ARN of the parent 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/2019.x.x. The ARN ends with /20xx.x.x, which communicates to EC2 Image Builder that you want to use the latest AMI created in 20xx (year). 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.
*/
parentImage: NonEmptyString;
/**
* The block device mappings of the image recipe.
*/
blockDeviceMappings?: InstanceBlockDeviceMappings;
/**
* The tags of the image recipe.
*/
tags?: TagMap;
/**
* The working directory to be used during build and test workflows.
*/
workingDirectory?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken: ClientToken;
}
export interface CreateImageRecipeResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the image recipe that was created by this request.
*/
imageRecipeArn?: ImageRecipeArn;
}
export interface CreateImageRequest {
/**
* The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
*/
imageRecipeArn: ImageRecipeArn;
/**
* The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
*/
distributionConfigurationArn?: DistributionConfigurationArn;
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
*/
infrastructureConfigurationArn: InfrastructureConfigurationArn;
/**
* The image tests configuration of the image.
*/
imageTestsConfiguration?: ImageTestsConfiguration;
/**
* 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?: NullableBoolean;
/**
* The tags of the image.
*/
tags?: TagMap;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken: ClientToken;
}
export interface CreateImageResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the image that was created by this request.
*/
imageBuildVersionArn?: ImageBuildVersionArn;
}
export interface CreateInfrastructureConfigurationRequest {
/**
* The name of the infrastructure configuration.
*/
name: ResourceName;
/**
* The description of the infrastructure configuration.
*/
description?: NonEmptyString;
/**
* 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?: InstanceTypeList;
/**
* The instance profile to associate with the instance used to customize your EC2 AMI.
*/
instanceProfileName: NonEmptyString;
/**
* The security group IDs to associate with the instance used to customize your EC2 AMI.
*/
securityGroupIds?: SecurityGroupIds;
/**
* The subnet ID in which to place the instance used to customize your EC2 AMI.
*/
subnetId?: NonEmptyString;
/**
* The logging configuration of the infrastructure configuration.
*/
logging?: Logging;
/**
* The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image.
*/
keyPair?: NonEmptyString;
/**
* 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?: NullableBoolean;
/**
* The SNS topic on which to send image build events.
*/
snsTopicArn?: SnsTopicArn;
/**
* The tags attached to the resource created by Image Builder.
*/
resourceTags?: ResourceTagMap;
/**
* The tags of the infrastructure configuration.
*/
tags?: TagMap;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken: ClientToken;
}
export interface CreateInfrastructureConfigurationResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.
*/
infrastructureConfigurationArn?: InfrastructureConfigurationArn;
}
export type DateTime = string;
export interface DeleteComponentRequest {
/**
* The Amazon Resource Name (ARN) of the component build version to delete.
*/
componentBuildVersionArn: ComponentBuildVersionArn;
}
export interface DeleteComponentResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the component build version that was deleted.
*/
componentBuildVersionArn?: ComponentBuildVersionArn;
}
export interface DeleteDistributionConfigurationRequest {
/**
* The Amazon Resource Name (ARN) of the distribution configuration to delete.
*/
distributionConfigurationArn: DistributionConfigurationArn;
}
export interface DeleteDistributionConfigurationResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the distribution configuration that was deleted.
*/
distributionConfigurationArn?: DistributionConfigurationArn;
}
export interface DeleteImagePipelineRequest {
/**
* The Amazon Resource Name (ARN) of the image pipeline to delete.
*/
imagePipelineArn: ImagePipelineArn;
}
export interface DeleteImagePipelineResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the image pipeline that was deleted.
*/
imagePipelineArn?: ImagePipelineArn;
}
export interface DeleteImageRecipeRequest {
/**
* The Amazon Resource Name (ARN) of the image recipe to delete.
*/
imageRecipeArn: ImageRecipeArn;
}
export interface DeleteImageRecipeResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the image recipe that was deleted.
*/
imageRecipeArn?: ImageRecipeArn;
}
export interface DeleteImageRequest {
/**
* The Amazon Resource Name (ARN) of the image to delete.
*/
imageBuildVersionArn: ImageBuildVersionArn;
}
export interface DeleteImageResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the image that was deleted.
*/
imageBuildVersionArn?: ImageBuildVersionArn;
}
export interface DeleteInfrastructureConfigurationRequest {
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
*/
infrastructureConfigurationArn: InfrastructureConfigurationArn;
}
export interface DeleteInfrastructureConfigurationResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.
*/
infrastructureConfigurationArn?: InfrastructureConfigurationArn;
}
export interface Distribution {
/**
* The target Region.
*/
region: NonEmptyString;
/**
* The specific AMI settings (for example, launch permissions, AMI tags).
*/
amiDistributionConfiguration?: AmiDistributionConfiguration;
/**
* The License Manager Configuration to associate with the AMI in the specified Region.
*/
licenseConfigurationArns?: ArnList;
}
export interface DistributionConfiguration {
/**
* The Amazon Resource Name (ARN) of the distribution configuration.
*/
arn?: ImageBuilderArn;
/**
* The name of the distribution configuration.
*/
name?: ResourceName;
/**
* The description of the distribution configuration.
*/
description?: NonEmptyString;
/**
* The distributions of the distribution configuration.
*/
distributions?: DistributionList;
/**
* The maximum duration in minutes for this distribution configuration.
*/
timeoutMinutes: DistributionTimeoutMinutes;
/**
* The date on which this distribution configuration was created.
*/
dateCreated?: DateTime;
/**
* The date on which this distribution configuration was last updated.
*/
dateUpdated?: DateTime;
/**
* The tags of the distribution configuration.
*/
tags?: TagMap;
}
export type DistributionConfigurationArn = string;
export interface DistributionConfigurationSummary {
/**
* The Amazon Resource Name (ARN) of the distribution configuration.
*/
arn?: ImageBuilderArn;
/**
* The name of the distribution configuration.
*/
name?: ResourceName;
/**
* The description of the distribution configuration.
*/
description?: NonEmptyString;
/**
* The date on which the distribution configuration was created.
*/
dateCreated?: DateTime;
/**
* The date on which the distribution configuration was updated.
*/
dateUpdated?: DateTime;
/**
* The tags associated with the distribution configuration.
*/
tags?: TagMap;
}
export type DistributionConfigurationSummaryList = DistributionConfigurationSummary[];
export type DistributionList = Distribution[];
export type Distributio