type
stringclasses 7
values | content
stringlengths 4
9.55k
| repo
stringlengths 7
96
| path
stringlengths 4
178
| language
stringclasses 1
value |
|---|---|---|---|---|
ArrowFunction |
(obj: ListComponentsResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListDistributionConfigurationsRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListDistributionConfigurationsResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListImageBuildVersionsRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ImageSummary): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListImageBuildVersionsResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListImagePipelineImagesRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListImagePipelineImagesResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListImagePipelinesRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListImagePipelinesResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListImageRecipesRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ImageRecipeSummary): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListImageRecipesResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListImagesRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ImageVersion): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListImagesResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListInfrastructureConfigurationsRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: InfrastructureConfigurationSummary): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListInfrastructureConfigurationsResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: InvalidParameterException): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListTagsForResourceRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: ListTagsForResourceResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: PutComponentPolicyRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: PutComponentPolicyResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: PutImagePolicyRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: PutImagePolicyResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: PutImageRecipePolicyRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: PutImageRecipePolicyResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: StartImagePipelineExecutionRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: StartImagePipelineExecutionResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: TagResourceResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: UntagResourceResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: UpdateDistributionConfigurationRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: UpdateDistributionConfigurationResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: UpdateImagePipelineRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: UpdateImagePipelineResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: UpdateInfrastructureConfigurationRequest): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
ArrowFunction |
(obj: UpdateInfrastructureConfigurationResponse): any => ({
...obj,
}) | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p> Image state shows the image status and the reason for that status. </p>
*/
export interface ImageState {
/**
* <p>The status of the image. </p>
*/
status?: ImageStatus | string;
/**
* <p>The reason for the image's status. </p>
*/
reason?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p> Details of an EC2 AMI. </p>
*/
export interface Ami {
/**
* <p>The description of the EC2 AMI. </p>
*/
description?: string;
/**
* <p>The AMI ID of the EC2 AMI. </p>
*/
image?: string;
/**
* <p> Image state shows the image status and the reason for that status. </p>
*/
state?: ImageState;
/**
* <p>The name of the EC2 AMI. </p>
*/
name?: string;
/**
* <p>The AWS Region of the EC2 AMI. </p>
*/
region?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>Describes the configuration for a launch permission. The launch permission modification request is sent to the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html">EC2 ModifyImageAttribute</a> API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to <code>all</code>. See the examples for making an AMI public at <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html">EC2 ModifyImageAttribute</a>. </p>
*/
export interface LaunchPermissionConfiguration {
/**
* <p>The name of the group. </p>
*/
userGroups?: string[];
/**
* <p>The AWS account ID. </p>
*/
userIds?: string[];
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p> Define and configure the output AMIs of the pipeline. </p>
*/
export interface AmiDistributionConfiguration {
/**
* <p>The tags to apply to AMIs distributed to this Region. </p>
*/
amiTags?: { [key: string]: string };
/**
* <p>The description of the distribution configuration. </p>
*/
description?: string;
/**
* <p>The name of the distribution configuration. </p>
*/
name?: string;
/**
* <p> Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances. </p>
*/
launchPermission?: LaunchPermissionConfiguration;
/**
* <p> The KMS key identifier used to encrypt the distributed image. </p>
*/
kmsKeyId?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>You have exceeded the permitted request rate for the specific operation.</p>
*/
export interface CallRateLimitExceededException extends __SmithyException, $MetadataBearer {
name: "CallRateLimitExceededException";
$fault: "client";
message?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface CancelImageCreationRequest {
/**
* <p>The Amazon Resource Name (ARN) of the image whose creation you want to cancel.</p>
*/
imageBuildVersionArn: string | undefined;
/**
* <p>The idempotency token used to make this request idempotent.</p>
*/
clientToken?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface CancelImageCreationResponse {
/**
* <p>The request ID that uniquely identifies this request.</p>
*/
requestId?: string;
/**
* <p>The idempotency token used to make this request idempotent.</p>
*/
clientToken?: string;
/**
* <p>The Amazon Resource Name (ARN) of the image whose creation has been cancelled.</p>
*/
imageBuildVersionArn?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.</p>
*/
export interface ClientException extends __SmithyException, $MetadataBearer {
name: "ClientException";
$fault: "client";
message?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>You are not authorized to perform the requested operation.</p>
*/
export interface ForbiddenException extends __SmithyException, $MetadataBearer {
name: "ForbiddenException";
$fault: "client";
message?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.</p>
*/
export interface IdempotentParameterMismatchException extends __SmithyException, $MetadataBearer {
name: "IdempotentParameterMismatchException";
$fault: "client";
message?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>You have made a request for an action that is not supported by the service.</p>
*/
export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
name: "InvalidRequestException";
$fault: "client";
message?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>The resource that you are trying to operate on is currently in use. Review the message details and retry later.</p>
*/
export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
name: "ResourceInUseException";
$fault: "client";
message?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>This exception is thrown when the service encounters an unrecoverable exception.</p>
*/
export interface ServiceException extends __SmithyException, $MetadataBearer {
name: "ServiceException";
$fault: "server";
message?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>The service is unable to process your request at this time.</p>
*/
export interface ServiceUnavailableException extends __SmithyException, $MetadataBearer {
name: "ServiceUnavailableException";
$fault: "server";
message?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>A detailed view of a component.</p>
*/
export interface Component {
/**
* <p>The owner of the component.</p>
*/
owner?: string;
/**
* <p>The change description of the component.</p>
*/
changeDescription?: string;
/**
* <p>The Amazon Resource Name (ARN) of the component.</p>
*/
arn?: string;
/**
* <p>The tags associated with the component.</p>
*/
tags?: { [key: string]: string };
/**
* <p>The type of the component denotes whether the component is used to build the image or only to test it.</p>
*/
type?: ComponentType | string;
/**
* <p>The platform of the component.</p>
*/
platform?: Platform | string;
/**
* <p>The version of the component.</p>
*/
version?: string;
/**
* <p>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. </p>
*/
supportedOsVersions?: string[];
/**
* <p>The date that the component was created.</p>
*/
dateCreated?: string;
/**
* <p>The description of the component.</p>
*/
description?: string;
/**
* <p>The KMS key identifier used to encrypt the component.</p>
*/
kmsKeyId?: string;
/**
* <p>The name of the component.</p>
*/
name?: string;
/**
* <p>The encryption status of the component.</p>
*/
encrypted?: boolean;
/**
* <p>The data of the component.</p>
*/
data?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p> Configuration details of the component. </p>
*/
export interface ComponentConfiguration {
/**
* <p>The Amazon Resource Name (ARN) of the component. </p>
*/
componentArn: string | undefined;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>A high-level summary of a component.</p>
*/
export interface ComponentSummary {
/**
* <p>The name of the component.</p>
*/
name?: string;
/**
* <p>The description of the component.</p>
*/
description?: string;
/**
* <p>The type of the component denotes whether the component is used to build the image or only to test it.</p>
*/
type?: ComponentType | string;
/**
* <p>The tags associated with the component.</p>
*/
tags?: { [key: string]: string };
/**
* <p>The version of the component.</p>
*/
version?: string;
/**
* <p>The Amazon Resource Name (ARN) of the component.</p>
*/
arn?: string;
/**
* <p>The platform of the component.</p>
*/
platform?: Platform | string;
/**
* <p>The owner of the component.</p>
*/
owner?: string;
/**
* <p>The change description of the component.</p>
*/
changeDescription?: string;
/**
* <p>The date that the component was created.</p>
*/
dateCreated?: string;
/**
* <p>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. </p>
*/
supportedOsVersions?: string[];
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>A high-level overview of a component semantic version.</p>
*/
export interface ComponentVersion {
/**
* <p>The Amazon Resource Name (ARN) of the component.</p>
*/
arn?: string;
/**
* <p>The owner of the component.</p>
*/
owner?: string;
/**
* <p> 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. </p>
*/
supportedOsVersions?: string[];
/**
* <p>The semantic version of the component.</p>
*/
version?: string;
/**
* <p>The date that the component was created.</p>
*/
dateCreated?: string;
/**
* <p>The description of the component.</p>
*/
description?: string;
/**
* <p>The name of the component.</p>
*/
name?: string;
/**
* <p>The platform of the component.</p>
*/
platform?: Platform | string;
/**
* <p>The type of the component denotes whether the component is used to build the image or only to test it.</p>
*/
type?: ComponentType | string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface CreateComponentRequest {
/**
* <p>The tags of the component.</p>
*/
tags?: { [key: string]: string };
/**
* <p> 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. </p>
*/
supportedOsVersions?: string[];
/**
* <p>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).</p>
*/
semanticVersion: string | undefined;
/**
* <p>The ID of the KMS key that should be used to encrypt this component.</p>
*/
kmsKeyId?: string;
/**
* <p>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.</p>
*/
changeDescription?: string;
/**
* <p>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 <code>data</code> or <code>uri</code> can be used to specify the data within the component.</p>
*/
uri?: string;
/**
* <p>The name of the component.</p>
*/
name: string | undefined;
/**
* <p>The data of the component. Used to specify the data inline. Either <code>data</code> or <code>uri</code> can be used to specify the data within the component.</p>
*/
data?: string;
/**
* <p>The platform of the component.</p>
*/
platform: Platform | string | undefined;
/**
* <p>The idempotency token of the component.</p>
*/
clientToken?: string;
/**
* <p>The description of the component. Describes the contents of the component.</p>
*/
description?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface CreateComponentResponse {
/**
* <p>The Amazon Resource Name (ARN) of the component that was created by this request.</p>
*/
componentBuildVersionArn?: string;
/**
* <p>The idempotency token used to make this request idempotent.</p>
*/
clientToken?: string;
/**
* <p>The request ID that uniquely identifies this request.</p>
*/
requestId?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>You have specified two or more mutually exclusive parameters. Review the error message for details.</p>
*/
export interface InvalidParameterCombinationException extends __SmithyException, $MetadataBearer {
name: "InvalidParameterCombinationException";
$fault: "client";
message?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>Your version number is out of bounds or does not follow the required syntax.</p>
*/
export interface InvalidVersionNumberException extends __SmithyException, $MetadataBearer {
name: "InvalidVersionNumberException";
$fault: "client";
message?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>You have exceeded the number of permitted resources or operations for this service. For service quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder">EC2 Image Builder endpoints and quotas</a>.</p>
*/
export interface ServiceQuotaExceededException extends __SmithyException, $MetadataBearer {
name: "ServiceQuotaExceededException";
$fault: "client";
message?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p> Defines the settings for a specific Region. </p>
*/
export interface Distribution {
/**
* <p>The specific AMI settings (for example, launch permissions, AMI tags). </p>
*/
amiDistributionConfiguration?: AmiDistributionConfiguration;
/**
* <p>The License Manager Configuration to associate with the AMI in the specified Region.</p>
*/
licenseConfigurationArns?: string[];
/**
* <p>The target Region. </p>
*/
region: string | undefined;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface CreateDistributionConfigurationRequest {
/**
* <p> The description of the distribution configuration. </p>
*/
description?: string;
/**
* <p> The idempotency token of the distribution configuration. </p>
*/
clientToken?: string;
/**
* <p> The name of the distribution configuration. </p>
*/
name: string | undefined;
/**
* <p> The tags of the distribution configuration. </p>
*/
tags?: { [key: string]: string };
/**
* <p> The distributions of the distribution configuration. </p>
*/
distributions: Distribution[] | undefined;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface CreateDistributionConfigurationResponse {
/**
* <p> The idempotency token used to make this request idempotent. </p>
*/
clientToken?: string;
/**
* <p> The request ID that uniquely identifies this request. </p>
*/
requestId?: string;
/**
* <p> The Amazon Resource Name (ARN) of the distribution configuration that was created by this request. </p>
*/
distributionConfigurationArn?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>The resource that you are trying to create already exists.</p>
*/
export interface ResourceAlreadyExistsException extends __SmithyException, $MetadataBearer {
name: "ResourceAlreadyExistsException";
$fault: "client";
message?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>Image tests configuration.</p>
*/
export interface ImageTestsConfiguration {
/**
* <p>The maximum time in minutes that tests are permitted to run.</p>
*/
timeoutMinutes?: number;
/**
* <p>Defines if tests should be executed when building this image.</p>
*/
imageTestsEnabled?: boolean;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface CreateImageRequest {
/**
* <p> The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested. </p>
*/
infrastructureConfigurationArn: string | undefined;
/**
* <p> The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline. </p>
*/
distributionConfigurationArn?: string;
/**
* <p> 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. </p>
*/
enhancedImageMetadataEnabled?: boolean;
/**
* <p> The tags of the image. </p>
*/
tags?: { [key: string]: string };
/**
* <p> The image tests configuration of the image. </p>
*/
imageTestsConfiguration?: ImageTestsConfiguration;
/**
* <p> The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed. </p>
*/
imageRecipeArn: string | undefined;
/**
* <p> The idempotency token used to make this request idempotent. </p>
*/
clientToken?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface CreateImageResponse {
/**
* <p> The idempotency token used to make this request idempotent. </p>
*/
clientToken?: string;
/**
* <p> The request ID that uniquely identifies this request. </p>
*/
requestId?: string;
/**
* <p> The Amazon Resource Name (ARN) of the image that was created by this request. </p>
*/
imageBuildVersionArn?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>A schedule configures how often and when a pipeline will automatically create a new image. </p>
*/
export interface Schedule {
/**
* <p>The expression determines how often EC2 Image Builder evaluates your <code>pipelineExecutionStartCondition</code>.</p>
*/
scheduleExpression?: string;
/**
* <p>The condition configures when the pipeline should trigger a new image build. When the <code>pipelineExecutionStartCondition</code> is set to <code>EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE</code>, EC2 Image Builder will build a new image only when there are known changes pending. When it is set to <code>EXPRESSION_MATCH_ONLY</code>, it will build a new image every time the CRON expression matches the current time.</p>
*/
pipelineExecutionStartCondition?: PipelineExecutionStartCondition | string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface CreateImagePipelineRequest {
/**
* <p> The tags of the image pipeline. </p>
*/
tags?: { [key: string]: string };
/**
* <p> The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline. </p>
*/
imageRecipeArn: string | undefined;
/**
* <p> The status of the image pipeline. </p>
*/
status?: PipelineStatus | string;
/**
* <p> The idempotency token used to make this request idempotent. </p>
*/
clientToken?: string;
/**
* <p> The schedule of the image pipeline. </p>
*/
schedule?: Schedule;
/**
* <p> The image test configuration of the image pipeline. </p>
*/
imageTestsConfiguration?: ImageTestsConfiguration;
/**
* <p> The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline. </p>
*/
infrastructureConfigurationArn: string | undefined;
/**
* <p> 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. </p>
*/
enhancedImageMetadataEnabled?: boolean;
/**
* <p> The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline. </p>
*/
distributionConfigurationArn?: string;
/**
* <p> The name of the image pipeline. </p>
*/
name: string | undefined;
/**
* <p> The description of the image pipeline. </p>
*/
description?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface CreateImagePipelineResponse {
/**
* <p> The idempotency token used to make this request idempotent. </p>
*/
clientToken?: string;
/**
* <p> The Amazon Resource Name (ARN) of the image pipeline that was created by this request. </p>
*/
imagePipelineArn?: string;
/**
* <p> The request ID that uniquely identifies this request. </p>
*/
requestId?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>Amazon EBS-specific block device mapping specifications.</p>
*/
export interface EbsInstanceBlockDeviceSpecification {
/**
* <p>Use to configure delete on termination of the associated device.</p>
*/
deleteOnTermination?: boolean;
/**
* <p>Use to override the device's volume type.</p>
*/
volumeType?: EbsVolumeType | string;
/**
* <p>Use to configure the KMS key to use when encrypting the device.</p>
*/
kmsKeyId?: string;
/**
* <p>Use to configure device IOPS.</p>
*/
iops?: number;
/**
* <p>The snapshot that defines the device contents.</p>
*/
snapshotId?: string;
/**
* <p>Use to configure device encryption.</p>
*/
encrypted?: boolean;
/**
* <p>Use to override the device's volume size.</p>
*/
volumeSize?: number;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>Defines block device mappings for the instance used to configure your image.</p>
*/
export interface InstanceBlockDeviceMapping {
/**
* <p>Use to remove a mapping from the parent image.</p>
*/
noDevice?: string;
/**
* <p>The device to which these mappings apply.</p>
*/
deviceName?: string;
/**
* <p>Use to manage Amazon EBS-specific configuration for this mapping.</p>
*/
ebs?: EbsInstanceBlockDeviceSpecification;
/**
* <p>Use to manage instance ephemeral devices.</p>
*/
virtualName?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface CreateImageRecipeRequest {
/**
* <p>The components of the image recipe. </p>
*/
components: ComponentConfiguration[] | undefined;
/**
* <p>The idempotency token used to make this request idempotent. </p>
*/
clientToken?: string;
/**
* <p>The working directory to be used during build and test workflows.</p>
*/
workingDirectory?: string;
/**
* <p>The block device mappings of the image recipe. </p>
*/
blockDeviceMappings?: InstanceBlockDeviceMapping[];
/**
* <p>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: <code>arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x</code>. The ARN ends with <code>/20xx.x.x</code>, 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. </p>
*/
parentImage: string | undefined;
/**
* <p> The name of the image recipe. </p>
*/
name: string | undefined;
/**
* <p> The description of the image recipe. </p>
*/
description?: string;
/**
* <p> The tags of the image recipe. </p>
*/
tags?: { [key: string]: string };
/**
* <p>The semantic version of the image recipe. </p>
*/
semanticVersion: string | undefined;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface CreateImageRecipeResponse {
/**
* <p>The request ID that uniquely identifies this request. </p>
*/
requestId?: string;
/**
* <p>The Amazon Resource Name (ARN) of the image recipe that was created by this request. </p>
*/
imageRecipeArn?: string;
/**
* <p>The idempotency token used to make this request idempotent. </p>
*/
clientToken?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>Amazon S3 logging configuration.</p>
*/
export interface S3Logs {
/**
* <p>The Amazon S3 path in which to store the logs.</p>
*/
s3KeyPrefix?: string;
/**
* <p>The Amazon S3 bucket in which to store the logs.</p>
*/
s3BucketName?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>Logging configuration defines where Image Builder uploads your logs.</p>
*/
export interface Logging {
/**
* <p>The Amazon S3 logging configuration.</p>
*/
s3Logs?: S3Logs;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface CreateInfrastructureConfigurationRequest {
/**
* <p>The subnet ID in which to place the instance used to customize your EC2 AMI. </p>
*/
subnetId?: string;
/**
* <p>The description of the infrastructure configuration. </p>
*/
description?: string;
/**
* <p>The idempotency token used to make this request idempotent. </p>
*/
clientToken?: string;
/**
* <p>The tags of the infrastructure configuration. </p>
*/
tags?: { [key: string]: string };
/**
* <p>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. </p>
*/
terminateInstanceOnFailure?: boolean;
/**
* <p>The tags attached to the resource created by Image Builder.</p>
*/
resourceTags?: { [key: string]: string };
/**
* <p>The SNS topic on which to send image build events. </p>
*/
snsTopicArn?: string;
/**
* <p>The security group IDs to associate with the instance used to customize your EC2 AMI. </p>
*/
securityGroupIds?: string[];
/**
* <p>The instance profile to associate with the instance used to customize your EC2 AMI. </p>
*/
instanceProfileName: string | undefined;
/**
* <p>The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image. </p>
*/
keyPair?: string;
/**
* <p>The logging configuration of the infrastructure configuration. </p>
*/
logging?: Logging;
/**
* <p>The name of the infrastructure configuration. </p>
*/
name: string | undefined;
/**
* <p>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. </p>
*/
instanceTypes?: string[];
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface CreateInfrastructureConfigurationResponse {
/**
* <p>The idempotency token used to make this request idempotent. </p>
*/
clientToken?: string;
/**
* <p>The request ID that uniquely identifies this request. </p>
*/
requestId?: string;
/**
* <p>The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request. </p>
*/
infrastructureConfigurationArn?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface DeleteComponentRequest {
/**
* <p>The Amazon Resource Name (ARN) of the component build version to delete. </p>
*/
componentBuildVersionArn: string | undefined;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface DeleteComponentResponse {
/**
* <p>The request ID that uniquely identifies this request. </p>
*/
requestId?: string;
/**
* <p>The Amazon Resource Name (ARN) of the component build version that was deleted. </p>
*/
componentBuildVersionArn?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.</p>
*/
export interface ResourceDependencyException extends __SmithyException, $MetadataBearer {
name: "ResourceDependencyException";
$fault: "client";
message?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface DeleteDistributionConfigurationRequest {
/**
* <p>The Amazon Resource Name (ARN) of the distribution configuration to delete. </p>
*/
distributionConfigurationArn: string | undefined;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface DeleteDistributionConfigurationResponse {
/**
* <p>The request ID that uniquely identifies this request. </p>
*/
requestId?: string;
/**
* <p>The Amazon Resource Name (ARN) of the distribution configuration that was deleted. </p>
*/
distributionConfigurationArn?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface DeleteImageRequest {
/**
* <p>The Amazon Resource Name (ARN) of the image to delete. </p>
*/
imageBuildVersionArn: string | undefined;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface DeleteImageResponse {
/**
* <p>The request ID that uniquely identifies this request. </p>
*/
requestId?: string;
/**
* <p>The Amazon Resource Name (ARN) of the image that was deleted. </p>
*/
imageBuildVersionArn?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface DeleteImagePipelineRequest {
/**
* <p>The Amazon Resource Name (ARN) of the image pipeline to delete. </p>
*/
imagePipelineArn: string | undefined;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface DeleteImagePipelineResponse {
/**
* <p>The Amazon Resource Name (ARN) of the image pipeline that was deleted. </p>
*/
imagePipelineArn?: string;
/**
* <p>The request ID that uniquely identifies this request. </p>
*/
requestId?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface DeleteImageRecipeRequest {
/**
* <p>The Amazon Resource Name (ARN) of the image recipe to delete. </p>
*/
imageRecipeArn: string | undefined;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface DeleteImageRecipeResponse {
/**
* <p>The Amazon Resource Name (ARN) of the image recipe that was deleted. </p>
*/
imageRecipeArn?: string;
/**
* <p>The request ID that uniquely identifies this request. </p>
*/
requestId?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface DeleteInfrastructureConfigurationRequest {
/**
* <p>The Amazon Resource Name (ARN) of the infrastructure configuration to delete. </p>
*/
infrastructureConfigurationArn: string | undefined;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface DeleteInfrastructureConfigurationResponse {
/**
* <p>The request ID that uniquely identifies this request. </p>
*/
requestId?: string;
/**
* <p>The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted. </p>
*/
infrastructureConfigurationArn?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>A distribution configuration.</p>
*/
export interface DistributionConfiguration {
/**
* <p>The description of the distribution configuration.</p>
*/
description?: string;
/**
* <p>The maximum duration in minutes for this distribution configuration.</p>
*/
timeoutMinutes: number | undefined;
/**
* <p>The name of the distribution configuration.</p>
*/
name?: string;
/**
* <p>The Amazon Resource Name (ARN) of the distribution configuration.</p>
*/
arn?: string;
/**
* <p>The date on which this distribution configuration was last updated.</p>
*/
dateUpdated?: string;
/**
* <p>The tags of the distribution configuration.</p>
*/
tags?: { [key: string]: string };
/**
* <p>The distributions of the distribution configuration.</p>
*/
distributions?: Distribution[];
/**
* <p>The date on which this distribution configuration was created.</p>
*/
dateCreated?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>A high-level overview of a distribution configuration.</p>
*/
export interface DistributionConfigurationSummary {
/**
* <p>The Amazon Resource Name (ARN) of the distribution configuration.</p>
*/
arn?: string;
/**
* <p>The date on which the distribution configuration was updated.</p>
*/
dateUpdated?: string;
/**
* <p>The date on which the distribution configuration was created.</p>
*/
dateCreated?: string;
/**
* <p>The description of the distribution configuration.</p>
*/
description?: string;
/**
* <p>The name of the distribution configuration.</p>
*/
name?: string;
/**
* <p>The tags associated with the distribution configuration.</p>
*/
tags?: { [key: string]: string };
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>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. </p>
*/
export interface Filter {
/**
* <p>The name of the filter. Filter names are case-sensitive. </p>
*/
name?: string;
/**
* <p>The filter values. Filter values are case-sensitive. </p>
*/
values?: string[];
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface GetComponentRequest {
/**
* <p>The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires "/\d+$" suffix.</p>
*/
componentBuildVersionArn: string | undefined;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface GetComponentResponse {
/**
* <p>The component object associated with the specified ARN. </p>
*/
component?: Component;
/**
* <p>The request ID that uniquely identifies this request. </p>
*/
requestId?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface GetComponentPolicyRequest {
/**
* <p>The Amazon Resource Name (ARN) of the component whose policy you want to retrieve. </p>
*/
componentArn: string | undefined;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration |
export interface GetComponentPolicyResponse {
/**
* <p>The component policy. </p>
*/
policy?: string;
/**
* <p>The request ID that uniquely identifies this request. </p>
*/
requestId?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
InterfaceDeclaration | /**
* <p>At least one of the resources referenced by your request does not exist.</p>
*/
export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
name: "ResourceNotFoundException";
$fault: "client";
message?: string;
} | justingrant/aws-sdk-js-v3 | clients/client-imagebuilder/models/models_0.ts | TypeScript |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.