@aws-sdk/client-backup 3.216.0 → 3.222.0

package/dist-types/ts3.4/commands/ListRecoveryPointsByLegalHoldCommand.d.ts

@@ -0,0 +1,41 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+  Handler,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+} from "@aws-sdk/types";
+import {
+  BackupClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../BackupClient";
+import {
+  ListRecoveryPointsByLegalHoldInput,
+  ListRecoveryPointsByLegalHoldOutput,
+} from "../models/models_0";
+export interface ListRecoveryPointsByLegalHoldCommandInput
+  extends ListRecoveryPointsByLegalHoldInput {}
+export interface ListRecoveryPointsByLegalHoldCommandOutput
+  extends ListRecoveryPointsByLegalHoldOutput,
+    __MetadataBearer {}
+export declare class ListRecoveryPointsByLegalHoldCommand extends $Command<
+  ListRecoveryPointsByLegalHoldCommandInput,
+  ListRecoveryPointsByLegalHoldCommandOutput,
+  BackupClientResolvedConfig
+> {
+  readonly input: ListRecoveryPointsByLegalHoldCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: ListRecoveryPointsByLegalHoldCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: BackupClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<
+    ListRecoveryPointsByLegalHoldCommandInput,
+    ListRecoveryPointsByLegalHoldCommandOutput
+  >;
+  private serialize;
+  private deserialize;
+}

package/dist-types/ts3.4/commands/index.d.ts

@@ -1,7 +1,9 @@
+export * from "./CancelLegalHoldCommand";
 export * from "./CreateBackupPlanCommand";
 export * from "./CreateBackupSelectionCommand";
 export * from "./CreateBackupVaultCommand";
 export * from "./CreateFrameworkCommand";
+export * from "./CreateLegalHoldCommand";
 export * from "./CreateReportPlanCommand";
 export * from "./DeleteBackupPlanCommand";
 export * from "./DeleteBackupSelectionCommand";
@@ -24,6 +26,7 @@ export * from "./DescribeReportJobCommand";
 export * from "./DescribeReportPlanCommand";
 export * from "./DescribeRestoreJobCommand";
 export * from "./DisassociateRecoveryPointCommand";
+export * from "./DisassociateRecoveryPointFromParentCommand";
 export * from "./ExportBackupPlanTemplateCommand";
 export * from "./GetBackupPlanCommand";
 export * from "./GetBackupPlanFromJSONCommand";
@@ -31,6 +34,7 @@ export * from "./GetBackupPlanFromTemplateCommand";
 export * from "./GetBackupSelectionCommand";
 export * from "./GetBackupVaultAccessPolicyCommand";
 export * from "./GetBackupVaultNotificationsCommand";
+export * from "./GetLegalHoldCommand";
 export * from "./GetRecoveryPointRestoreMetadataCommand";
 export * from "./GetSupportedResourceTypesCommand";
 export * from "./ListBackupJobsCommand";
@@ -41,8 +45,10 @@ export * from "./ListBackupSelectionsCommand";
 export * from "./ListBackupVaultsCommand";
 export * from "./ListCopyJobsCommand";
 export * from "./ListFrameworksCommand";
+export * from "./ListLegalHoldsCommand";
 export * from "./ListProtectedResourcesCommand";
 export * from "./ListRecoveryPointsByBackupVaultCommand";
+export * from "./ListRecoveryPointsByLegalHoldCommand";
 export * from "./ListRecoveryPointsByResourceCommand";
 export * from "./ListReportJobsCommand";
 export * from "./ListReportPlansCommand";

package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts

@@ -27,7 +27,7 @@ export declare const resolveClientEndpointParameters: <T>(
     defaultSigningName: string;
   };
 export interface EndpointParameters extends __EndpointParameters {
-  Region?: string;
+  Region: string;
   UseDualStack?: boolean;
   UseFIPS?: boolean;
   Endpoint?: string;

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

@@ -30,6 +30,7 @@ export declare enum BackupJobState {
   CREATED = "CREATED",
   EXPIRED = "EXPIRED",
   FAILED = "FAILED",
+  PARTIAL = "PARTIAL",
   PENDING = "PENDING",
   RUNNING = "RUNNING",
 }
@@ -54,6 +55,8 @@ export interface BackupJob {
   BytesTransferred?: number;
   BackupOptions?: Record<string, string>;
   BackupType?: string;
+  ParentJobId?: string;
+  IsParent?: boolean;
 }
 export interface Lifecycle {
   MoveToColdStorageAfterDays?: number;
@@ -180,6 +183,67 @@ export interface CalculatedLifecycle {
   MoveToColdStorageAt?: Date;
   DeleteAt?: Date;
 }
+export interface CancelLegalHoldInput {
+  LegalHoldId: string | undefined;
+  CancelDescription: string | undefined;
+  RetainRecordInDays?: number;
+}
+export interface CancelLegalHoldOutput {}
+export declare class InvalidParameterValueException extends __BaseException {
+  readonly name: "InvalidParameterValueException";
+  readonly $fault: "client";
+  Code?: string;
+  Message?: string;
+  Type?: string;
+  Context?: string;
+  constructor(
+    opts: __ExceptionOptionType<InvalidParameterValueException, __BaseException>
+  );
+}
+export declare class InvalidResourceStateException extends __BaseException {
+  readonly name: "InvalidResourceStateException";
+  readonly $fault: "client";
+  Code?: string;
+  Message?: string;
+  Type?: string;
+  Context?: string;
+  constructor(
+    opts: __ExceptionOptionType<InvalidResourceStateException, __BaseException>
+  );
+}
+export declare class MissingParameterValueException extends __BaseException {
+  readonly name: "MissingParameterValueException";
+  readonly $fault: "client";
+  Code?: string;
+  Message?: string;
+  Type?: string;
+  Context?: string;
+  constructor(
+    opts: __ExceptionOptionType<MissingParameterValueException, __BaseException>
+  );
+}
+export declare class ResourceNotFoundException extends __BaseException {
+  readonly name: "ResourceNotFoundException";
+  readonly $fault: "client";
+  Code?: string;
+  Message?: string;
+  Type?: string;
+  Context?: string;
+  constructor(
+    opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
+  );
+}
+export declare class ServiceUnavailableException extends __BaseException {
+  readonly name: "ServiceUnavailableException";
+  readonly $fault: "server";
+  Code?: string;
+  Message?: string;
+  Type?: string;
+  Context?: string;
+  constructor(
+    opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>
+  );
+}
 export declare class ConflictException extends __BaseException {
   readonly name: "ConflictException";
   readonly $fault: "client";
@@ -202,6 +266,7 @@ export declare enum CopyJobState {
   COMPLETED = "COMPLETED",
   CREATED = "CREATED",
   FAILED = "FAILED",
+  PARTIAL = "PARTIAL",
   RUNNING = "RUNNING",
 }
 export interface CopyJob {
@@ -220,6 +285,11 @@ export interface CopyJob {
   IamRoleArn?: string;
   CreatedBy?: RecoveryPointCreator;
   ResourceType?: string;
+  ParentJobId?: string;
+  IsParent?: boolean;
+  CompositeMemberIdentifier?: string;
+  NumberOfChildJobs?: number;
+  ChildJobsInState?: Record<string, number>;
 }
 export interface CreateBackupPlanInput {
   BackupPlan: BackupPlanInput | undefined;
@@ -233,17 +303,6 @@ export interface CreateBackupPlanOutput {
   VersionId?: string;
   AdvancedBackupSettings?: AdvancedBackupSetting[];
 }
-export declare class InvalidParameterValueException extends __BaseException {
-  readonly name: "InvalidParameterValueException";
-  readonly $fault: "client";
-  Code?: string;
-  Message?: string;
-  Type?: string;
-  Context?: string;
-  constructor(
-    opts: __ExceptionOptionType<InvalidParameterValueException, __BaseException>
-  );
-}
 export declare class LimitExceededException extends __BaseException {
   readonly name: "LimitExceededException";
   readonly $fault: "client";
@@ -255,28 +314,6 @@ export declare class LimitExceededException extends __BaseException {
     opts: __ExceptionOptionType<LimitExceededException, __BaseException>
   );
 }
-export declare class MissingParameterValueException extends __BaseException {
-  readonly name: "MissingParameterValueException";
-  readonly $fault: "client";
-  Code?: string;
-  Message?: string;
-  Type?: string;
-  Context?: string;
-  constructor(
-    opts: __ExceptionOptionType<MissingParameterValueException, __BaseException>
-  );
-}
-export declare class ServiceUnavailableException extends __BaseException {
-  readonly name: "ServiceUnavailableException";
-  readonly $fault: "server";
-  Code?: string;
-  Message?: string;
-  Type?: string;
-  Context?: string;
-  constructor(
-    opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>
-  );
-}
 export interface CreateBackupSelectionInput {
   BackupPlanId: string | undefined;
   BackupSelection: BackupSelection | undefined;
@@ -314,6 +351,37 @@ export interface CreateFrameworkOutput {
   FrameworkName?: string;
   FrameworkArn?: string;
 }
+export interface DateRange {
+  FromDate: Date | undefined;
+  ToDate: Date | undefined;
+}
+export interface RecoveryPointSelection {
+  VaultNames?: string[];
+  ResourceIdentifiers?: string[];
+  DateRange?: DateRange;
+}
+export interface CreateLegalHoldInput {
+  Title: string | undefined;
+  Description: string | undefined;
+  IdempotencyToken?: string;
+  RecoveryPointSelection?: RecoveryPointSelection;
+  Tags?: Record<string, string>;
+}
+export declare enum LegalHoldStatus {
+  ACTIVE = "ACTIVE",
+  CANCELED = "CANCELED",
+  CANCELING = "CANCELING",
+  CREATING = "CREATING",
+}
+export interface CreateLegalHoldOutput {
+  Title?: string;
+  Status?: LegalHoldStatus | string;
+  Description?: string;
+  LegalHoldId?: string;
+  LegalHoldArn?: string;
+  CreationDate?: Date;
+  RecoveryPointSelection?: RecoveryPointSelection;
+}
 export interface ReportDeliveryChannel {
   S3BucketName: string | undefined;
   S3KeyPrefix?: string;
@@ -323,6 +391,9 @@ export interface ReportSetting {
   ReportTemplate: string | undefined;
   FrameworkArns?: string[];
   NumberOfFrameworks?: number;
+  Accounts?: string[];
+  OrganizationUnits?: string[];
+  Regions?: string[];
 }
 export interface CreateReportPlanInput {
   ReportPlanName: string | undefined;
@@ -357,17 +428,6 @@ export declare class InvalidRequestException extends __BaseException {
     opts: __ExceptionOptionType<InvalidRequestException, __BaseException>
   );
 }
-export declare class ResourceNotFoundException extends __BaseException {
-  readonly name: "ResourceNotFoundException";
-  readonly $fault: "client";
-  Code?: string;
-  Message?: string;
-  Type?: string;
-  Context?: string;
-  constructor(
-    opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
-  );
-}
 export interface DeleteBackupSelectionInput {
   BackupPlanId: string | undefined;
   SelectionId: string | undefined;
@@ -391,17 +451,6 @@ export interface DeleteRecoveryPointInput {
   BackupVaultName: string | undefined;
   RecoveryPointArn: string | undefined;
 }
-export declare class InvalidResourceStateException extends __BaseException {
-  readonly name: "InvalidResourceStateException";
-  readonly $fault: "client";
-  Code?: string;
-  Message?: string;
-  Type?: string;
-  Context?: string;
-  constructor(
-    opts: __ExceptionOptionType<InvalidResourceStateException, __BaseException>
-  );
-}
 export interface DeleteReportPlanInput {
   ReportPlanName: string | undefined;
 }
@@ -440,6 +489,10 @@ export interface DescribeBackupJobOutput {
   StartBy?: Date;
   BackupOptions?: Record<string, string>;
   BackupType?: string;
+  ParentJobId?: string;
+  IsParent?: boolean;
+  NumberOfChildJobs?: number;
+  ChildJobsInState?: Record<string, number>;
 }
 export interface DescribeBackupVaultInput {
   BackupVaultName: string | undefined;
@@ -523,6 +576,9 @@ export interface DescribeRecoveryPointOutput {
   IsEncrypted?: boolean;
   StorageClass?: StorageClass | string;
   LastRestoreTime?: Date;
+  ParentRecoveryPointArn?: string;
+  CompositeMemberIdentifier?: string;
+  IsParent?: boolean;
 }
 export interface DescribeRegionSettingsInput {}
 export interface DescribeRegionSettingsOutput {
@@ -595,6 +651,10 @@ export interface DisassociateRecoveryPointInput {
   BackupVaultName: string | undefined;
   RecoveryPointArn: string | undefined;
 }
+export interface DisassociateRecoveryPointFromParentInput {
+  BackupVaultName: string | undefined;
+  RecoveryPointArn: string | undefined;
+}
 export interface ExportBackupPlanTemplateInput {
   BackupPlanId: string | undefined;
 }
@@ -656,6 +716,21 @@ export interface GetBackupVaultNotificationsOutput {
   SNSTopicArn?: string;
   BackupVaultEvents?: (BackupVaultEvent | string)[];
 }
+export interface GetLegalHoldInput {
+  LegalHoldId: string | undefined;
+}
+export interface GetLegalHoldOutput {
+  Title?: string;
+  Status?: LegalHoldStatus | string;
+  Description?: string;
+  CancelDescription?: string;
+  LegalHoldId?: string;
+  LegalHoldArn?: string;
+  CreationDate?: Date;
+  CancellationDate?: Date;
+  RetainRecordUntil?: Date;
+  RecoveryPointSelection?: RecoveryPointSelection;
+}
 export interface GetRecoveryPointRestoreMetadataInput {
   BackupVaultName: string | undefined;
   RecoveryPointArn: string | undefined;
@@ -680,6 +755,7 @@ export interface ListBackupJobsInput {
   ByAccountId?: string;
   ByCompleteAfter?: Date;
   ByCompleteBefore?: Date;
+  ByParentJobId?: string;
 }
 export interface ListBackupJobsOutput {
   BackupJobs?: BackupJob[];
@@ -740,6 +816,7 @@ export interface ListCopyJobsInput {
   ByAccountId?: string;
   ByCompleteBefore?: Date;
   ByCompleteAfter?: Date;
+  ByParentJobId?: string;
 }
 export interface ListCopyJobsOutput {
   CopyJobs?: CopyJob[];
@@ -761,6 +838,23 @@ export interface ListFrameworksOutput {
   Frameworks?: Framework[];
   NextToken?: string;
 }
+export interface ListLegalHoldsInput {
+  NextToken?: string;
+  MaxResults?: number;
+}
+export interface LegalHold {
+  Title?: string;
+  Status?: LegalHoldStatus | string;
+  Description?: string;
+  LegalHoldId?: string;
+  LegalHoldArn?: string;
+  CreationDate?: Date;
+  CancellationDate?: Date;
+}
+export interface ListLegalHoldsOutput {
+  NextToken?: string;
+  LegalHolds?: LegalHold[];
+}
 export interface ListProtectedResourcesInput {
   NextToken?: string;
   MaxResults?: number;
@@ -783,6 +877,7 @@ export interface ListRecoveryPointsByBackupVaultInput {
   ByBackupPlanId?: string;
   ByCreatedBefore?: Date;
   ByCreatedAfter?: Date;
+  ByParentRecoveryPointArn?: string;
 }
 export interface RecoveryPointByBackupVault {
   RecoveryPointArn?: string;
@@ -803,11 +898,26 @@ export interface RecoveryPointByBackupVault {
   EncryptionKeyArn?: string;
   IsEncrypted?: boolean;
   LastRestoreTime?: Date;
+  ParentRecoveryPointArn?: string;
+  CompositeMemberIdentifier?: string;
+  IsParent?: boolean;
 }
 export interface ListRecoveryPointsByBackupVaultOutput {
   NextToken?: string;
   RecoveryPoints?: RecoveryPointByBackupVault[];
 }
+export interface ListRecoveryPointsByLegalHoldInput {
+  LegalHoldId: string | undefined;
+  NextToken?: string;
+  MaxResults?: number;
+}
+export interface RecoveryPointMember {
+  RecoveryPointArn?: string;
+}
+export interface ListRecoveryPointsByLegalHoldOutput {
+  RecoveryPoints?: RecoveryPointMember[];
+  NextToken?: string;
+}
 export interface ListRecoveryPointsByResourceInput {
   ResourceArn: string | undefined;
   NextToken?: string;
@@ -821,6 +931,8 @@ export interface RecoveryPointByResource {
   EncryptionKeyArn?: string;
   BackupSizeBytes?: number;
   BackupVaultName?: string;
+  IsParent?: boolean;
+  ParentRecoveryPointArn?: string;
 }
 export interface ListRecoveryPointsByResourceOutput {
   NextToken?: string;
@@ -914,6 +1026,7 @@ export interface StartBackupJobOutput {
   BackupJobId?: string;
   RecoveryPointArn?: string;
   CreationDate?: Date;
+  IsParent?: boolean;
 }
 export interface StartCopyJobInput {
   RecoveryPointArn: string | undefined;
@@ -926,6 +1039,7 @@ export interface StartCopyJobInput {
 export interface StartCopyJobOutput {
   CopyJobId?: string;
   CreationDate?: Date;
+  IsParent?: boolean;
 }
 export interface StartReportJobInput {
   ReportPlanName: string | undefined;
@@ -1047,6 +1161,12 @@ export declare const BackupVaultListMemberFilterSensitiveLog: (
 export declare const CalculatedLifecycleFilterSensitiveLog: (
   obj: CalculatedLifecycle
 ) => any;
+export declare const CancelLegalHoldInputFilterSensitiveLog: (
+  obj: CancelLegalHoldInput
+) => any;
+export declare const CancelLegalHoldOutputFilterSensitiveLog: (
+  obj: CancelLegalHoldOutput
+) => any;
 export declare const ControlInputParameterFilterSensitiveLog: (
   obj: ControlInputParameter
 ) => any;
@@ -1079,6 +1199,16 @@ export declare const CreateFrameworkInputFilterSensitiveLog: (
 export declare const CreateFrameworkOutputFilterSensitiveLog: (
   obj: CreateFrameworkOutput
 ) => any;
+export declare const DateRangeFilterSensitiveLog: (obj: DateRange) => any;
+export declare const RecoveryPointSelectionFilterSensitiveLog: (
+  obj: RecoveryPointSelection
+) => any;
+export declare const CreateLegalHoldInputFilterSensitiveLog: (
+  obj: CreateLegalHoldInput
+) => any;
+export declare const CreateLegalHoldOutputFilterSensitiveLog: (
+  obj: CreateLegalHoldOutput
+) => any;
 export declare const ReportDeliveryChannelFilterSensitiveLog: (
   obj: ReportDeliveryChannel
 ) => any;
@@ -1195,6 +1325,9 @@ export declare const DescribeRestoreJobOutputFilterSensitiveLog: (
 export declare const DisassociateRecoveryPointInputFilterSensitiveLog: (
   obj: DisassociateRecoveryPointInput
 ) => any;
+export declare const DisassociateRecoveryPointFromParentInputFilterSensitiveLog: (
+  obj: DisassociateRecoveryPointFromParentInput
+) => any;
 export declare const ExportBackupPlanTemplateInputFilterSensitiveLog: (
   obj: ExportBackupPlanTemplateInput
 ) => any;
@@ -1237,6 +1370,12 @@ export declare const GetBackupVaultNotificationsInputFilterSensitiveLog: (
 export declare const GetBackupVaultNotificationsOutputFilterSensitiveLog: (
   obj: GetBackupVaultNotificationsOutput
 ) => any;
+export declare const GetLegalHoldInputFilterSensitiveLog: (
+  obj: GetLegalHoldInput
+) => any;
+export declare const GetLegalHoldOutputFilterSensitiveLog: (
+  obj: GetLegalHoldOutput
+) => any;
 export declare const GetRecoveryPointRestoreMetadataInputFilterSensitiveLog: (
   obj: GetRecoveryPointRestoreMetadataInput
 ) => any;
@@ -1295,6 +1434,13 @@ export declare const FrameworkFilterSensitiveLog: (obj: Framework) => any;
 export declare const ListFrameworksOutputFilterSensitiveLog: (
   obj: ListFrameworksOutput
 ) => any;
+export declare const ListLegalHoldsInputFilterSensitiveLog: (
+  obj: ListLegalHoldsInput
+) => any;
+export declare const LegalHoldFilterSensitiveLog: (obj: LegalHold) => any;
+export declare const ListLegalHoldsOutputFilterSensitiveLog: (
+  obj: ListLegalHoldsOutput
+) => any;
 export declare const ListProtectedResourcesInputFilterSensitiveLog: (
   obj: ListProtectedResourcesInput
 ) => any;
@@ -1313,6 +1459,15 @@ export declare const RecoveryPointByBackupVaultFilterSensitiveLog: (
 export declare const ListRecoveryPointsByBackupVaultOutputFilterSensitiveLog: (
   obj: ListRecoveryPointsByBackupVaultOutput
 ) => any;
+export declare const ListRecoveryPointsByLegalHoldInputFilterSensitiveLog: (
+  obj: ListRecoveryPointsByLegalHoldInput
+) => any;
+export declare const RecoveryPointMemberFilterSensitiveLog: (
+  obj: RecoveryPointMember
+) => any;
+export declare const ListRecoveryPointsByLegalHoldOutputFilterSensitiveLog: (
+  obj: ListRecoveryPointsByLegalHoldOutput
+) => any;
 export declare const ListRecoveryPointsByResourceInputFilterSensitiveLog: (
   obj: ListRecoveryPointsByResourceInput
 ) => any;

package/dist-types/ts3.4/pagination/ListLegalHoldsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@aws-sdk/types";
+import {
+  ListLegalHoldsCommandInput,
+  ListLegalHoldsCommandOutput,
+} from "../commands/ListLegalHoldsCommand";
+import { BackupPaginationConfiguration } from "./Interfaces";
+export declare function paginateListLegalHolds(
+  config: BackupPaginationConfiguration,
+  input: ListLegalHoldsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListLegalHoldsCommandOutput>;

package/dist-types/ts3.4/pagination/ListRecoveryPointsByLegalHoldPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@aws-sdk/types";
+import {
+  ListRecoveryPointsByLegalHoldCommandInput,
+  ListRecoveryPointsByLegalHoldCommandOutput,
+} from "../commands/ListRecoveryPointsByLegalHoldCommand";
+import { BackupPaginationConfiguration } from "./Interfaces";
+export declare function paginateListRecoveryPointsByLegalHold(
+  config: BackupPaginationConfiguration,
+  input: ListRecoveryPointsByLegalHoldCommandInput,
+  ...additionalArguments: any
+): Paginator<ListRecoveryPointsByLegalHoldCommandOutput>;

package/dist-types/ts3.4/pagination/index.d.ts

@@ -7,8 +7,10 @@ export * from "./ListBackupSelectionsPaginator";
 export * from "./ListBackupVaultsPaginator";
 export * from "./ListCopyJobsPaginator";
 export * from "./ListFrameworksPaginator";
+export * from "./ListLegalHoldsPaginator";
 export * from "./ListProtectedResourcesPaginator";
 export * from "./ListRecoveryPointsByBackupVaultPaginator";
+export * from "./ListRecoveryPointsByLegalHoldPaginator";
 export * from "./ListRecoveryPointsByResourcePaginator";
 export * from "./ListReportJobsPaginator";
 export * from "./ListReportPlansPaginator";