@aws-sdk/client-backup-gateway 3.295.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { BackupGatewayServiceException as __BaseException } from "./BackupGatewayServiceException";
 /**
+ * @public
  * <p>The operation cannot proceed because you have insufficient permissions.</p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -16,6 +17,9 @@ export declare class AccessDeniedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface AssociateGatewayToServerInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation
@@ -27,6 +31,9 @@ export interface AssociateGatewayToServerInput {
      */
     ServerArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface AssociateGatewayToServerOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of a gateway.</p>
@@ -34,6 +41,7 @@ export interface AssociateGatewayToServerOutput {
     GatewayArn?: string;
 }
 /**
+ * @public
  * <p>The operation cannot proceed because it is not supported.</p>
  */
 export declare class ConflictException extends __BaseException {
@@ -50,6 +58,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <p>The operation did not succeed because an internal error occurred. Try again later.</p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -66,6 +75,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p>TPS has been limited to protect against intentional or unintentional
  *     high request volumes.</p>
  */
@@ -84,6 +94,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>The operation did not succeed because a validation error occurred.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -99,6 +110,9 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface GetBandwidthRateLimitScheduleInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway. Use the
@@ -110,6 +124,7 @@ export interface GetBandwidthRateLimitScheduleInput {
     GatewayArn: string | undefined;
 }
 /**
+ * @public
  * <p>Describes a bandwidth rate limit interval for a gateway. A bandwidth
  *       rate limit schedule consists of one or more bandwidth rate limit intervals.
  *       A bandwidth rate limit interval defines a period of time on one or more days
@@ -155,6 +170,9 @@ export interface BandwidthRateLimitInterval {
      */
     DaysOfWeek: number[] | undefined;
 }
+/**
+ * @public
+ */
 export interface GetBandwidthRateLimitScheduleOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway. Use the
@@ -171,6 +189,7 @@ export interface GetBandwidthRateLimitScheduleOutput {
     BandwidthRateLimitIntervals?: BandwidthRateLimitInterval[];
 }
 /**
+ * @public
  * <p>A resource that is required for the action wasn't found.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -186,6 +205,9 @@ export declare class ResourceNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface PutBandwidthRateLimitScheduleInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway. Use the
@@ -201,6 +223,9 @@ export interface PutBandwidthRateLimitScheduleInput {
      */
     BandwidthRateLimitIntervals: BandwidthRateLimitInterval[] | undefined;
 }
+/**
+ * @public
+ */
 export interface PutBandwidthRateLimitScheduleOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway. Use the
@@ -211,10 +236,14 @@ export interface PutBandwidthRateLimitScheduleOutput {
      */
     GatewayArn?: string;
 }
+/**
+ * @public
+ */
 export declare enum GatewayType {
     BACKUP_VM = "BACKUP_VM"
 }
 /**
+ * @public
  * <p>A key-value pair you can use to manage, filter, and search for your resources. Allowed
  *       characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ :
  *       /.</p>
@@ -229,6 +258,9 @@ export interface Tag {
      */
     Value: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateGatewayInput {
     /**
      * <p>The activation key of the created gateway.</p>
@@ -247,36 +279,54 @@ export interface CreateGatewayInput {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface CreateGatewayOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway you create.</p>
      */
     GatewayArn?: string;
 }
+/**
+ * @public
+ */
 export interface DeleteGatewayInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway to delete.</p>
      */
     GatewayArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteGatewayOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway you deleted.</p>
      */
     GatewayArn?: string;
 }
+/**
+ * @public
+ */
 export interface DisassociateGatewayFromServerInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway to disassociate.</p>
      */
     GatewayArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DisassociateGatewayFromServerOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway you disassociated.</p>
      */
     GatewayArn?: string;
 }
+/**
+ * @public
+ */
 export interface GetGatewayInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway.</p>
@@ -284,6 +334,7 @@ export interface GetGatewayInput {
     GatewayArn: string | undefined;
 }
 /**
+ * @public
  * <p>This is your gateway's weekly maintenance start time including the day and time of the week.
  *       Note that values are in terms of the gateway's time zone. Can be weekly or monthly.</p>
  */
@@ -310,6 +361,7 @@ export interface MaintenanceStartTime {
     MinuteOfHour: number | undefined;
 }
 /**
+ * @public
  * <p>The details of gateway.</p>
  */
 export interface GatewayDetails {
@@ -353,6 +405,9 @@ export interface GatewayDetails {
      */
     VpcEndpoint?: string;
 }
+/**
+ * @public
+ */
 export interface GetGatewayOutput {
     /**
      * <p>By providing the ARN (Amazon Resource Name), this
@@ -360,6 +415,9 @@ export interface GetGatewayOutput {
      */
     Gateway?: GatewayDetails;
 }
+/**
+ * @public
+ */
 export interface ListGatewaysInput {
     /**
      * <p>The maximum number of gateways to list.</p>
@@ -374,6 +432,7 @@ export interface ListGatewaysInput {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>A gateway is an Backup Gateway appliance that runs on the customer's network
  *       to provide seamless connectivity to backup storage in the Amazon Web Services Cloud.</p>
  */
@@ -401,6 +460,9 @@ export interface Gateway {
      */
     LastSeenTime?: Date;
 }
+/**
+ * @public
+ */
 export interface ListGatewaysOutput {
     /**
      * <p>A list of your gateways.</p>
@@ -414,6 +476,9 @@ export interface ListGatewaysOutput {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface PutMaintenanceStartTimeInput {
     /**
      * <p>The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start
@@ -438,6 +503,9 @@ export interface PutMaintenanceStartTimeInput {
      */
     DayOfMonth?: number;
 }
+/**
+ * @public
+ */
 export interface PutMaintenanceStartTimeOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start
@@ -445,6 +513,9 @@ export interface PutMaintenanceStartTimeOutput {
      */
     GatewayArn?: string;
 }
+/**
+ * @public
+ */
 export interface TestHypervisorConfigurationInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.</p>
@@ -464,8 +535,14 @@ export interface TestHypervisorConfigurationInput {
      */
     Password?: string;
 }
+/**
+ * @public
+ */
 export interface TestHypervisorConfigurationOutput {
 }
+/**
+ * @public
+ */
 export interface UpdateGatewayInformationInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway to update.</p>
@@ -476,12 +553,18 @@ export interface UpdateGatewayInformationInput {
      */
     GatewayDisplayName?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateGatewayInformationOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway you updated.</p>
      */
     GatewayArn?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateGatewaySoftwareNowInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway
@@ -489,6 +572,9 @@ export interface UpdateGatewaySoftwareNowInput {
      */
     GatewayArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateGatewaySoftwareNowOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the gateway
@@ -496,24 +582,36 @@ export interface UpdateGatewaySoftwareNowOutput {
      */
     GatewayArn?: string;
 }
+/**
+ * @public
+ */
 export interface DeleteHypervisorInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the hypervisor to delete.</p>
      */
     HypervisorArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteHypervisorOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the hypervisor you deleted.</p>
      */
     HypervisorArn?: string;
 }
+/**
+ * @public
+ */
 export interface GetHypervisorInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
      */
     HypervisorArn: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum SyncMetadataStatus {
     CREATED = "CREATED",
     FAILED = "FAILED",
@@ -521,6 +619,9 @@ export declare enum SyncMetadataStatus {
     RUNNING = "RUNNING",
     SUCCEEDED = "SUCCEEDED"
 }
+/**
+ * @public
+ */
 export declare enum HypervisorState {
     ERROR = "ERROR",
     OFFLINE = "OFFLINE",
@@ -528,6 +629,7 @@ export declare enum HypervisorState {
     PENDING = "PENDING"
 }
 /**
+ * @public
  * <p>These are the details of the specified hypervisor. A hypervisor is hardware,
  *       software, or firmware that creates and manages virtual machines, and allocates
  *       resources to them.</p>
@@ -576,12 +678,18 @@ export interface HypervisorDetails {
      */
     LatestMetadataSyncStatus?: SyncMetadataStatus | string;
 }
+/**
+ * @public
+ */
 export interface GetHypervisorOutput {
     /**
      * <p>Details about the requested hypervisor.</p>
      */
     Hypervisor?: HypervisorDetails;
 }
+/**
+ * @public
+ */
 export interface GetHypervisorPropertyMappingsInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
@@ -589,6 +697,7 @@ export interface GetHypervisorPropertyMappingsInput {
     HypervisorArn: string | undefined;
 }
 /**
+ * @public
  * <p>This displays the mapping of on-premises VMware tags to the
  *       corresponding Amazon Web Services tags.</p>
  */
@@ -610,6 +719,9 @@ export interface VmwareToAwsTagMapping {
      */
     AwsTagValue: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetHypervisorPropertyMappingsOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
@@ -625,6 +737,9 @@ export interface GetHypervisorPropertyMappingsOutput {
      */
     IamRoleArn?: string;
 }
+/**
+ * @public
+ */
 export interface PutHypervisorPropertyMappingsInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
@@ -640,12 +755,18 @@ export interface PutHypervisorPropertyMappingsInput {
      */
     IamRoleArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface PutHypervisorPropertyMappingsOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
      */
     HypervisorArn?: string;
 }
+/**
+ * @public
+ */
 export interface ImportHypervisorConfigurationInput {
     /**
      * <p>The name of the hypervisor.</p>
@@ -673,12 +794,18 @@ export interface ImportHypervisorConfigurationInput {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface ImportHypervisorConfigurationOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the hypervisor you disassociated.</p>
      */
     HypervisorArn?: string;
 }
+/**
+ * @public
+ */
 export interface ListHypervisorsInput {
     /**
      * <p>The maximum number of hypervisors to list.</p>
@@ -693,6 +820,7 @@ export interface ListHypervisorsInput {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>Represents the hypervisor's permissions to which the gateway will connect.</p>
  *          <p>A hypervisor is hardware, software, or firmware that creates and manages virtual machines,
  *       and allocates resources to them.</p>
@@ -721,6 +849,9 @@ export interface Hypervisor {
      */
     State?: HypervisorState | string;
 }
+/**
+ * @public
+ */
 export interface ListHypervisorsOutput {
     /**
      * <p>A list of your <code>Hypervisor</code> objects, ordered by their Amazon Resource Names
@@ -735,18 +866,27 @@ export interface ListHypervisorsOutput {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface StartVirtualMachinesMetadataSyncInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
      */
     HypervisorArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StartVirtualMachinesMetadataSyncOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
      */
     HypervisorArn?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateHypervisorInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the hypervisor to update.</p>
@@ -774,18 +914,27 @@ export interface UpdateHypervisorInput {
      */
     LogGroupArn?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateHypervisorOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the hypervisor you updated.</p>
      */
     HypervisorArn?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource's tags to list.</p>
      */
     ResourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource's tags that you listed.</p>
@@ -796,6 +945,9 @@ export interface ListTagsForResourceOutput {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface TagResourceInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
@@ -806,12 +958,18 @@ export interface TagResourceInput {
      */
     Tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource you tagged.</p>
      */
     ResourceARN?: string;
 }
+/**
+ * @public
+ */
 export interface UntagResourceInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource from which to remove tags.</p>
@@ -822,12 +980,18 @@ export interface UntagResourceInput {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource from which you removed tags.</p>
      */
     ResourceARN?: string;
 }
+/**
+ * @public
+ */
 export interface GetVirtualMachineInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the virtual machine.</p>
@@ -835,6 +999,7 @@ export interface GetVirtualMachineInput {
     ResourceArn: string | undefined;
 }
 /**
+ * @public
  * <p>A VMware tag is a tag attached to a specific virtual machine.
  *       A <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_Tag.html">tag</a>
  *       is a key-value pair you can use to manage, filter, and search for your resources.</p>
@@ -855,6 +1020,7 @@ export interface VmwareTag {
     VmwareTagDescription?: string;
 }
 /**
+ * @public
  * <p>Your <code>VirtualMachine</code> objects, ordered by their Amazon Resource Names (ARNs).</p>
  */
 export interface VirtualMachineDetails {
@@ -889,6 +1055,9 @@ export interface VirtualMachineDetails {
      */
     VmwareTags?: VmwareTag[];
 }
+/**
+ * @public
+ */
 export interface GetVirtualMachineOutput {
     /**
      * <p>This object contains the basic attributes of <code>VirtualMachine</code> contained by the output of
@@ -897,6 +1066,9 @@ export interface GetVirtualMachineOutput {
      */
     VirtualMachine?: VirtualMachineDetails;
 }
+/**
+ * @public
+ */
 export interface ListVirtualMachinesInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.</p>
@@ -915,6 +1087,7 @@ export interface ListVirtualMachinesInput {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>A virtual machine that is on a hypervisor.</p>
  */
 export interface VirtualMachine {
@@ -944,6 +1117,9 @@ export interface VirtualMachine {
      */
     LastBackupDate?: Date;
 }
+/**
+ * @public
+ */
 export interface ListVirtualMachinesOutput {
     /**
      * <p>A list of your <code>VirtualMachine</code> objects, ordered by their Amazon Resource Names

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { BackupGatewayClient } from "../BackupGatewayClient";
+/**
+ * @public
+ */
 export interface BackupGatewayPaginationConfiguration extends PaginationConfiguration {
     client: BackupGatewayClient;
 }

package/dist-types/pagination/ListGatewaysPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListGatewaysCommandInput, ListGatewaysCommandOutput } from "../commands/ListGatewaysCommand";
 import { BackupGatewayPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListGateways(config: BackupGatewayPaginationConfiguration, input: ListGatewaysCommandInput, ...additionalArguments: any): Paginator<ListGatewaysCommandOutput>;

package/dist-types/pagination/ListHypervisorsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListHypervisorsCommandInput, ListHypervisorsCommandOutput } from "../commands/ListHypervisorsCommand";
 import { BackupGatewayPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListHypervisors(config: BackupGatewayPaginationConfiguration, input: ListHypervisorsCommandInput, ...additionalArguments: any): Paginator<ListHypervisorsCommandOutput>;

package/dist-types/pagination/ListVirtualMachinesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListVirtualMachinesCommandInput, ListVirtualMachinesCommandOutput } from "../commands/ListVirtualMachinesCommand";
 import { BackupGatewayPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListVirtualMachines(config: BackupGatewayPaginationConfiguration, input: ListVirtualMachinesCommandInput, ...additionalArguments: any): Paginator<ListVirtualMachinesCommandOutput>;